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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. 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.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.apex.service.engine.runtime;
import java.util.Collection;
import org.onap.policy.apex.model.basicmodel.concepts.ApexException;
import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
import org.onap.policy.apex.model.enginemodel.concepts.AxEngineState;
import org.onap.policy.apex.model.policymodel.concepts.AxPolicyModel;
/**
* The administration interface for Apex engine users. Apex engine implementations expose this
* interface and external users use it to manage Apex engines.
*
* @author Sajeevan Achuthan (sajeevan.achuthan@ericsson.com)
*/
public interface EngineService {
/**
* A method to attach a listener to the engine.
*
* @param listenerName a unique name for the listener
* @param listener is a callback interface to the engine.
*/
void registerActionListener(String listenerName, ApexEventListener listener);
/**
* A method to detach a listener from the engine.
*
* @param listenerName the unique name of the listener to deregister
*/
void deregisterActionListener(String listenerName);
/**
* This method gets the current runtime information for the running Apex engines.
*
* @return the engine service event interface
*/
EngineServiceEventInterface getEngineServiceEventInterface();
/**
* Gets the key of the engine service or worker.
*
* @return the key
*/
AxArtifactKey getKey();
/**
* This method gets the keys of the engines on the engine service.
*
* @return the engine keys
*/
Collection<AxArtifactKey> getEngineKeys();
/**
* The the key of the Apex model the engine service is running on.
*
* @return the Apex model key
*/
AxArtifactKey getApexModelKey();
/**
* This method updates the Apex model on Apex execution engines using a string representation of
* the model.
*
* @param engineServiceKey The key of the engine service on which to update the model
* @param apexModelString the apex model string
* @param forceFlag if true, model updates will be executed even on incompatible models
* (different model names) and versions (different model version)
* @throws ApexException on model update errors
*/
void updateModel(AxArtifactKey engineServiceKey, String apexModelString, boolean forceFlag) throws ApexException;
/**
* This method updates the Apex model on Apex execution engines using a policy model as input.
*
* @param engineServiceKey The key of the engine service on which to update the model
* @param apexModel is a policy definition model
* @param forceFlag if true, model updates will be executed even on incompatible models
* (different model names) and versions (different model version)
* @throws ApexException on model update errors
*/
void updateModel(AxArtifactKey engineServiceKey, AxPolicyModel apexModel, boolean forceFlag) throws ApexException;
/**
* Return the state of an engine service or engine.
*
* @return The engine service or engine state
*/
AxEngineState getState();
/**
* This method starts all Apex engines in the engine service.
*
* @throws ApexException on start errors
*/
void startAll() throws ApexException;
/**
* This method starts an Apex engine in the engine service.
*
* @param engineKey The key of the Apex engine to start
* @throws ApexException on start errors
*/
void start(AxArtifactKey engineKey) throws ApexException;
/**
* This method stops all Apex engines in the engine service.
*
* @throws ApexException on stop errors
*/
void stop() throws ApexException;
/**
* This method stops an Apex engine in the engine service.
*
* @param engineKey The key of the Apex engine to stop
* @throws ApexException on stop errors
*/
void stop(AxArtifactKey engineKey) throws ApexException;
/**
* This method clears and uninitializes all Apex engines in the engine service.
*
* @throws ApexException on clear errors
*/
void clear() throws ApexException;
/**
* This method clears and uninitializes an Apex engine in the engine service.
*
* @param engineKey The key of the Apex engine to clear
* @throws ApexException on clear errors
*/
void clear(AxArtifactKey engineKey) throws ApexException;
/**
* This method checks if all Apex engines in the engine service are started.
*
* <p>Note: an engine can be both not stopped and not started, for example, when it is starting or
* stopping
*
* @return true if all Apex engines in the engine service are started.
*/
boolean isStarted();
/**
* This method checks if an Apex engine in the engine service is started.
*
* <p>Note: an engine can be both not stopped and not started, for example, when it is starting or
* stopping
*
* @param engineKey The key of the Apex engine to check
* @return true if all Apex engines in the engine service are started.
*/
boolean isStarted(AxArtifactKey engineKey);
/**
* This method checks if all Apex engines in the engine service are stopped.
*
* <p>Note: an engine can be both not stopped and not started, for example, when it is starting or
* stopping
*
* @return true if all Apex engines in the engine service are stopped.
*/
boolean isStopped();
/**
* This method checks if an Apex engine in the engine service is stopped.
*
* <p>Note: an engine can be both not stopped and not started, for example, when it is starting or
* stopping
*
* @param engineKey The key of the Apex engine to check
* @return true if all Apex engines in the engine service are stopped.
*/
boolean isStopped(AxArtifactKey engineKey);
/**
* This method starts periodic event generation.
*
* @param period The period in milliseconds between periodic events
* @throws ApexException On periodic event start errors
*/
void startPeriodicEvents(long period) throws ApexException;
/**
* This method stops periodic event generation.
*
* @throws ApexException On periodic event stop errors
*/
void stopPeriodicEvents() throws ApexException;
/**
* This method gets the status of an Apex engine in the engine service.
*
* @param engineKey the engine key
* @return the engine runtime information
* @throws ApexException on status read errors
*/
String getStatus(AxArtifactKey engineKey) throws ApexException;
/**
* This method gets the runtime information of all Apex engines in the engine service.
*
* @param engineKey the engine key
* @return the engine runtime information
* @throws ApexException on runtime information read errors
*/
String getRuntimeInfo(AxArtifactKey engineKey) throws ApexException;
}
|
