blob: 8e44ec59bfa5605ab8031190700f5ba3ddc154e6 (
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/*-
* ============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.engine.event.impl.jsonprotocolplugin;
import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolTextCharDelimitedParameters;
/**
* Event protocol parameters for JSON as an event protocol.
*
* <p>The parameters for this plugin are:
* <ol>
* <li>nameAlias: The field in a JSON event to use as an alias for the event name. This parameter is
* optional.
* <li>versionAlias: The field in a JSON event to use as an alias for the event version. This
* parameter is optional.
* <li>nameSpaceAlias: The field in a JSON event to use as an alias for the event name space. This
* parameter is optional.
* <li>sourceAlias: The field in a JSON event to use as an alias for the event source. This
* parameter is optional.
* <li>targetAlias: The field in a JSON event to use as an alias for the event target. This
* parameter is optional.
* </ol>
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
public class JsonEventProtocolParameters extends EventProtocolTextCharDelimitedParameters {
/** The label of this event protocol. */
public static final String JSON_EVENT_PROTOCOL_LABEL = "JSON";
// Constants for text block delimiters
private static final char JSON_TEXT_BLOCK_START_DELIMITER = '{';
private static final char JSON_TEXT_BLOCK_END_DELIMITER = '}';
// Aliases for Apex event header fields
// @formatter:off
private String nameAlias = null;
private String versionAlias = null;
private String nameSpaceAlias = null;
private String sourceAlias = null;
private String targetAlias = null;
// @formatter:on
/**
* Constructor to create a JSON event protocol parameter instance and register the instance with
* the parameter service.
*/
public JsonEventProtocolParameters() {
this(JsonEventProtocolParameters.class.getCanonicalName(), JSON_EVENT_PROTOCOL_LABEL);
}
/**
* Constructor to create an event protocol parameters instance with the name of a sub class of
* this class.
*
* @param parameterClassName the class name of a sub class of this class
* @param eventProtocolLabel the name of the event protocol for this plugin
*/
public JsonEventProtocolParameters(final String parameterClassName, final String eventProtocolLabel) {
super(parameterClassName);
// Set the event protocol properties for the JSON event protocol
this.setLabel(eventProtocolLabel);
// Set the starting and ending delimiters for text blocks of JSON events
this.setStartChar(JSON_TEXT_BLOCK_START_DELIMITER);
this.setEndChar(JSON_TEXT_BLOCK_END_DELIMITER);
// Set the event protocol plugin class
this.setEventProtocolPluginClass(Apex2JsonEventConverter.class.getCanonicalName());
}
/* (non-Javadoc)
* @see org.onap.policy.common.parameters.ParameterGroup#getName()
*/
@Override
public String getName() {
return this.getLabel();
}
/**
* Gets the name alias.
*
* @return the name alias
*/
public String getNameAlias() {
return nameAlias;
}
/**
* Gets the version alias.
*
* @return the version alias
*/
public String getVersionAlias() {
return versionAlias;
}
/**
* Gets the name space alias.
*
* @return the name space alias
*/
public String getNameSpaceAlias() {
return nameSpaceAlias;
}
/**
* Gets the source alias.
*
* @return the source alias
*/
public String getSourceAlias() {
return sourceAlias;
}
/**
* Gets the target alias.
*
* @return the target alias
*/
public String getTargetAlias() {
return targetAlias;
}
/**
* Sets the name alias.
*
* @param nameAlias the new name alias
*/
public void setNameAlias(String nameAlias) {
this.nameAlias = nameAlias;
}
/**
* Sets the version alias.
*
* @param versionAlias the new version alias
*/
public void setVersionAlias(String versionAlias) {
this.versionAlias = versionAlias;
}
/**
* Sets the name space alias.
*
* @param nameSpaceAlias the new name space alias
*/
public void setNameSpaceAlias(String nameSpaceAlias) {
this.nameSpaceAlias = nameSpaceAlias;
}
/**
* Sets the source alias.
*
* @param sourceAlias the new source alias
*/
public void setSourceAlias(String sourceAlias) {
this.sourceAlias = sourceAlias;
}
/**
* Sets the target alias.
*
* @param targetAlias the new target alias
*/
public void setTargetAlias(String targetAlias) {
this.targetAlias = targetAlias;
}
}
|
