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
|
/*
* ============LICENSE_START=======================================================
* policy-management
* ================================================================================
* Copyright (C) 2017-2018 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.controller;
import java.util.List;
import java.util.Map;
import org.onap.policy.common.capabilities.Lockable;
import org.onap.policy.common.capabilities.Startable;
import org.onap.policy.common.endpoints.event.comm.TopicSink;
import org.onap.policy.drools.core.PolicyContainer;
import org.onap.policy.drools.protocol.coders.TopicCoderFilterConfiguration;
/**
* Drools Controller is the abstractions that wraps the drools layer (policy-core).
*/
public interface DroolsController extends Startable, Lockable {
/**
* No Group ID identifier.
*/
public static final String NO_GROUP_ID = "NO-GROUP-ID";
/**
* No Artifact ID identifier.
*/
public static final String NO_ARTIFACT_ID = "NO-ARTIFACT-ID";
/**
* No version identifier.
*/
public static final String NO_VERSION = "NO-VERSION";
/**
* Factory to track and manage drools controllers.
*/
public static final DroolsControllerFactory factory = new IndexedDroolsControllerFactory();
/**
* get group id.
*
* @return group id
*/
public String getGroupId();
/**
* get artifact id.
*
* @return artifact id
*/
public String getArtifactId();
/**
* get version.
*
* @return version
*/
public String getVersion();
/**
* return the policy session names.
*
* @return policy session
*/
public List<String> getSessionNames();
/**
* return the policy full session names.
*
* @return policy session
*/
public List<String> getCanonicalSessionNames();
/**
* offers an event to this controller for processing.
*
* @param topic topic associated with the event
* @param event the event
*
* @return true if the operation was successful
*/
public boolean offer(String topic, String event);
/**
* delivers "event" to "sink".
*
* @param sink destination
* @param event event
* @return true if successful, false if a failure has occurred.
* @throws IllegalArgumentException when invalid or insufficient properties are provided
* @throws IllegalStateException when the engine is in a state where this operation is not
* permitted (ie. locked or stopped).
* @throws UnsupportedOperationException when the engine cannot deliver due to the functionality
* missing (ie. communication infrastructure not supported.
*/
public boolean deliver(TopicSink sink, Object event);
/**
* Get recent source events.
*
* @return the most recent received events.
*/
public Object[] getRecentSourceEvents();
/**
* Get recent sink events.
*
* @return the most recent delivered events
*/
public String[] getRecentSinkEvents();
/**
* Get container.
*
* @return the underlying policy container
*/
public PolicyContainer getContainer();
/**
* Does it owns the coder.
*
* @param coderClass the encoder object
* @param modelHash the hash for the model
* @return true it owns it
*/
public boolean ownsCoder(Class<? extends Object> coderClass, int modelHash);
/**
* fetches a class from the model.
*
* @param className the class to fetch
* @return the actual class object, or null if not found
*/
public Class<?> fetchModelClass(String className);
/**
* is this controller Smart.
*/
public boolean isBrained();
/**
* update the new version of the maven jar rules file.
*
* @param newGroupId - new group id
* @param newArtifactId - new artifact id
* @param newVersion - new version
* @param decoderConfigurations - decoder configurations
* @param encoderConfigurations - encoder configurations
*
* @throws Exception from within drools libraries
* @throws LinkageError from within drools libraries
*/
public void updateToVersion(String newGroupId, String newArtifactId, String newVersion,
List<TopicCoderFilterConfiguration> decoderConfigurations,
List<TopicCoderFilterConfiguration> encoderConfigurations) throws LinkageError;
/**
* gets the classnames of facts as well as the current count.
*
* @param sessionName the session name
* @return map of class to count
*/
public Map<String, Integer> factClassNames(String sessionName);
/**
* gets the count of facts for a given session.
*
* @param sessionName the session name
* @return the fact count
*/
public long factCount(String sessionName);
/**
* gets all the facts of a given class for a given session.
*
* @param sessionName the session identifier
* @param className the class type
* @param delete retract from drools the results of the query?
* @return the list of facts returned by the query
*/
public List<Object> facts(String sessionName, String className, boolean delete);
/**
* gets the facts associated with a query for a give session for a given queried entity.
*
* @param sessionName the session
* @param queryName the query identifier
* @param queriedEntity the queried entity
* @param delete retract from drools the results of the query?
* @param queryParams query parameters
* @return list of facts returned by the query
*/
public List<Object> factQuery(String sessionName, String queryName, String queriedEntity, boolean delete,
Object... queryParams);
/**
* halts and permanently releases all resources.
*
*/
public void halt();
}
|
