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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
|
/*
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2019 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.lifecycle;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Properties;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.ScheduledThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import lombok.Getter;
import lombok.NonNull;
import lombok.Setter;
import org.apache.commons.lang3.StringUtils;
import org.onap.policy.common.capabilities.Startable;
import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
import org.onap.policy.common.endpoints.event.comm.TopicEndpoint;
import org.onap.policy.common.endpoints.event.comm.TopicSink;
import org.onap.policy.common.endpoints.event.comm.TopicSource;
import org.onap.policy.common.endpoints.event.comm.client.TopicSinkClient;
import org.onap.policy.common.endpoints.listeners.MessageTypeDispatcher;
import org.onap.policy.common.endpoints.listeners.ScoListener;
import org.onap.policy.common.gson.annotation.GsonJsonIgnore;
import org.onap.policy.common.utils.coder.StandardCoderObject;
import org.onap.policy.common.utils.network.NetworkUtil;
import org.onap.policy.drools.controller.DroolsController;
import org.onap.policy.drools.persistence.SystemPersistence;
import org.onap.policy.drools.system.PolicyController;
import org.onap.policy.models.pdp.concepts.PdpResponseDetails;
import org.onap.policy.models.pdp.concepts.PdpStateChange;
import org.onap.policy.models.pdp.concepts.PdpStatus;
import org.onap.policy.models.pdp.concepts.PdpUpdate;
import org.onap.policy.models.pdp.enums.PdpHealthStatus;
import org.onap.policy.models.pdp.enums.PdpMessageType;
import org.onap.policy.models.pdp.enums.PdpState;
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyIdentifier;
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Lifecycle FSM.
*/
public class LifecycleFsm implements Startable {
protected static final String CONFIGURATION_PROPERTIES_NAME = "feature-lifecycle";
protected static final String POLICY_TYPE_VERSION = "1.0.0";
protected static final long DEFAULT_STATUS_TIMER_SECONDS = 60L;
protected static final long MIN_STATUS_INTERVAL_SECONDS = 5L;
protected static final String PDP_MESSAGE_NAME = "messageName";
private static final Logger logger = LoggerFactory.getLogger(LifecycleFsm.class);
protected final Properties properties;
protected TopicSource source;
protected TopicSinkClient client;
@Getter
protected final String name = NetworkUtil.getHostname();
protected volatile LifecycleState state = new LifecycleStateTerminated(this);
@GsonJsonIgnore
protected ScheduledThreadPoolExecutor scheduler = new ScheduledThreadPoolExecutor(1);
@GsonJsonIgnore
protected ScheduledFuture<?> statusTask;
@GsonJsonIgnore
protected MessageTypeDispatcher sourceDispatcher = new MessageTypeDispatcher(new String[]{PDP_MESSAGE_NAME});
@GsonJsonIgnore
protected PdpStateChangeFeed stateChangeFeed = new PdpStateChangeFeed(PdpStateChange.class, this);
@GsonJsonIgnore
protected PdpUpdateFeed updateFeed = new PdpUpdateFeed(PdpUpdate.class, this);
@Getter
@Setter
protected long statusTimerSeconds = DEFAULT_STATUS_TIMER_SECONDS;
@Getter
protected String group;
@Getter
protected String subgroup;
protected final Map<ToscaPolicyTypeIdentifier, PolicyController> policyTypesMap = new HashMap<>();
protected final Map<ToscaPolicyIdentifier, ToscaPolicy> policiesMap = new HashMap<>();
/**
* Constructor.
*/
public LifecycleFsm() {
this.properties = SystemPersistence.manager.getProperties(CONFIGURATION_PROPERTIES_NAME);
scheduler.setContinueExistingPeriodicTasksAfterShutdownPolicy(false);
scheduler.setExecuteExistingDelayedTasksAfterShutdownPolicy(false);
scheduler.setRemoveOnCancelPolicy(true);
}
@Override
public boolean isAlive() {
return client != null && client.getSink().isAlive();
}
/**
* Current state.
*/
public PdpState state() {
return state.state();
}
/* ** FSM events - entry points of events into the FSM ** */
@Override
public synchronized boolean start() {
logger.info("lifecycle event: start engine");
return state.start();
}
/**
* Start a controller event.
*/
public synchronized void start(@NonNull PolicyController controller) {
logger.info("lifecycle event: start controller: {}" + controller.getName());
for (ToscaPolicyTypeIdentifier id : controller.getPolicyTypes()) {
policyTypesMap.put(id, controller);
}
}
@Override
public synchronized boolean stop() {
logger.info("lifecycle event: stop engine");
return state.stop();
}
/**
* Stop a controller event.
*/
public synchronized void stop(@NonNull PolicyController controller) {
logger.info("lifecycle event: stop controller: {}" + controller.getName());
for (ToscaPolicyTypeIdentifier id : controller.getPolicyTypes()) {
policyTypesMap.remove(id);
}
}
@Override
public synchronized void shutdown() {
logger.info("lifecycle event: shutdown engine");
state.shutdown();
}
/**
* Status reporting event.
* @return true if successful
*/
public synchronized boolean status() {
logger.info("lifecycle event: status");
return state.status();
}
public synchronized boolean stateChange(PdpStateChange stateChange) {
logger.info("lifecycle event: state-change");
return state.stateChange(stateChange);
}
public synchronized boolean update(PdpUpdate update) {
logger.info("lifecycle event: update");
return state.update(update);
}
/* ** FSM State Actions ** */
protected boolean startAction() {
if (isAlive()) {
return true;
}
return startIo() && startTimers();
}
protected boolean stopAction() {
if (!isAlive()) {
return true;
}
boolean successTimers = stopTimers();
boolean successIo = stopIo();
return successTimers && successIo;
}
protected void shutdownAction() {
shutdownIo();
shutdownTimers();
}
protected boolean statusAction() {
return statusAction(state(), null);
}
protected boolean statusAction(PdpResponseDetails response) {
return statusAction(state(), response);
}
protected boolean statusAction(PdpState state, PdpResponseDetails response) {
if (!isAlive()) {
return false;
}
PdpStatus status = statusPayload(state);
if (response != null) {
status.setRequestId(response.getResponseTo()); // for standard logging of transactions
status.setResponse(response);
}
return client.send(statusPayload(state));
}
protected void setGroupAction(String group, String subgroup) {
this.group = group;
this.subgroup = subgroup;
}
protected void transitionToAction(@NonNull LifecycleState newState) {
state = newState;
}
protected boolean setStatusIntervalAction(long intervalSeconds) {
if (intervalSeconds == statusTimerSeconds || intervalSeconds == 0) {
return true;
}
if (intervalSeconds <= MIN_STATUS_INTERVAL_SECONDS) {
logger.warn("interval is too low (< {}): {}", MIN_STATUS_INTERVAL_SECONDS, intervalSeconds);
return false;
}
setStatusTimerSeconds(intervalSeconds);
return stopTimers() && startTimers();
}
protected PolicyController getController(ToscaPolicyTypeIdentifier policyType) {
return policyTypesMap.get(policyType);
}
protected List<ToscaPolicy> getDeployablePoliciesAction(@NonNull List<ToscaPolicy> policies) {
List<ToscaPolicy> deployPolicies = new ArrayList<>(policies);
deployPolicies.removeAll(policiesMap.values());
return deployPolicies;
}
protected List<ToscaPolicy> getUndeployablePoliciesAction(@NonNull List<ToscaPolicy> policies) {
List<ToscaPolicy> undeployPolicies = new ArrayList<>(policiesMap.values());
undeployPolicies.removeAll(policies);
return undeployPolicies;
}
protected void deployedPolicyAction(@NonNull ToscaPolicy policy) {
policiesMap.put(policy.getIdentifier(), policy);
}
protected void undeployedPolicyAction(@NonNull ToscaPolicy policy) {
policiesMap.remove(policy.getIdentifier());
}
/* ** Action Helpers ** */
private boolean startIo() {
return source() && sink();
}
private boolean startTimers() {
statusTask =
this.scheduler.scheduleAtFixedRate(() -> status(), 0, statusTimerSeconds, TimeUnit.SECONDS);
return !statusTask.isCancelled() && !statusTask.isDone();
}
private boolean stopIo() {
source.unregister(sourceDispatcher);
boolean successSource = source.stop();
boolean successSink = client.getSink().stop();
return successSource && successSink;
}
private boolean stopTimers() {
boolean success = true;
if (statusTask != null) {
success = statusTask.cancel(false);
}
return success;
}
private void shutdownIo() {
client.getSink().shutdown();
source.shutdown();
}
private void shutdownTimers() {
scheduler.shutdownNow();
}
private PdpStatus statusPayload() {
return statusPayload(state());
}
private PdpStatus statusPayload(@NonNull PdpState state) {
PdpStatus status = new PdpStatus();
status.setName(name);
status.setPdpGroup(group);
status.setPdpSubgroup(subgroup);
status.setState(state);
status.setHealthy(isAlive() ? PdpHealthStatus.HEALTHY : PdpHealthStatus.NOT_HEALTHY);
status.setPdpType("drools");
status.setSupportedPolicyTypes(getCapabilities());
status.setPolicies(new ArrayList<>(policiesMap.keySet()));
return status;
}
private boolean source() {
List<TopicSource> sources = TopicEndpoint.manager.addTopicSources(properties);
if (sources.isEmpty()) {
return false;
}
if (sources.size() != 1) {
logger.warn("Lifecycle Manager: unexpected: more than one source configured ({})", sources.size());
}
this.source = sources.get(0);
this.source.register(this.sourceDispatcher);
this.sourceDispatcher.register(PdpMessageType.PDP_STATE_CHANGE.name(), stateChangeFeed);
this.sourceDispatcher.register(PdpMessageType.PDP_UPDATE.name(), updateFeed);
return source.start();
}
private boolean sink() {
List<TopicSink> sinks = TopicEndpoint.manager.addTopicSinks(properties);
if (sinks.isEmpty()) {
logger.error("Lifecycle Manager sinks have not been configured");
return false;
}
if (sinks.size() != 1) {
logger.warn("Lifecycle Manager: unexpected: more than one sink configured ({})", sinks.size());
}
this.client = new TopicSinkClient(sinks.get(0));
return this.client.getSink().start();
}
private List<ToscaPolicyTypeIdentifier> getCapabilities() {
List<ToscaPolicyTypeIdentifier> capabilities = new ArrayList<>();
for (DroolsController dc : DroolsController.factory.inventory()) {
if (!dc.isBrained()) {
continue;
}
for (String domain : dc.getBaseDomainNames()) {
// HACK: until legacy controllers are removed
if (StringUtils.countMatches(domain, ".") > 1) {
capabilities.add(new ToscaPolicyTypeIdentifier(domain, POLICY_TYPE_VERSION));
} else {
logger.info("legacy controller {} with domain {}", dc.getCanonicalSessionNames(), domain);
}
}
}
return capabilities;
}
protected boolean isItMe(String name, String group, String subgroup) {
if (Objects.equals(name, getName())) {
return true;
}
return name == null && group != null
&& Objects.equals(group, getGroup())
&& Objects.equals(subgroup, getSubgroup());
}
/* **** IO listeners ***** */
/**
* PDP State Change Message Listener.
*/
public static class PdpStateChangeFeed extends ScoListener<PdpStateChange> {
protected final LifecycleFsm fsm;
protected PdpStateChangeFeed(Class<PdpStateChange> clazz, LifecycleFsm fsm) {
super(clazz);
this.fsm = fsm;
}
@Override
public void onTopicEvent(CommInfrastructure comm, String topic,
StandardCoderObject coder, PdpStateChange stateChange) {
if (!isMine(stateChange)) {
logger.warn("pdp-state-chage from {}:{} is invalid: {}", comm, topic, stateChange);
return;
}
fsm.stateChange(stateChange);
}
protected boolean isMine(PdpStateChange change) {
if (change == null) {
return false;
}
return fsm.isItMe(change.getName(), change.getPdpGroup(), change.getPdpSubgroup());
}
}
/**
* PDP Update Message Listener.
*/
public static class PdpUpdateFeed extends ScoListener<PdpUpdate> {
protected final LifecycleFsm fsm;
public PdpUpdateFeed(Class<PdpUpdate> clazz, LifecycleFsm fsm) {
super(clazz);
this.fsm = fsm;
}
@Override
public void onTopicEvent(CommInfrastructure comm, String topic,
StandardCoderObject coder, PdpUpdate update) {
if (!isMine(update)) {
logger.warn("pdp-update from {}:{} is invalid: {}", comm, topic, update);
return;
}
fsm.update(update);
}
protected boolean isMine(PdpUpdate update) {
if (update == null) {
return false;
}
return fsm.isItMe(update.getName(), update.getPdpGroup(), update.getPdpSubgroup());
}
}
}
|