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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
|
/*
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
* Modifications Copyright (C) 2018 Samsung Electronics Co., Ltd.
* ================================================================================
* 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.
* ============LICENSE_END=========================================================
*/
package org.onap.policy.drools.protocol.coders;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonDeserializationContext;
import com.google.gson.JsonDeserializer;
import com.google.gson.JsonElement;
import com.google.gson.JsonParser;
import com.google.gson.JsonPrimitive;
import com.google.gson.JsonSerializationContext;
import com.google.gson.JsonSerializer;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.Type;
import java.time.Instant;
import java.time.ZonedDateTime;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;
import org.onap.policy.common.gson.annotation.GsonJsonIgnore;
import org.onap.policy.drools.controller.DroolsController;
import org.onap.policy.drools.protocol.coders.EventProtocolCoder.CoderFilters;
import org.onap.policy.drools.protocol.coders.TopicCoderFilterConfiguration.CustomCoder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Protocol Coding/Decoding Toolset.
*/
public abstract class ProtocolCoderToolset {
/**
* Logger.
*/
private static Logger logger = LoggerFactory.getLogger(ProtocolCoderToolset.class);
/**
* topic.
*/
protected final String topic;
/**
* controller id.
*/
protected final String controllerId;
/**
* group id.
*/
protected final String groupId;
/**
* artifact id.
*/
protected final String artifactId;
/**
* Protocols and associated Filters.
*/
protected final List<CoderFilters> coders = new CopyOnWriteArrayList<>();
/**
* Tree model (instead of class model) generic parsing to be able to inspect elements.
*/
protected JsonParser filteringParser = new JsonParser();
/**
* custom coder.
*/
protected CustomCoder customCoder;
/**
* Constructor.
*
* @param eventProtocolParams parameter object for event encoder
* @param controllerId the controller id
* @throws IllegalArgumentException if invalid data has been passed in
*/
public ProtocolCoderToolset(EventProtocolParams eventProtocolParams, String controllerId) {
if (eventProtocolParams == null || controllerId == null) {
throw new IllegalArgumentException("Invalid input");
}
this.topic = eventProtocolParams.getTopic();
this.controllerId = controllerId;
this.groupId = eventProtocolParams.getGroupId();
this.artifactId = eventProtocolParams.getArtifactId();
this.coders.add(new CoderFilters(
eventProtocolParams.getEventClass(),
eventProtocolParams.getProtocolFilter(),
eventProtocolParams.getModelClassLoaderHash()));
this.customCoder = eventProtocolParams.getCustomCoder();
}
/**
* gets the coder + filters associated with this class name.
*
* @param classname class name
* @return the decoder filters or null if not found
*/
public CoderFilters getCoder(String classname) {
if (classname == null || classname.isEmpty()) {
throw new IllegalArgumentException("no classname provided");
}
for (final CoderFilters decoder : this.coders) {
if (decoder.factClass.equals(classname)) {
return decoder;
}
}
return null;
}
/**
* get a copy of the coder filters in use.
*
* @return coder filters
*/
public List<CoderFilters> getCoders() {
return new ArrayList<>(this.coders);
}
/**
* add coder or replace it exists.
*
* @param eventClass decoder
* @param filter filter
*/
public void addCoder(String eventClass, JsonProtocolFilter filter, int modelClassLoaderHash) {
if (eventClass == null || eventClass.isEmpty()) {
throw new IllegalArgumentException("no event class provided");
}
for (final CoderFilters coder : this.coders) {
if (coder.getCodedClass().equals(eventClass)) {
coder.setFilter(filter);
coder.setFromClassLoaderHash(modelClassLoaderHash);
return;
}
}
this.coders.add(new CoderFilters(eventClass, filter, modelClassLoaderHash));
}
/**
* remove coder.
*
* @param eventClass event class
*/
public void removeCoders(String eventClass) {
if (eventClass == null || eventClass.isEmpty()) {
throw new IllegalArgumentException("no event class provided");
}
List<CoderFilters> temp = new ArrayList<>();
for (final CoderFilters coder : this.coders) {
if (coder.factClass.equals(eventClass)) {
temp.add(coder);
}
}
this.coders.removeAll(temp);
}
/**
* gets the topic.
*
* @return the topic
*/
public String getTopic() {
return this.topic;
}
/**
* gets the controller id.
*
* @return the controller id
*/
public String getControllerId() {
return this.controllerId;
}
/**
* Get group id.
*
* @return the groupId
*/
public String getGroupId() {
return this.groupId;
}
/**
* Get artifact id.
*
* @return the artifactId
*/
public String getArtifactId() {
return this.artifactId;
}
/**
* Get custom coder.
*
* @return the customCoder
*/
public CustomCoder getCustomCoder() {
return this.customCoder;
}
/**
* Set custom coder.
*
* @param customCoder the customCoder to set.
*/
public void setCustomCoder(CustomCoder customCoder) {
this.customCoder = customCoder;
}
/**
* performs filtering on a json string.
*
* @param json json string
* @return the decoder that passes the filter, otherwise null
* @throws UnsupportedOperationException can't filter
* @throws IllegalArgumentException invalid input
*/
protected CoderFilters filter(String json) {
// 1. Get list of decoding classes for this controller Id and topic
// 2. If there are no classes, return error
// 3. Otherwise, from the available classes for decoding, pick the first one that
// passes the filters
// Don't parse if it is not necessary
if (this.coders.isEmpty()) {
throw new IllegalStateException("No coders available");
}
if (this.coders.size() == 1) {
final JsonProtocolFilter filter = this.coders.get(0).getFilter();
if (!filter.isRules()) {
return this.coders.get(0);
}
}
JsonElement event;
try {
event = this.filteringParser.parse(json);
} catch (final Exception e) {
throw new UnsupportedOperationException(e);
}
for (final CoderFilters decoder : this.coders) {
try {
final boolean accepted = decoder.getFilter().accept(event);
if (accepted) {
return decoder;
}
} catch (final Exception e) {
logger.info("{}: unexpected failure accepting {} because of {}", this, event,
e.getMessage(), e);
// continue
}
}
return null;
}
/**
* Decode json into a POJO object.
*
* @param json json string
*
* @return a POJO object for the json string
* @throws IllegalArgumentException if an invalid parameter has been received
* @throws UnsupportedOperationException if parsing into POJO is not possible
*/
public abstract Object decode(String json);
/**
* Encodes a POJO object into a JSON String.
*
* @param event JSON POJO event to be converted to String
* @return JSON string version of POJO object
* @throws IllegalArgumentException if an invalid parameter has been received
* @throws UnsupportedOperationException if parsing into POJO is not possible
*/
public abstract String encode(Object event);
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
builder.append("ProtocolCoderToolset [topic=").append(this.topic).append(", controllerId=")
.append(this.controllerId).append(", groupId=").append(this.groupId).append(", artifactId=")
.append(this.artifactId).append(", coders=").append(this.coders)
.append(", filteringParser=").append(this.filteringParser).append(", customCoder=")
.append(this.customCoder).append("]");
return builder.toString();
}
}
/**
* Tools used for encoding/decoding using GSON.
*/
class GsonProtocolCoderToolset extends ProtocolCoderToolset {
/**
* Logger.
*/
private static final Logger logger = LoggerFactory.getLogger(GsonProtocolCoderToolset.class);
/**
* Formatter for JSON encoding/decoding.
*/
@JsonIgnore
@GsonJsonIgnore
public static final DateTimeFormatter format = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss.SSSSSSxxx");
@JsonIgnore
@GsonJsonIgnore
public static final DateTimeFormatter zuluFormat = DateTimeFormatter.ISO_INSTANT;
/**
* Adapter for ZonedDateTime.
*/
public static class GsonUTCAdapter implements JsonSerializer<ZonedDateTime>, JsonDeserializer<ZonedDateTime> {
@Override
public ZonedDateTime deserialize(JsonElement element, Type type,
JsonDeserializationContext context) {
try {
return ZonedDateTime.parse(element.getAsString(), format);
} catch (final Exception e) {
logger.info("GsonUTCAdapter: cannot parse {} because of {}", element, e.getMessage(), e);
}
return null;
}
@Override
public JsonElement serialize(ZonedDateTime datetime, Type type,
JsonSerializationContext context) {
return new JsonPrimitive(datetime.format(format));
}
}
public static class GsonInstantAdapter implements JsonSerializer<Instant>, JsonDeserializer<Instant> {
@Override
public Instant deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) {
return Instant.ofEpochMilli(json.getAsLong());
}
@Override
public JsonElement serialize(Instant src, Type typeOfSrc, JsonSerializationContext context) {
return new JsonPrimitive(src.toEpochMilli());
}
}
/**
* decoder.
*/
@JsonIgnore
@GsonJsonIgnore
protected final Gson decoder = new GsonBuilder().disableHtmlEscaping()
.registerTypeAdapter(ZonedDateTime.class, new GsonUTCAdapter())
.registerTypeAdapter(Instant.class, new GsonInstantAdapter()).create();
/**
* encoder.
*/
@JsonIgnore
@GsonJsonIgnore
protected final Gson encoder = new GsonBuilder().disableHtmlEscaping()
.registerTypeAdapter(ZonedDateTime.class, new GsonUTCAdapter())
.registerTypeAdapter(Instant.class, new GsonInstantAdapter()).create();
/**
* Toolset to encode/decode tools associated with a topic.
*
* @param eventProtocolParams parameter object for event encoder
* @param controllerId controller id
*/
public GsonProtocolCoderToolset(EventProtocolParams eventProtocolParams, String controllerId) {
super(eventProtocolParams, controllerId);
}
/**
* gets the Gson decoder.
*
* @return the Gson decoder
*/
@JsonIgnore
@GsonJsonIgnore
protected Gson getDecoder() {
return this.decoder;
}
/**
* gets the Gson encoder.
*
* @return the Gson encoder
*/
@JsonIgnore
@GsonJsonIgnore
protected Gson getEncoder() {
return this.encoder;
}
/**
* {@inheritDoc}.
*/
@Override
public Object decode(String json) {
final DroolsController droolsController =
DroolsController.factory.get(this.groupId, this.artifactId, "");
if (droolsController == null) {
logger.warn("{}: no drools-controller to process {}", this, json);
throw new IllegalStateException("no drools-controller to process event");
}
final CoderFilters decoderFilter = this.filter(json);
if (decoderFilter == null) {
logger.debug("{}: no decoder to process {}", this, json);
throw new UnsupportedOperationException("no decoder to process event");
}
Class<?> decoderClass;
try {
decoderClass = droolsController.fetchModelClass(decoderFilter.getCodedClass());
if (decoderClass == null) {
logger.warn("{}: cannot fetch application class {}", this, decoderFilter.getCodedClass());
throw new IllegalStateException(
"cannot fetch application class " + decoderFilter.getCodedClass());
}
} catch (final Exception e) {
logger.warn("{}: cannot fetch application class {} because of {}", this,
decoderFilter.getCodedClass(), e.getMessage());
throw new UnsupportedOperationException(
"cannot fetch application class " + decoderFilter.getCodedClass(), e);
}
if (this.customCoder != null) {
try {
final Class<?> gsonClassContainer =
droolsController.fetchModelClass(this.customCoder.getClassContainer());
final Field gsonField = gsonClassContainer.getField(this.customCoder.staticCoderField);
final Object gsonObject = gsonField.get(null);
final Method fromJsonMethod = gsonObject.getClass().getDeclaredMethod("fromJson",
new Class[] {String.class, Class.class});
return fromJsonMethod.invoke(gsonObject, json, decoderClass);
} catch (final Exception e) {
logger.warn("{}: cannot fetch application class {} because of {}", this,
decoderFilter.getCodedClass(), e.getMessage());
throw new UnsupportedOperationException(
"cannot fetch application class " + decoderFilter.getCodedClass(), e);
}
} else {
try {
return this.decoder.fromJson(json, decoderClass);
} catch (final Exception e) {
logger.warn("{} cannot decode {} into {} because of {}", this, json, decoderClass.getName(),
e.getMessage(), e);
throw new UnsupportedOperationException(
"cannont decode into " + decoderFilter.getCodedClass(), e);
}
}
}
/**
* {@inheritDoc}.
*/
@Override
public String encode(Object event) {
if (this.customCoder != null) {
try {
final DroolsController droolsController =
DroolsController.factory.get(this.groupId, this.artifactId, null);
final Class<?> gsonClassContainer =
droolsController.fetchModelClass(this.customCoder.getClassContainer());
final Field gsonField = gsonClassContainer.getField(this.customCoder.staticCoderField);
final Object gsonObject = gsonField.get(null);
final Method toJsonMethod =
gsonObject.getClass().getDeclaredMethod("toJson", new Class[] {Object.class});
return (String) toJsonMethod.invoke(gsonObject, event);
} catch (final Exception e) {
logger.warn("{} cannot custom-encode {} because of {}", this, event, e.getMessage(), e);
throw new UnsupportedOperationException("event cannot be encoded", e);
}
} else {
try {
return this.encoder.toJson(event);
} catch (final Exception e) {
logger.warn("{} cannot encode {} because of {}", this, event, e.getMessage(), e);
throw new UnsupportedOperationException("event cannot be encoded", e);
}
}
}
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
builder.append("GsonProtocolCoderToolset [toString()=").append(super.toString()).append("]");
return builder.toString();
}
}
|