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
|
/*-
* ============LICENSE_START=======================================================
* 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.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.clamp.controlloop.participant.intermediary.api;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ClElementStatistics;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoop;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopElement;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopOrderedState;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopState;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoops;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.Participant;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantState;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantStatistics;
import org.onap.policy.clamp.controlloop.participant.intermediary.handler.ParticipantHandler;
import org.onap.policy.clamp.controlloop.participant.intermediary.parameters.ParticipantIntermediaryParameters;
import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
/**
* This interface is used by participant implementations to use the participant intermediary.
*/
public interface ParticipantIntermediaryApi {
/**
* Initialise the participant intermediary.
*
* @param parameters the parameters for the intermediary
*/
void init(ParticipantIntermediaryParameters parameters);
/**
* Close the intermediary.
*/
void close();
/**
* Register a listener for control loop elements that are mediated by the intermediary.
*
* @param controlLoopElementListener The control loop element listener to register
*/
void registerControlLoopElementListener(ControlLoopElementListener controlLoopElementListener);
/**
* Get participants loops from the intermediary API.
*
* @param name the participant name, null for all
* @param version the participant version, null for all
* @return the participants
*/
List<Participant> getParticipants(String name, String version);
/**
* Update the state of a participant.
*
* @param definition the definition of the participant to update the state on
* @param state the state of the participant
* @return the participant
*/
Participant updateParticipantState(ToscaConceptIdentifier definition, ParticipantState state);
/**
* Update the statistics of a participant.
*
* @param participantStatistics the statistics of the participant
*/
void updateParticipantStatistics(ParticipantStatistics participantStatistics);
/**
* Get control loops from the intermediary API.
*
* @param name the control loop element name, null for all
* @param version the control loop element version, null for all
* @return the control loop elements
*/
ControlLoops getControlLoops(String name, String version);
/**
* Get control loop elements from the intermediary API.
*
* @param name the control loop element name, null for all
* @param version the control loop element version, null for all
* @return the control loop elements
*/
Map<UUID, ControlLoopElement> getControlLoopElements(String name, String version);
/**
* Get control loop element from the intermediary API.
*
* @param id control loop element ID
* @return the control loop element
*/
ControlLoopElement getControlLoopElement(UUID id);
/**
* Update the state of a control loop element.
*
* @param id the ID of the control loop element to update the state on
* @param currentState the state of the control loop element
* @param newState the state of the control loop element
* @return ControlLoopElement updated control loop element
*/
ControlLoopElement updateControlLoopElementState(UUID id, ControlLoopOrderedState currentState,
ControlLoopState newState);
/**
* Update the control loop element statistics.
*
* @param id the ID of the control loop element to update the state on
* @param elementStatistics the updated statistics
*/
void updateControlLoopElementStatistics(UUID id, ClElementStatistics elementStatistics);
/**
* Return participantHandler, This will not be used in real world, but for junits,
* if participantHandler is not returned, there is no way to test state change messages
* without dmaap simulator.
*
*/
ParticipantHandler getParticipantHandler();
}
|
