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
|
/*-
* ============LICENSE_START=======================================================
* policy-management
* ================================================================================
* 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.onap.policy.drools.system;
import java.util.List;
import java.util.Properties;
import org.onap.policy.drools.controller.DroolsController;
import org.onap.policy.drools.event.comm.TopicSource;
import org.onap.policy.drools.event.comm.Topic.CommInfrastructure;
import org.onap.policy.drools.event.comm.TopicSink;
import org.onap.policy.drools.properties.Lockable;
import org.onap.policy.drools.properties.Startable;
import org.onap.policy.drools.protocol.configuration.DroolsConfiguration;
/**
* A Policy Controller is the higher level unit of control. It corresponds to
* the ncomp equivalent of a controller. It provides management of underlying
* resources associated with the policy controller, which is a) communication
* infrastructure, and b) policy-core (drools) session infrastructure
*
*/
public interface PolicyController extends Startable, Lockable {
/**
* name of this Policy Controller
*/
public String getName();
/**
* Get the topic readers of interest for this controller
*/
public List<? extends TopicSource> getTopicSources();
/**
* Get the topic readers of interest for this controller
*/
public List<? extends TopicSink> getTopicSinks();
/**
* Get the Drools Controller
*/
public DroolsController getDrools();
/**
* update maven configuration
*
* @param newDroolsConfiguration new drools configuration
* @return true if the update was successful, false otherwise
*/
public boolean updateDrools(DroolsConfiguration newDroolsConfiguration);
/**
* Get the Properties
*/
public Properties getProperties();
/**
* Attempts delivering of an String over communication
* infrastructure "busType"
*
* @param eventBus Communication infrastructure identifier
* @param topic topic
* @param event the event object to send
*
* @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(CommInfrastructure busType, String topic,
Object event)
throws IllegalArgumentException, IllegalStateException,
UnsupportedOperationException;
/**
* halts and permanently releases all resources
* @throws IllegalStateException
*/
public void halt() throws IllegalStateException;
/**
* Factory that tracks and manages Policy Controllers
*/
public static PolicyControllerFactory factory =
new IndexedPolicyControllerFactory();
}
|
