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
|
/*-
* ============LICENSE_START=======================================================
* policy-core
* ================================================================================
* Copyright (C) 2017 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.openecomp.policy.drools.core;
import java.util.Properties;
import org.kie.api.runtime.KieSession;
import org.openecomp.policy.drools.utils.OrderedService;
import org.openecomp.policy.drools.utils.OrderedServiceImpl;
/**
* This interface provides a way to invoke optional features at various
* points in the code. At appropriate points in the
* application, the code iterates through this list, invoking these optional
* methods. Most of the methods here are notification only -- these tend to
* return a 'void' value. In other cases, such as 'activatePolicySession',
* may
*/
public interface FeatureAPI extends OrderedService
{
/**
* 'FeatureAPI.impl.getList()' returns an ordered list of objects
* implementing the 'FeatureAPI' interface.
*/
static public OrderedServiceImpl<FeatureAPI> impl =
new OrderedServiceImpl<FeatureAPI>(FeatureAPI.class);
/**
* This method is called during initialization at a point right after
* 'PolicyContainer' initialization has completed.
*
* @param args standard 'main' arguments, which are currently ignored
* @param configDir the relative directory containing configuration files
*/
public void globalInit(String args[], String configDir);
/**
* This method is used to create a 'KieSession' as part of a
* 'PolicyContainer'. The caller of this method will iterate over the
* implementers of this interface until one returns a non-null value.
*
* @param policyContainer the 'PolicyContainer' instance containing this
* session
* @param name the name of the KieSession (which is also the name of
* the associated PolicySession)
* @param kieBaseName the name of the 'KieBase' instance containing
* this session
* @return a new KieSession, if one was created, or 'null' if not
* (this depends on the capabilities and state of the object implementing
* this interface)
*/
public KieSession activatePolicySession
(PolicyContainer policyContainer, String name, String kieBaseName);
/**
* This method is called after 'KieSession.dispose()' is called
*
* @param policySession the 'PolicySession' object that wrapped the
* 'KieSession'
*/
public void disposeKieSession(PolicySession policySession);
/**
* This method is called after 'KieSession.destroy()' is called
*
* @param policySession the 'PolicySession' object that wrapped the
* 'KieSession'
*/
public void destroyKieSession(PolicySession policySession);
/**
* called before the Policy Engine is started
*/
public void beforeStartEngine() throws IllegalStateException;
/**
* called immediately after the Policy Engine is started
*/
public void afterStartEngine();
/**
* called before the Policy Engine is shut down
*/
public void beforeShutdownEngine();
/**
* called after the Policy Engine is shut down
*/
public void afterShutdownEngine();
/**
* called before creating a controller with name 'name'
*
* @param name name of the the controller
* @param properties configuration properties
*/
public void beforeCreateController(String name, Properties properties);
/**
* NOTE: temporary, should pass the Policy Controller already created
*
* called after creating a controller with name 'name'
*
* @param name name of the the controller
* @param properties configuration properties
*/
public void afterCreateController(String name);
/**
* NOTE: temporary, should pass the Policy Controller
*
* called before starting a controller with name 'name'
*
* @param name name of the the controller
*/
public void beforeStartController(String name);
/**
* NOTE: temporary, should pass the Policy Controller
*
* called after starting a controller with name 'name'
*
* @param name name of the the controller
*/
public void afterStartController(String name);
/**
* NOTE: this method is probably temporary
*
* @return 'true' if persistence is enabled, and 'false' if not, or if
* this feature is not related to persistence.
*/
public boolean isPersistenceEnabled();
}
|
