blob: 931e8a55df9a5cb39313670d2fbc5cde3493933f (
plain)
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-2019 AT&T Intellectual Property. All rights reserved.
* Modifications Copyright (C) 2021 Nordix Foundation.
* ================================================================================
* 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.common.capabilities.Lockable;
import org.onap.policy.common.capabilities.Startable;
import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
import org.onap.policy.common.endpoints.event.comm.TopicSink;
import org.onap.policy.common.endpoints.event.comm.TopicSource;
import org.onap.policy.drools.controller.DroolsController;
import org.onap.policy.drools.protocol.configuration.DroolsConfiguration;
import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
/**
* 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.
*/
String getName();
/**
* Get the topic readers of interest for this controller.
*/
List<TopicSource> getTopicSources();
/**
* Get the topic readers of interest for this controller.
*/
List<TopicSink> getTopicSinks();
/**
* Get the Drools Controller.
*/
DroolsController getDrools();
/**
* Get Policy Types supported by this controller.
*/
List<ToscaConceptIdentifier> getPolicyTypes();
/**
* Update maven configuration.
*
* @param newDroolsConfiguration new drools configuration
* @return true if the update was successful, false otherwise
*/
boolean updateDrools(DroolsConfiguration newDroolsConfiguration);
/**
* Get the Properties.
*/
Properties getProperties();
/**
* Offer an event of type T.
*/
<T> boolean offer(T event);
/**
* Attempts delivering of a String over communication infrastructure "busType".
*
* @param busType bus type
* @param topic topic
* @param event Communication infrastructure identifier
*
* @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.
*/
boolean deliver(CommInfrastructure busType, String topic, Object event);
/**
* halts and permanently releases all resources.
*
* @throws IllegalStateException throws illegal state exception
*/
void halt();
}
|
