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
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
|
/*
* ============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.system.internal;
import com.fasterxml.jackson.annotation.JsonIgnore;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Properties;
import java.util.stream.Collectors;
import org.onap.policy.common.endpoints.event.comm.Topic;
import org.onap.policy.common.endpoints.event.comm.TopicEndpoint;
import org.onap.policy.common.endpoints.event.comm.TopicEndpointManager;
import org.onap.policy.common.endpoints.event.comm.TopicListener;
import org.onap.policy.common.endpoints.event.comm.TopicSink;
import org.onap.policy.common.endpoints.event.comm.TopicSource;
import org.onap.policy.common.gson.annotation.GsonJsonIgnore;
import org.onap.policy.common.utils.services.FeatureApiUtils;
import org.onap.policy.drools.controller.DroolsController;
import org.onap.policy.drools.controller.DroolsControllerConstants;
import org.onap.policy.drools.controller.DroolsControllerFactory;
import org.onap.policy.drools.features.PolicyControllerFeatureApi;
import org.onap.policy.drools.features.PolicyControllerFeatureApiConstants;
import org.onap.policy.drools.persistence.SystemPersistence;
import org.onap.policy.drools.persistence.SystemPersistenceConstants;
import org.onap.policy.drools.properties.DroolsPropertyConstants;
import org.onap.policy.drools.protocol.configuration.DroolsConfiguration;
import org.onap.policy.drools.system.PolicyController;
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* This implementation of the Policy Controller merely aggregates and tracks for management purposes
* all underlying resources that this controller depends upon.
*/
public class AggregatedPolicyController implements PolicyController, TopicListener {
private static final String BEFORE_OFFER_FAILURE = "{}: feature {} before-offer failure because of {}";
private static final String AFTER_OFFER_FAILURE = "{}: feature {} after-offer failure because of {}";
/**
* Logger.
*/
private static final Logger logger = LoggerFactory.getLogger(AggregatedPolicyController.class);
/**
* identifier for this policy controller.
*/
private final String name;
/**
* Abstracted Event Sources List regardless communication technology.
*/
private final List<TopicSource> sources;
/**
* Abstracted Event Sinks List regardless communication technology.
*/
private final List<TopicSink> sinks;
/**
* Mapping topics to sinks.
*/
@JsonIgnore
@GsonJsonIgnore
private final HashMap<String, TopicSink> topic2Sinks = new HashMap<>();
/**
* Is this Policy Controller running (alive) ? reflects invocation of start()/stop() only.
*/
private volatile boolean alive;
/**
* Is this Policy Controller locked ? reflects if i/o controller related operations and start
* are permitted, more specifically: start(), deliver() and onTopicEvent(). It does not affect
* the ability to stop the underlying drools infrastructure
*/
private volatile boolean locked;
/**
* Policy Drools Controller.
*/
private volatile DroolsController droolsController;
/**
* Properties used to initialize controller.
*/
private final Properties properties;
/**
* Policy Types.
*/
private List<ToscaPolicyTypeIdentifier> policyTypes;
/**
* Constructor version mainly used for bootstrapping at initialization time a policy engine
* controller.
*
* @param name controller name
* @param properties
*
* @throws IllegalArgumentException when invalid arguments are provided
*/
public AggregatedPolicyController(String name, Properties properties) {
this.name = name;
/*
* 1. Register read topics with network infrastructure (ueb, dmaap, rest) 2. Register write
* topics with network infrastructure (ueb, dmaap, rest) 3. Register with drools
* infrastructure
*/
// Create/Reuse Readers/Writers for all event sources endpoints
this.sources = getEndpointManager().addTopicSources(properties);
this.sinks = getEndpointManager().addTopicSinks(properties);
initDrools(properties);
initSinks();
/* persist new properties */
getPersistenceManager().storeController(name, properties);
this.properties = properties;
this.policyTypes = getPolicyTypesFromProperties();
}
@Override
public List<ToscaPolicyTypeIdentifier> getPolicyTypes() {
if (!policyTypes.isEmpty()) {
return policyTypes;
}
return droolsController
.getBaseDomainNames()
.stream()
.map(d -> new ToscaPolicyTypeIdentifier(d,
DroolsPropertyConstants.DEFAULT_CONTROLLER_POLICY_TYPE_VERSION))
.collect(Collectors.toList());
}
protected List<ToscaPolicyTypeIdentifier> getPolicyTypesFromProperties() {
List<ToscaPolicyTypeIdentifier> policyTypeIds = new ArrayList<>();
String ptiPropValue = properties.getProperty(DroolsPropertyConstants.PROPERTY_CONTROLLER_POLICY_TYPES);
if (ptiPropValue == null) {
return policyTypeIds;
}
List<String> ptiPropList = new ArrayList<>(Arrays.asList(ptiPropValue.split("\\s*,\\s*")));
for (String pti : ptiPropList) {
String[] ptv = pti.split(":");
if (ptv.length == 1) {
policyTypeIds.add(new ToscaPolicyTypeIdentifier(ptv[0],
DroolsPropertyConstants.DEFAULT_CONTROLLER_POLICY_TYPE_VERSION));
} else if (ptv.length == 2) {
policyTypeIds.add(new ToscaPolicyTypeIdentifier(ptv[0], ptv[1]));
}
}
return policyTypeIds;
}
/**
* initialize drools layer.
*
* @throws IllegalArgumentException if invalid parameters are passed in
*/
private void initDrools(Properties properties) {
try {
// Register with drools infrastructure
this.droolsController = getDroolsFactory().build(properties, sources, sinks);
} catch (Exception | LinkageError e) {
logger.error("{}: cannot init-drools because of {}", this, e.getMessage(), e);
throw new IllegalArgumentException(e);
}
}
/**
* initialize sinks.
*
* @throws IllegalArgumentException if invalid parameters are passed in
*/
private void initSinks() {
this.topic2Sinks.clear();
for (TopicSink sink : sinks) {
this.topic2Sinks.put(sink.getTopic(), sink);
}
}
/**
* {@inheritDoc}.
*/
@Override
public boolean updateDrools(DroolsConfiguration newDroolsConfiguration) {
DroolsConfiguration oldDroolsConfiguration = new DroolsConfiguration(this.droolsController.getArtifactId(),
this.droolsController.getGroupId(), this.droolsController.getVersion());
if (oldDroolsConfiguration.getGroupId().equalsIgnoreCase(newDroolsConfiguration.getGroupId())
&& oldDroolsConfiguration.getArtifactId().equalsIgnoreCase(newDroolsConfiguration.getArtifactId())
&& oldDroolsConfiguration.getVersion().equalsIgnoreCase(newDroolsConfiguration.getVersion())) {
logger.warn("{}: cannot update-drools: identical configuration {} vs {}", this, oldDroolsConfiguration,
newDroolsConfiguration);
return true;
}
if (droolsController.isBrained()
&& (newDroolsConfiguration.getArtifactId() == null
|| DroolsControllerConstants.NO_ARTIFACT_ID.equals(newDroolsConfiguration.getArtifactId()))) {
DroolsControllerConstants.getFactory().destroy(this.droolsController);
}
try {
/* Drools Controller created, update initialization properties for restarts */
this.properties.setProperty(DroolsPropertyConstants.RULES_GROUPID, newDroolsConfiguration.getGroupId());
this.properties.setProperty(DroolsPropertyConstants.RULES_ARTIFACTID,
newDroolsConfiguration.getArtifactId());
this.properties.setProperty(DroolsPropertyConstants.RULES_VERSION, newDroolsConfiguration.getVersion());
getPersistenceManager().storeController(name, this.properties);
this.initDrools(this.properties);
/* set drools controller to current locked status */
if (this.isLocked()) {
this.droolsController.lock();
} else {
this.droolsController.unlock();
}
/* set drools controller to current alive status */
if (this.isAlive()) {
this.droolsController.start();
} else {
this.droolsController.stop();
}
} catch (IllegalArgumentException e) {
logger.error("{}: cannot update-drools because of {}", this, e.getMessage(), e);
return false;
}
return true;
}
/**
* {@inheritDoc}.
*/
@Override
public String getName() {
return this.name;
}
/**
* {@inheritDoc}.
*/
@Override
public boolean start() {
logger.info("{}: start", this);
if (FeatureApiUtils.apply(getProviders(),
feature -> feature.beforeStart(this),
(feature, ex) -> logger.error("{}: feature {} before-start failure because of {}", this,
feature.getClass().getName(), ex.getMessage(), ex))) {
return true;
}
if (this.isLocked()) {
throw new IllegalStateException("Policy Controller " + name + " is locked");
}
synchronized (this) {
if (this.alive) {
return true;
}
this.alive = true;
}
final boolean success = this.droolsController.start();
// register for events
for (TopicSource source : sources) {
source.register(this);
}
for (TopicSink sink : sinks) {
try {
sink.start();
} catch (Exception e) {
logger.error("{}: cannot start {} because of {}", this, sink, e.getMessage(), e);
}
}
FeatureApiUtils.apply(getProviders(),
feature -> feature.afterStart(this),
(feature, ex) -> logger.error("{}: feature {} after-start failure because of {}", this,
feature.getClass().getName(), ex.getMessage(), ex));
return success;
}
/**
* {@inheritDoc}.
*/
@Override
public boolean stop() {
logger.info("{}: stop", this);
if (FeatureApiUtils.apply(getProviders(),
feature -> feature.beforeStop(this),
(feature, ex) -> logger.error("{}: feature {} before-stop failure because of {}", this,
feature.getClass().getName(), ex.getMessage(), ex))) {
return true;
}
/* stop regardless locked state */
synchronized (this) {
if (!this.alive) {
return true;
}
this.alive = false;
}
// 1. Stop registration
for (TopicSource source : sources) {
source.unregister(this);
}
boolean success = this.droolsController.stop();
FeatureApiUtils.apply(getProviders(),
feature -> feature.afterStop(this),
(feature, ex) -> logger.error("{}: feature {} after-stop failure because of {}", this,
feature.getClass().getName(), ex.getMessage(), ex));
return success;
}
/**
* {@inheritDoc}.
*/
@Override
public void shutdown() {
logger.info("{}: shutdown", this);
if (FeatureApiUtils.apply(getProviders(),
feature -> feature.beforeShutdown(this),
(feature, ex) -> logger.error("{}: feature {} before-shutdown failure because of {}", this,
feature.getClass().getName(), ex.getMessage(), ex))) {
return;
}
this.stop();
getDroolsFactory().shutdown(this.droolsController);
FeatureApiUtils.apply(getProviders(),
feature -> feature.afterShutdown(this),
(feature, ex) -> logger.error("{}: feature {} after-shutdown failure because of {}", this,
feature.getClass().getName(), ex.getMessage(), ex));
}
/**
* {@inheritDoc}.
*/
@Override
public void halt() {
logger.info("{}: halt", this);
if (FeatureApiUtils.apply(getProviders(),
feature -> feature.beforeHalt(this),
(feature, ex) -> logger.error("{}: feature {} before-halt failure because of {}", this,
feature.getClass().getName(), ex.getMessage(), ex))) {
return;
}
this.stop();
getDroolsFactory().destroy(this.droolsController);
getPersistenceManager().deleteController(this.name);
FeatureApiUtils.apply(getProviders(),
feature -> feature.afterHalt(this),
(feature, ex) -> logger.error("{}: feature {} after-halt failure because of {}", this,
feature.getClass().getName(), ex.getMessage(), ex));
}
/**
* {@inheritDoc}.
*/
@Override
public void onTopicEvent(Topic.CommInfrastructure commType, String topic, String event) {
logger.debug("{}: raw event offered from {}:{}: {}", this, commType, topic, event);
if (skipOffer()) {
return;
}
if (FeatureApiUtils.apply(getProviders(),
feature -> feature.beforeOffer(this, commType, topic, event),
(feature, ex) -> logger.error(BEFORE_OFFER_FAILURE, this,
feature.getClass().getName(), ex.getMessage(), ex))) {
return;
}
boolean success = this.droolsController.offer(topic, event);
FeatureApiUtils.apply(getProviders(),
feature -> feature.afterOffer(this, commType, topic, event, success),
(feature, ex) -> logger.error(AFTER_OFFER_FAILURE, this,
feature.getClass().getName(), ex.getMessage(), ex));
}
@Override
public <T> boolean offer(T event) {
logger.debug("{}: event offered: {}", this, event);
if (skipOffer()) {
return true;
}
if (FeatureApiUtils.apply(getProviders(),
feature -> feature.beforeOffer(this, event),
(feature, ex) -> logger.error(BEFORE_OFFER_FAILURE, this,
feature.getClass().getName(), ex.getMessage(), ex))) {
return true;
}
boolean success = this.droolsController.offer(event);
FeatureApiUtils.apply(getProviders(),
feature -> feature.afterOffer(this, event, success),
(feature, ex) -> logger.error(AFTER_OFFER_FAILURE, this,
feature.getClass().getName(), ex.getMessage(), ex));
return success;
}
private boolean skipOffer() {
return isLocked() || !isAlive();
}
/**
* {@inheritDoc}.
*/
@Override
public boolean deliver(Topic.CommInfrastructure commType, String topic, Object event) {
logger.debug("{}: deliver event to {}:{}: {}", this, commType, topic, event);
if (FeatureApiUtils.apply(getProviders(),
feature -> feature.beforeDeliver(this, commType, topic, event),
(feature, ex) -> logger.error("{}: feature {} before-deliver failure because of {}", this,
feature.getClass().getName(), ex.getMessage(), ex))) {
return true;
}
if (topic == null || topic.isEmpty()) {
throw new IllegalArgumentException("Invalid Topic");
}
if (event == null) {
throw new IllegalArgumentException("Invalid Event");
}
if (!this.isAlive()) {
throw new IllegalStateException("Policy Engine is stopped");
}
if (this.isLocked()) {
throw new IllegalStateException("Policy Engine is locked");
}
if (!this.topic2Sinks.containsKey(topic)) {
logger.warn("{}: cannot deliver event because the sink {}:{} is not registered: {}", this, commType, topic,
event);
throw new IllegalArgumentException("Unsupported topic " + topic + " for delivery");
}
boolean success = this.droolsController.deliver(this.topic2Sinks.get(topic), event);
FeatureApiUtils.apply(getProviders(),
feature -> feature.afterDeliver(this, commType, topic, event, success),
(feature, ex) -> logger.error("{}: feature {} after-deliver failure because of {}", this,
feature.getClass().getName(), ex.getMessage(), ex));
return success;
}
/**
* {@inheritDoc}.
*/
@Override
public boolean isAlive() {
return this.alive;
}
/**
* {@inheritDoc}.
*/
@Override
public boolean lock() {
logger.info("{}: lock", this);
if (FeatureApiUtils.apply(getProviders(),
feature -> feature.beforeLock(this),
(feature, ex) -> logger.error("{}: feature {} before-lock failure because of {}", this,
feature.getClass().getName(), ex.getMessage(), ex))) {
return true;
}
synchronized (this) {
if (this.locked) {
return true;
}
this.locked = true;
}
// it does not affect associated sources/sinks, they are
// autonomous entities
boolean success = this.droolsController.lock();
FeatureApiUtils.apply(getProviders(),
feature -> feature.afterLock(this),
(feature, ex) -> logger.error("{}: feature {} after-lock failure because of {}", this,
feature.getClass().getName(), ex.getMessage(), ex));
return success;
}
/**
* {@inheritDoc}.
*/
@Override
public boolean unlock() {
logger.info("{}: unlock", this);
if (FeatureApiUtils.apply(getProviders(),
feature -> feature.beforeUnlock(this),
(feature, ex) -> logger.error("{}: feature {} before-unlock failure because of {}", this,
feature.getClass().getName(), ex.getMessage(), ex))) {
return true;
}
synchronized (this) {
if (!this.locked) {
return true;
}
this.locked = false;
}
boolean success = this.droolsController.unlock();
FeatureApiUtils.apply(getProviders(),
feature -> feature.afterUnlock(this),
(feature, ex) -> logger.error("{}: feature {} after-unlock failure because of {}", this,
feature.getClass().getName(), ex.getMessage(), ex));
return success;
}
/**
* {@inheritDoc}.
*/
@Override
public boolean isLocked() {
return this.locked;
}
/**
* {@inheritDoc}.
*/
@Override
public List<TopicSource> getTopicSources() {
return this.sources;
}
/**
* {@inheritDoc}.
*/
@Override
public List<TopicSink> getTopicSinks() {
return this.sinks;
}
/**
* {@inheritDoc}.
*/
@Override
public DroolsController getDrools() {
return this.droolsController;
}
/**
* {@inheritDoc}.
*/
@Override
@JsonIgnore
@GsonJsonIgnore
public Properties getProperties() {
return this.properties;
}
@Override
public String toString() {
return "AggregatedPolicyController [name=" + name + ", alive=" + alive
+ ", locked=" + locked + ", droolsController=" + droolsController + "]";
}
// the following methods may be overridden by junit tests
protected SystemPersistence getPersistenceManager() {
return SystemPersistenceConstants.getManager();
}
protected TopicEndpoint getEndpointManager() {
return TopicEndpointManager.getManager();
}
protected DroolsControllerFactory getDroolsFactory() {
return DroolsControllerConstants.getFactory();
}
protected List<PolicyControllerFeatureApi> getProviders() {
return PolicyControllerFeatureApiConstants.getProviders().getList();
}
}
|