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
|
/*
* ===============================LICENSE_START======================================
* dcae-analytics
* ================================================================================
* Copyright © 2017 AT&T Intellectual Property. 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.
* ============================LICENSE_END===========================================
*/
package org.openecomp.dcae.apod.analytics.common.service.filter;
import com.google.common.collect.ImmutableSet;
import com.jayway.jsonpath.DocumentContext;
import com.jayway.jsonpath.JsonPath;
import com.jayway.jsonpath.PathNotFoundException;
import org.apache.commons.lang3.StringUtils;
import org.openecomp.dcae.apod.analytics.common.service.processor.AbstractMessageProcessor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.List;
import java.util.Set;
/**
* A Generic Json Message Filter which filter the json message based on given json Path and list of expected values
* for that json path. The {@link JsonMessageFilterProcessorContext#isMatched} flag will be changed as per table below:
* <pre>
* Incoming message is blank or invalid Json = null
* Incoming message path is matches expected values = true
* Incoming message does not match expected values or path does not exist = false
* </pre>
* <p>
* @author Rajiv Singla . Creation Date: 2/10/2017.
*/
public class GenericJsonMessageFilter extends AbstractMessageProcessor<JsonMessageFilterProcessorContext> {
private static final Logger LOG = LoggerFactory.getLogger(GenericJsonMessageFilter.class);
private static final long serialVersionUID = 1L;
private final String filterName;
private final String jsonPath;
private final Set<String> expectedValues;
public GenericJsonMessageFilter(final String filterName, final String jsonPath, final Set<String> expectedValues) {
this.filterName = filterName;
this.jsonPath = jsonPath;
this.expectedValues = expectedValues;
}
public GenericJsonMessageFilter(final String filterName, final String jsonPath, final String expectedValue) {
this(filterName, jsonPath, ImmutableSet.of(expectedValue));
}
@Override
public String getProcessorDescription() {
return filterName;
}
@Override
public JsonMessageFilterProcessorContext processMessage(final JsonMessageFilterProcessorContext processorContext) {
final String jsonMessage = processorContext.getMessage().trim();
if (StringUtils.isNotBlank(jsonMessage) && jsonMessage.startsWith("{") && jsonMessage.endsWith("}")) {
// locate json path value
final DocumentContext documentContext = JsonPath.parse(jsonMessage);
String jsonPathValue = null;
try {
final List jsonPathValues = documentContext.read(jsonPath);
final Object pathValue = jsonPathValues.isEmpty() ? null : jsonPathValues.get(0);
jsonPathValue = pathValue instanceof Number ? pathValue.toString() : (String) pathValue;
} catch (PathNotFoundException ex) {
LOG.info("Unable to find json Path: {}. Exception: {}, Json Message: {}", jsonPath, ex, jsonMessage);
}
LOG.debug("Value for jsonPath: {}, jsonPathValue: {}, expected Values: {}",
jsonPath, jsonPathValue, expectedValues);
// if json path value is null or we json value is not present in expect values then terminate early
if (jsonPathValue == null || !expectedValues.contains(jsonPathValue)) {
final String terminatingMessage = String.format("Filter match unsuccessful. " +
"JsonPath: %s, Actual JsonPathValue: %s, Excepted Json Path Values: %s",
jsonPath, jsonPathValue, expectedValues);
processorContext.setMatched(false);
setTerminatingProcessingMessage(terminatingMessage, processorContext);
} else {
final String finishProcessingMessage = String.format("Filter match successful. " +
"JsonPath: %s, Actual JsonPathValue: %s, Excepted Json Path Values: %s",
jsonPath, jsonPathValue, expectedValues);
processorContext.setMatched(true);
setFinishedProcessingMessage(finishProcessingMessage, processorContext);
}
} else {
// if incoming message is blank of valid Json then matched flag will be null
final String terminatingMessage = "Incoming json message is blank or not json. " +
"Json filter cannot be applied";
processorContext.setMatched(null);
setTerminatingProcessingMessage(terminatingMessage, processorContext);
}
return processorContext;
}
}
|
