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
|
/*
* ============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 java.util.List;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import org.onap.policy.drools.controller.DroolsController;
/**
* Coder (Encoder/Decoder) of Events.
*/
public interface EventProtocolCoder {
@Getter
@Setter
@ToString
@AllArgsConstructor
public static class CoderFilters {
/**
* coder class.
*/
protected String factClass;
/**
* filters to apply to the selection of the decodedClass.
*/
protected JsonProtocolFilter filter;
/**
* classloader hash.
*/
protected int modelClassLoaderHash;
}
/**
* Adds a Decoder class to decode the protocol over this topic.
*
* @param eventProtocolParams parameter object for event protocol
* @throw IllegalArgumentException if an invalid parameter is passed
*/
void addDecoder(EventProtocolParams eventProtocolParams);
/**
* removes all decoders associated with the controller id.
*
* @param groupId of the controller
* @param artifactId of the controller
* @param topic of the controller
* @throws IllegalArgumentException if invalid arguments have been provided
*/
void removeEncoders(String groupId, String artifactId, String topic);
/**
* removes decoders associated with the controller id and topic.
*
* @param groupId of the controller
* @param artifactId of the controller
* @param topic the topic
* @throws IllegalArgumentException if invalid arguments have been provided
*/
void removeDecoders(String groupId, String artifactId, String topic);
/**
* Given a controller id and a topic, it gives back its filters.
*
* @param groupId of the controller
* @param artifactId of the controller
* @param topic the topic
* @return list of decoders
* @throw IllegalArgumentException if an invalid parameter is passed
*/
List<CoderFilters> getDecoderFilters(String groupId, String artifactId, String topic);
/**
* gets all decoders associated with the group and artifact ids.
*
* @param groupId of the controller
* @param artifactId of the controller
* @throws IllegalArgumentException if invalid arguments have been provided
*/
List<CoderFilters> getDecoderFilters(String groupId, String artifactId);
/**
* Given a controller id, a topic, and a classname, it gives back the classes that implements the decoding.
*
* @param groupId of the controller
* @param artifactId of the controller
* @param topic the topic
* @param classname classname
* @return list of decoders
* @throw IllegalArgumentException if an invalid parameter is passed
*/
CoderFilters getDecoderFilters(
String groupId, String artifactId, String topic, String classname);
/**
* Given a controller id and a topic, it gives back the decoding configuration.
*
* @param groupId of the controller
* @param artifactId of the controller
* @param topic the topic
* @return decoding toolset
* @throw IllegalArgumentException if an invalid parameter is passed
*/
ProtocolCoderToolset getDecoders(String groupId, String artifactId, String topic);
/**
* Given a controller id and a topic, it gives back all the decoding configurations.
*
* @param groupId of the controller
* @param artifactId of the controller
* @return decoding toolset
* @throw IllegalArgumentException if an invalid parameter is passed
*/
List<ProtocolCoderToolset> getDecoders(String groupId, String artifactId);
/**
* Given a controller id and a topic, it gives back the classes that implements the encoding.
*
* @param groupId of the controller
* @param artifactId of the controller
* @param topic the topic
* @return list of decoders
* @throw IllegalArgumentException if an invalid parameter is passed
*/
List<CoderFilters> getEncoderFilters(String groupId, String artifactId, String topic);
/**
* gets all encoders associated with the group and artifact ids.
*
* @param groupId of the controller
* @param artifactId of the controller
* @return List of filters
* @throws IllegalArgumentException if invalid arguments have been provided
*/
List<CoderFilters> getEncoderFilters(String groupId, String artifactId);
/**
* get encoder based on coordinates and classname.
*
* @param groupId of the controller
* @param artifactId of the controller
* @param topic protocol
* @param classname name of the class
* @return CoderFilters decoders
* @throws IllegalArgumentException invalid arguments passed in
*/
CoderFilters getEncoderFilters(
String groupId, String artifactId, String topic, String classname);
/**
* is there a decoder supported for the controller id and topic.
*
* @param groupId of the controller
* @param artifactId of the controller
* @param topic protocol
* @return true if supported
*/
boolean isDecodingSupported(String groupId, String artifactId, String topic);
/**
* Adds a Encoder class to encode the protocol over this topic.
*
* @param eventProtocolParams parameter object for event protocol
* @throw IllegalArgumentException if an invalid parameter is passed
*/
void addEncoder(EventProtocolParams eventProtocolParams);
/**
* is there an encoder supported for the controller id and topic.
*
* @param groupId of the controller
* @param artifactId of the controller
* @param topic protocol
* @return true if supported
*/
boolean isEncodingSupported(String groupId, String artifactId, String topic);
/**
* get encoder based on topic and encoded class.
*
* @param topic topic
* @param encodedClass encoded class
* @return list of filters
* @throws IllegalArgumentException invalid arguments passed in
*/
List<CoderFilters> getReverseEncoderFilters(String topic, String encodedClass);
/**
* gets the identifier of the creator of the encoder.
*
* @param topic topic
* @param encodedClass encoded class
* @return a drools controller
* @throws IllegalArgumentException invalid arguments passed in
*/
DroolsController getDroolsController(String topic, Object encodedClass);
/**
* gets the identifier of the creator of the encoder.
*
* @param topic topic
* @param encodedClass encoded class
* @return list of drools controllers
* @throws IllegalArgumentException invalid arguments passed in
*/
List<DroolsController> getDroolsControllers(String topic, Object encodedClass);
/**
* decode topic's stringified event (json) to corresponding Event Object.
*
* @param groupId of the controller
* @param artifactId of the controller
* @param topic protocol
* @param json event string
* @return object
* @throws IllegalArgumentException invalid arguments passed in
* @throws UnsupportedOperationException if the operation is not supported
* @throws IllegalStateException if the system is in an illegal state
*/
Object decode(String groupId, String artifactId, String topic, String json);
/**
* encodes topic's stringified event (json) to corresponding Event Object.
*
* @param groupId of the controller
* @param artifactId of the controller
* @param topic protocol
* @param event Object
* @return encoded string
* @throws IllegalArgumentException invalid arguments passed in
*/
String encode(String groupId, String artifactId, String topic, Object event);
/**
* encodes topic's stringified event (json) to corresponding Event Object.
*
* @param topic topic
* @param event event object
* @return encoded string
* @throws IllegalArgumentException invalid arguments passed in
* @throws UnsupportedOperationException operation cannot be performed
*/
String encode(String topic, Object event);
/**
* encodes topic's stringified event (json) to corresponding Event Object.
*
* @param topic topic
* @param event event object
* @param droolsController drools controller object
* @return encoded string
* @throws IllegalArgumentException invalid arguments passed in
* @throws UnsupportedOperationException operation cannot be performed
*/
String encode(String topic, Object event, DroolsController droolsController);
}
|
