blob: 92efb53b30a208b6fa50b6b4ac098ea74eecedba (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.apex.service.parameters.eventprotocol;
import org.onap.policy.common.parameters.GroupValidationResult;
import org.onap.policy.common.parameters.ParameterGroup;
import org.onap.policy.common.parameters.ParameterRuntimeException;
import org.onap.policy.common.parameters.ValidationStatus;
/**
* A default event protocol parameter class that may be specialized by event protocol plugins that require plugin
* specific parameters.
*
* <p>The following parameters are defined:
* <ol>
* <li>label: The label of the event protocol technology.
* <li>eventProducerPluginClass: The name of the plugin class that will be used by Apex to produce and emit output
* events for this carrier technology
* </ol>
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
public abstract class EventProtocolParameters implements ParameterGroup {
// The event protocol label
private String label = null;
// Event protocol converter plugin class for this event protocol
private String eventProtocolPluginClass;
/**
* Constructor to create an event protocol parameters instance with the name of a sub class of this class and
* register the instance with the parameter service.
*/
public EventProtocolParameters() {
super();
}
/**
* Gets the label of the event protocol.
*
* @return the label of the event protocol
*/
public String getLabel() {
return label;
}
/**
* Sets the label of the event protocol.
*
* @param label the label of the event protocol
*/
public void setLabel(final String label) {
this.label = label.replaceAll("\\s+", "");
}
/**
* Gets the event event protocol plugin class.
*
* @return the event event protocol plugin class
*/
public String getEventProtocolPluginClass() {
return eventProtocolPluginClass;
}
/**
* Sets the event event protocol plugin class.
*
* @param eventProtocolPluginClass the event event protocol plugin class
*/
public void setEventProtocolPluginClass(final String eventProtocolPluginClass) {
this.eventProtocolPluginClass = eventProtocolPluginClass.replaceAll("\\s+", "");
}
/*
* (non-Javadoc)
*
* @see org.onap.policy.apex.model.basicmodel.service.AbstractParameters#toString()
*/
@Override
public String toString() {
return "CarrierTechnologyParameters [label=" + label + ", EventProtocolPluginClass=" + eventProtocolPluginClass
+ "]";
}
/*
* (non-Javadoc)
*
* @see org.onap.policy.apex.service.parameters.ApexParameterValidator#validate()
*/
@Override
public GroupValidationResult validate() {
final GroupValidationResult result = new GroupValidationResult(this);
if (label == null || label.length() == 0) {
result.setResult("label", ValidationStatus.INVALID, "event protocol label not specified or is blank");
}
if (eventProtocolPluginClass == null || eventProtocolPluginClass.length() == 0) {
result.setResult("eventProtocolPluginClass", ValidationStatus.INVALID,
"event protocol eventProtocolPluginClass not specified or is blank");
}
return result;
}
@Override
public String getName() {
return this.getLabel();
}
@Override
public void setName(final String name) {
throw new ParameterRuntimeException("the name/label of this event protocol is always \"" + getLabel() + "\"");
}
}
|
