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
|
/*
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2017-2020 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.features;
import java.util.Properties;
import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
import org.onap.policy.common.utils.services.OrderedService;
import org.onap.policy.drools.protocol.configuration.DroolsConfiguration;
import org.onap.policy.drools.system.PolicyController;
public interface PolicyControllerFeatureApi extends OrderedService {
/**
* called before creating a controller with name 'name' and
* properties 'properties'.
*
* @param name name of the the controller
* @param properties configuration properties
*
* @return a policy controller. A take over of the creation operation
* is performed by returning a non-null policy controller.
* 'null' indicates that no take over has taken place, and processing should
* continue to the next feature provider.
*/
default PolicyController beforeCreate(String name, Properties properties) {
return null;
}
/**
* called after creating a controller with name 'name'.
*
* @param controller controller
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean afterCreate(PolicyController controller) {
return false;
}
/**
* called before the actual instantiation of a Policy Controller.
*
* @param name name of the controller
* @param properties configuration parameters in the form of properties
*
* @return a Policy Controller or 'null for no intercept.
*/
default PolicyController beforeInstance(String name, Properties properties) {
return null;
}
/**
* called after the Policy Controller is instantiated.
*
* @param controller policy controller
* @param properties configuration parameters in the form of properties
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean afterInstance(PolicyController controller, Properties properties) {
return false;
}
/**
* intercept before the Policy Controller is started.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean beforeStart(PolicyController controller) {
return false;
}
/**
* intercept after the Policy Controller is started.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean afterStart(PolicyController controller) {
return false;
}
/**
* intercept before the Policy Controller is stopped.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean beforeStop(PolicyController controller) {
return false;
}
/**
* intercept after the Policy Controller is stopped.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.d.
*/
default boolean afterStop(PolicyController controller) {
return false;
}
/**
* intercept before the Policy Controller is patched.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean beforePatch(
PolicyController controller, DroolsConfiguration oldConfiguration, DroolsConfiguration newConfiguration) {
return false;
}
/**
* intercept after the Policy Controller is patched.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean afterPatch(
PolicyController controller, DroolsConfiguration oldConfiguration,
DroolsConfiguration newConfiguration, boolean success) {
return false;
}
/**
* intercept before the Policy Controller is locked.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean beforeLock(PolicyController controller) {
return false;
}
/**
* intercept after the Policy Controller is locked.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise..
*/
default boolean afterLock(PolicyController controller) {
return false;
}
/**
* intercept before the Policy Controller is locked.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean beforeUnlock(PolicyController controller) {
return false;
}
/**
* intercept after the Policy Controller is locked.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean afterUnlock(PolicyController controller) {
return false;
}
/**
* intercept before the Policy Controller is shut down.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise..
*/
default boolean beforeShutdown(PolicyController controller) {
return false;
}
/**
* called after the Policy Controller is shut down.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean afterShutdown(PolicyController controller) {
return false;
}
/**
* intercept before the Policy Controller is halted.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise..
*/
default boolean beforeHalt(PolicyController controller) {
return false;
}
/**
* called after the Policy Controller is halted.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean afterHalt(PolicyController controller) {
return false;
}
/*
* intercept before the Policy Controller is offered an event.
*
* @return true if this feature intercepts and takes ownership.
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean beforeOffer(PolicyController controller,
CommInfrastructure protocol,
String topic,
String event) {
return false;
}
/**
* intercept before the Policy Controller delivers (posts) an event.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default <T> boolean beforeOffer(PolicyController controller, T event) {
return false;
}
/**
* called after the Policy Controller processes an event offer.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean afterOffer(PolicyController controller,
CommInfrastructure protocol,
String topic,
String event,
boolean success) {
return false;
}
/**
* called after the Policy Controller delivers (posts) an event.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default <T> boolean afterOffer(PolicyController controller, T event, boolean success) {
return false;
}
/**
* intercept before the Policy Controller delivers (posts) an event.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean beforeDeliver(PolicyController controller,
CommInfrastructure protocol,
String topic,
Object event) {
return false;
}
/**
* called after the Policy Controller delivers (posts) an event.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean afterDeliver(PolicyController controller,
CommInfrastructure protocol,
String topic,
Object event,
boolean success) {
return false;
}
}
|
