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
|
/*
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2019, 2021 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.onap.policy.drools.protocol.coders;
import java.util.ArrayList;
import java.util.List;
import lombok.ToString;
import org.onap.policy.drools.controller.DroolsController;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Protocol Coder that does its best attempt to decode/encode, selecting the best class and best fitted json parsing
* tools.
*/
@ToString
class MultiplexorEventProtocolCoder implements EventProtocolCoder {
/**
* Logger.
*/
private static final Logger logger = LoggerFactory.getLogger(MultiplexorEventProtocolCoder.class);
/**
* Decoders.
*/
protected EventProtocolDecoder decoders = new EventProtocolDecoder();
/**
* Encoders.
*/
protected EventProtocolEncoder encoders = new EventProtocolEncoder();
/**
* {@inheritDoc}.
*/
@Override
public void addDecoder(EventProtocolParams eventProtocolParams) {
logger.info(
"{}: add-decoder {}:{}:{}:{}:{}:{}:{}",
this,
eventProtocolParams.getGroupId(),
eventProtocolParams.getArtifactId(),
eventProtocolParams.getTopic(),
eventProtocolParams.getEventClass(),
eventProtocolParams.getProtocolFilter(),
eventProtocolParams.getCustomGsonCoder(),
eventProtocolParams.getModelClassLoaderHash());
this.decoders.add(eventProtocolParams);
}
/**
* {@inheritDoc}.
*
* @param eventProtocolParams parameter object for event encoder
*/
@Override
public void addEncoder(EventProtocolParams eventProtocolParams) {
logger.info(
"{}: add-decoder {}:{}:{}:{}:{}:{}:{}",
this,
eventProtocolParams.getGroupId(),
eventProtocolParams.getArtifactId(),
eventProtocolParams.getTopic(),
eventProtocolParams.getEventClass(),
eventProtocolParams.getProtocolFilter(),
eventProtocolParams.getCustomGsonCoder(),
eventProtocolParams.getModelClassLoaderHash());
this.encoders.add(eventProtocolParams);
}
/**
* {@inheritDoc}.
*/
@Override
public void removeDecoders(String groupId, String artifactId, String topic) {
logger.info("{}: remove-decoder {}:{}:{}", this, groupId, artifactId, topic);
this.decoders.remove(groupId, artifactId, topic);
}
/**
* {@inheritDoc}.
*/
@Override
public void removeEncoders(String groupId, String artifactId, String topic) {
logger.info("{}: remove-encoder {}:{}:{}", this, groupId, artifactId, topic);
this.encoders.remove(groupId, artifactId, topic);
}
/**
* {@inheritDoc}.
*/
@Override
public boolean isDecodingSupported(String groupId, String artifactId, String topic) {
return this.decoders.isCodingSupported(groupId, artifactId, topic);
}
/**
* {@inheritDoc}.
*/
@Override
public boolean isEncodingSupported(String groupId, String artifactId, String topic) {
return this.encoders.isCodingSupported(groupId, artifactId, topic);
}
/**
* {@inheritDoc}.
*/
@Override
public Object decode(String groupId, String artifactId, String topic, String json) {
logger.debug("{}: decode {}:{}:{}:{}", this, groupId, artifactId, topic, json); // NOSONAR
/*
* It seems that sonar declares the previous logging line as a security vulnerability
* when logging the topic variable. The static code analysis indicates that
* the path starts in org.onap.policy.drools.server.restful.RestManager::decode(),
* but the request is rejected if the topic contains invalid characters (the sonar description
* mentions "/r/n/t" characters) which are validated against in the checkValidNameInput(topic).
* Furthermore production instances are assumed not to have debug enabled, nor the REST telemetry API
* should be published externally. An additional note is that Path URLs containing spaces and newlines
* will be failed earlier at the HTTP protocol libraries (jetty, etc ..) so an URL of the form
* "https://../to\npic" won't even make it here.
*/
return this.decoders.decode(groupId, artifactId, topic, json);
}
/**
* {@inheritDoc}.
*/
@Override
public String encode(String groupId, String artifactId, String topic, Object event) {
logger.debug("{}: encode {}:{}:{}:{}", this, groupId, artifactId, topic, event);
return this.encoders.encode(groupId, artifactId, topic, event);
}
/**
* {@inheritDoc}.
*/
@Override
public String encode(String topic, Object event) {
logger.debug("{}: encode {}:{}", this, topic, event); // NOSONAR
/*
* See explanation for decode(String groupId, String artifactId, String topic, String json).
* The same applies here as it is called from
* org.onap.policy.drools.server.restful.RestManager::encode(),
*/
return this.encoders.encode(topic, event);
}
/**
* {@inheritDoc}.
*/
@Override
public String encode(String topic, Object event, DroolsController droolsController) {
logger.debug("{}: encode {}:{}:{}", this, topic, event, droolsController);
return this.encoders.encode(topic, event, droolsController);
}
/**
* {@inheritDoc}.
*/
@Override
public List<CoderFilters> getDecoderFilters(String groupId, String artifactId, String topic) {
return this.decoders.getFilters(groupId, artifactId, topic);
}
/**
* {@inheritDoc}.
*/
@Override
public CoderFilters getDecoderFilters(
String groupId, String artifactId, String topic, String classname) {
return this.decoders.getFilters(groupId, artifactId, topic, classname);
}
/**
* {@inheritDoc}.
*/
@Override
public List<CoderFilters> getDecoderFilters(String groupId, String artifactId) {
return this.decoders.getFilters(groupId, artifactId);
}
/**
* {@inheritDoc}.
*/
@Override
public ProtocolCoderToolset getDecoders(String groupId, String artifactId, String topic) {
ProtocolCoderToolset decoderToolsets =
this.decoders.getCoders(groupId, artifactId, topic);
if (decoderToolsets == null) {
throw new IllegalArgumentException(
"Decoders not found for " + groupId + ":" + artifactId + ":" + topic);
}
return decoderToolsets;
}
/**
* get all deocders by maven coordinates and topic.
*
* @param groupId group id
* @param artifactId artifact id
* @return list of decoders
* @throws IllegalArgumentException if invalid input
*/
@Override
public List<ProtocolCoderToolset> getDecoders(String groupId, String artifactId) {
List<ProtocolCoderToolset> decoderToolsets =
this.decoders.getCoders(groupId, artifactId);
if (decoderToolsets == null) {
throw new IllegalArgumentException("Decoders not found for " + groupId + ":" + artifactId);
}
return new ArrayList<>(decoderToolsets);
}
/**
* {@inheritDoc}.
*/
@Override
public List<CoderFilters> getEncoderFilters(String groupId, String artifactId, String topic) {
return this.encoders.getFilters(groupId, artifactId, topic);
}
/**
* {@inheritDoc}.
*/
@Override
public CoderFilters getEncoderFilters(
String groupId, String artifactId, String topic, String classname) {
return this.encoders.getFilters(groupId, artifactId, topic, classname);
}
/**
* {@inheritDoc}.
*/
@Override
public List<CoderFilters> getEncoderFilters(String groupId, String artifactId) {
return this.encoders.getFilters(groupId, artifactId);
}
/**
* {@inheritDoc}.
*/
@Override
public List<CoderFilters> getReverseEncoderFilters(String topic, String encodedClass) {
return this.encoders.getReverseFilters(topic, encodedClass);
}
/**
* {@inheritDoc}.
*/
@Override
public DroolsController getDroolsController(String topic, Object encodedClass) {
return this.encoders.getDroolsController(topic, encodedClass);
}
/**
* {@inheritDoc}.
*/
@Override
public List<DroolsController> getDroolsControllers(String topic, Object encodedClass) {
return this.encoders.getDroolsControllers(topic, encodedClass);
}
}
|