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
|
/*-
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2018-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.List;
import java.util.Properties;
import org.onap.policy.common.endpoints.event.comm.TopicSink;
import org.onap.policy.common.utils.services.OrderedService;
import org.onap.policy.drools.controller.DroolsController;
import org.onap.policy.drools.protocol.coders.TopicCoderFilterConfiguration;
/**
* Drools Controller Feature API. Hooks into the Drools Controller operations.
*/
public interface DroolsControllerFeatureApi extends OrderedService {
/**
* intercepts the instantiation of a DroolsController.
*
* @param properties controller properties
* @param groupId group id coordinate
* @param artifactId artifact id coordinate
* @param version version coordinate
* @param decoderConfigurations decoder configurations
* @param encoderConfigurations encoder configurations
*
* @return a Drools Controller or 'null' for no intercept
*/
default DroolsController beforeInstance(Properties properties,
String groupId, String artifactId, String version,
List<TopicCoderFilterConfiguration> decoderConfigurations,
List<TopicCoderFilterConfiguration> encoderConfigurations) {
return null;
}
/**
* called after a DroolsController is instantiated.
*
* @param droolsController drools controller
* @param properties controller 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(DroolsController droolsController, Properties properties) {
return false;
}
/**
* intercepts before the Drools Controller gives the Policy Container a fact to
* insert into its Policy Sessions.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean beforeInsert(DroolsController controller, Object fact) {
return false;
}
/**
* called after a fact is injected into the Policy Container.
*
* @return true if this feature intercepts and takes ownership
* of the operation preventing the invocation of
* lower priority features. False, otherwise.
*/
default boolean afterInsert(DroolsController controller, Object fact, boolean successInsert) {
return false;
}
/**
* Intercept before the Drools 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(DroolsController controller, TopicSink sink, Object fact) {
return false;
}
/**
* Called after the Drools 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(DroolsController controller, TopicSink sink, Object fact, String json,
boolean success) {
return false;
}
}
|
