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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
|
/*-
* ============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.eventhandler;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import org.onap.policy.apex.service.parameters.ApexParameterConstants;
import org.onap.policy.apex.service.parameters.carriertechnology.CarrierTechnologyParameters;
import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolParameters;
import org.onap.policy.common.parameters.GroupValidationResult;
import org.onap.policy.common.parameters.ParameterGroup;
import org.onap.policy.common.parameters.ValidationStatus;
/**
* The parameters for a single event producer, event consumer or synchronous event handler.
*
* <p>
* Event producers, consumers, and synchronous event handlers all use a carrier technology and an event protocol so the
* actual parameters for each one are the same. Therefore, we use the same class for the parameters of each one.
*
* <p>
* The following parameters are defined:
* <ol>
* <li>carrierTechnologyParameters: The carrier technology is the type of messaging infrastructure used to carry events.
* Examples are File, Kafka or REST.
* <li>eventProtocolParameters: The format that the events are in when being carried. Examples are JSON, XML, or Java
* Beans. carrier technology
* <li>synchronousMode: true if the event handler is working in synchronous mode, defaults to false
* <li>synchronousPeer: the peer event handler (consumer for producer or producer for consumer) of this event handler in
* synchronous mode
* <li>synchronousTimeout: the amount of time to wait for the reply to synchronous events before they are timed out
* <li>requestorMode: true if the event handler is working in requestor mode, defaults to false
* <li>requestorPeer: the peer event handler (consumer for producer or producer for consumer) of this event handler in
* requestor mode
* <li>requestorTimeout: the amount of time to wait for the reply to synchronous events before they are timed out
* <li>eventNameFilter: a regular expression to apply to events on this event handler. If specified, events not matching
* the given regular expression are ignored. If it is null, all events are handledDefaults to null.
* </ol>
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
public class EventHandlerParameters implements ParameterGroup {
private String name = null;
private CarrierTechnologyParameters carrierTechnologyParameters = null;
private EventProtocolParameters eventProtocolParameters = null;
private boolean synchronousMode = false;
private String synchronousPeer = null;
private long synchronousTimeout = 0;
private boolean requestorMode = false;
private String requestorPeer = null;
private long requestorTimeout = 0;
private String eventName = null;
private String eventNameFilter = null;
/**
* Constructor to create an event handler parameters instance.
*/
public EventHandlerParameters() {
super();
// Set the name for the parameters
this.name = ApexParameterConstants.EVENT_HANDLER_GROUP_NAME;
}
/**
* Gets the name of the event handler.
*
* @return the event handler name
*/
public String getName() {
return name;
}
/**
* Sets the name of the event handler.
*
* @param name the event handler name
*/
public void setName(final String name) {
this.name = name;
}
/**
* Checks if the name of the event handler is set.
*
* @return true if the name is set
*/
public boolean checkSetName() {
return !(name == null || name.trim().length() == 0);
}
/**
* Gets the carrier technology parameters of the event handler.
*
* @return the carrierTechnologyParameters of the event handler
*/
public CarrierTechnologyParameters getCarrierTechnologyParameters() {
return carrierTechnologyParameters;
}
/**
* Sets the carrier technology parameters of the event handler.
*
* @param carrierTechnologyParameters the carrierTechnologyParameters to set
*/
public void setCarrierTechnologyParameters(final CarrierTechnologyParameters carrierTechnologyParameters) {
this.carrierTechnologyParameters = carrierTechnologyParameters;
}
/**
* Gets the event protocol parameters of the event handler.
*
* @return the eventProtocolParameters
*/
public EventProtocolParameters getEventProtocolParameters() {
return eventProtocolParameters;
}
/**
* Sets the event protocol parameters.
*
* @param eventProtocolParameters the eventProtocolParameters to set
*/
public void setEventProtocolParameters(final EventProtocolParameters eventProtocolParameters) {
this.eventProtocolParameters = eventProtocolParameters;
}
/**
* Checks if the event handler is in the given peered mode.
*
* @param peeredMode the peer mode
* @return true, if the event handler is in the peered mode
*/
public boolean isPeeredMode(final EventHandlerPeeredMode peeredMode) {
switch (peeredMode) {
case SYNCHRONOUS:
return synchronousMode;
case REQUESTOR:
return requestorMode;
default:
return false;
}
}
/**
* Sets a peered mode as true or false on the event handler.
*
* @param peeredMode the peered mode to set
* @param peeredModeValue the value to set the peered mode to
*/
public void setPeeredMode(final EventHandlerPeeredMode peeredMode, final boolean peeredModeValue) {
switch (peeredMode) {
case SYNCHRONOUS:
synchronousMode = peeredModeValue;
return;
case REQUESTOR:
requestorMode = peeredModeValue;
return;
default:
return;
}
}
/**
* Gets the peer for the event handler in this peered mode.
*
* @param peeredMode the peered mode to get the peer for
* @return the peer
*/
public String getPeer(final EventHandlerPeeredMode peeredMode) {
switch (peeredMode) {
case SYNCHRONOUS:
return synchronousPeer;
case REQUESTOR:
return requestorPeer;
default:
return null;
}
}
/**
* Sets the peer for the event handler in this peered mode.
*
* @param peeredMode the peered mode to set the peer for
* @param peer the peer
*/
public void setPeer(final EventHandlerPeeredMode peeredMode, final String peer) {
switch (peeredMode) {
case SYNCHRONOUS:
synchronousPeer = peer;
return;
case REQUESTOR:
requestorPeer = peer;
return;
default:
return;
}
}
/**
* Get the timeout value for the event handler in peered mode.
*
* @param peeredMode the peered mode to get the timeout for
* @return the timeout value
*/
public long getPeerTimeout(final EventHandlerPeeredMode peeredMode) {
switch (peeredMode) {
case SYNCHRONOUS:
return synchronousTimeout;
case REQUESTOR:
return requestorTimeout;
default:
return -1;
}
}
/**
* Set the timeout value for the event handler in peered mode.
*
* @param peeredMode the peered mode to set the timeout for
* @param timeout the timeout value
*/
public void setPeerTimeout(final EventHandlerPeeredMode peeredMode, final long timeout) {
switch (peeredMode) {
case SYNCHRONOUS:
synchronousTimeout = timeout;
return;
case REQUESTOR:
requestorTimeout = timeout;
return;
default:
return;
}
}
/**
* Check if an event name is being used.
*
* @return true if an event name is being used
*/
public boolean isSetEventName() {
return eventName != null;
}
/**
* Gets the event name for this event handler.
*
* @return the event name
*/
public String getEventName() {
return eventName;
}
/**
* Sets the event name for this event handler.
*
* @param eventName the event name
*/
public void setEventName(final String eventName) {
this.eventName = eventName;
}
/**
* Check if event name filtering is being used.
*
* @return true if event name filtering is being used
*/
public boolean isSetEventNameFilter() {
return eventNameFilter != null;
}
/**
* Gets the event name filter for this event handler.
*
* @return the event name filter
*/
public String getEventNameFilter() {
return eventNameFilter;
}
/**
* Sets the event name filter for this event handler.
*
* @param eventNameFilter the event name filter
*/
public void setEventNameFilter(final String eventNameFilter) {
this.eventNameFilter = eventNameFilter;
}
/*
* (non-Javadoc)
*
* @see org.onap.policy.apex.service.parameters.ApexParameterValidator#validate()
*/
@Override
public GroupValidationResult validate() {
final GroupValidationResult result = new GroupValidationResult(this);
if (eventProtocolParameters == null) {
result.setResult("eventProtocolParameters", ValidationStatus.INVALID,
"event handler eventProtocolParameters not specified or blank");
} else {
result.setResult("eventProtocolParameters", eventProtocolParameters.validate());
}
if (carrierTechnologyParameters == null) {
result.setResult("carrierTechnologyParameters", ValidationStatus.INVALID,
"event handler carrierTechnologyParameters not specified or blank");
} else {
result.setResult("carrierTechnologyParameters", carrierTechnologyParameters.validate());
}
if (eventNameFilter != null) {
try {
Pattern.compile(eventNameFilter);
} catch (final PatternSyntaxException pse) {
result.setResult("eventNameFilter", ValidationStatus.INVALID,
"event handler eventNameFilter is not a valid regular expression: " + pse.getMessage());
}
}
return result;
}
/*
* (non-Javadoc)
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return "EventHandlerParameters [name=" + name + ", carrierTechnologyParameters=" + carrierTechnologyParameters
+ ", eventProtocolParameters=" + eventProtocolParameters + ", synchronousMode="
+ synchronousMode + ", synchronousPeer=" + synchronousPeer + ", synchronousTimeout="
+ synchronousTimeout + ", requestorMode=" + requestorMode + ", requestorPeer=" + requestorPeer
+ ", requestorTimeout=" + requestorTimeout + ", eventName=" + eventName + ", eventNameFilter="
+ eventNameFilter + "]";
}
}
|