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
|
/*
* ============LICENSE_START=======================================================
* policy-management
* ================================================================================
* Copyright (C) 2017-2018 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.drools.event.comm.Topic.CommInfrastructure;
import org.onap.policy.drools.system.PolicyController;
import org.onap.policy.drools.utils.OrderedService;
import org.onap.policy.drools.utils.OrderedServiceImpl;
public interface PolicyControllerFeatureAPI extends OrderedService {
/**
* Feature providers implementing this interface
*/
public static final OrderedServiceImpl<PolicyControllerFeatureAPI> providers =
new OrderedServiceImpl<PolicyControllerFeatureAPI>(PolicyControllerFeatureAPI.class);
/**
* 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.
*/
public 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.
*/
public default boolean afterCreate(PolicyController controller) {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.
*/
public 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.
*/
public 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..
*/
public 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.
*/
public default boolean afterStop(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.
*/
public 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..
*/
public 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.
*/
public 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.
*/
public 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..
*/
public 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.
*/
public 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..
*/
public 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.
*/
public 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.
*/
public default boolean beforeOffer(PolicyController controller,
CommInfrastructure protocol,
String topic,
String 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.
*/
public default boolean afterOffer(PolicyController controller,
CommInfrastructure protocol,
String topic,
String 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.
*/
public 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.
*/
public default boolean afterDeliver(PolicyController controller,
CommInfrastructure protocol,
String topic,
Object event,
boolean success) {return false;}
}
|