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
|
/*
* ============LICENSE_START=======================================================
* policy-engine
* ================================================================================
* 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.system.PolicyEngine;
import org.onap.policy.drools.utils.OrderedService;
import org.onap.policy.drools.utils.OrderedServiceImpl;
/**
* Policy Engine Feature API.
* Provides Interception Points during the Policy Engine lifecycle.
*/
public interface PolicyEngineFeatureAPI extends OrderedService {
/**
* Feature providers implementing this interface
*/
public static final OrderedServiceImpl<PolicyEngineFeatureAPI> providers =
new OrderedServiceImpl<>(PolicyEngineFeatureAPI.class);
/**
* intercept before the Policy Engine is commanded to boot.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
public default boolean beforeBoot(PolicyEngine engine, String[] cliArgs) {return false;};
/**
* intercept after the Policy Engine is booted.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
public default boolean afterBoot(PolicyEngine engine) {return false;};
/**
* intercept before the Policy Engine is configured.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
public default boolean beforeConfigure(PolicyEngine engine, Properties properties) {return false;};
/**
* intercept after the Policy Engine is configured.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
public default boolean afterConfigure(PolicyEngine engine) {return false;};
/**
* intercept before the Policy Engine goes active.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
public default boolean beforeActivate(PolicyEngine engine) {return false;};
/**
* intercept after the Policy Engine goes active.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
public default boolean afterActivate(PolicyEngine engine) {return false;};
/**
* intercept before the Policy Engine goes standby.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
public default boolean beforeDeactivate(PolicyEngine engine) {return false;};
/**
* intercept after the Policy Engine goes standby.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
public default boolean afterDeactivate(PolicyEngine engine) {return false;};
/**
* intercept before the Policy Engine 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(PolicyEngine engine) {return false;};
/**
* intercept after the Policy Engine 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(PolicyEngine engine) {return false;};
/**
* intercept before the Policy Engine 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(PolicyEngine engine) {return false;};
/**
* intercept after the Policy Engine 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(PolicyEngine engine) {return false;};
/**
* intercept before the Policy Engine 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(PolicyEngine engine) {return false;};
/**
* intercept after the Policy Engine 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(PolicyEngine engine) {return false;};
/**
* intercept before the Policy Engine 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(PolicyEngine engine) {return false;};
/**
* intercept after the Policy Engine 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(PolicyEngine engine) {return false;};
/**
* intercept the Policy Engine 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(PolicyEngine engine){return false;};
/**
* called after the Policy Engine 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(PolicyEngine engine) {return false;};
}
|