gerrit.onap Code Review - policy/clamp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.clamp.controlloop.participant.intermediary.api;
  22
  23 import java.util.List;
  24 import java.util.UUID;
  25 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ClElementStatistics;
  26 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoop;
  27 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopElement;
  28 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopOrderedState;
  29 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoops;
  30 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.Participant;
  31 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantState;
  32 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantStatistics;
  33 import org.onap.policy.clamp.controlloop.participant.intermediary.handler.ParticipantHandler;
  34 import org.onap.policy.clamp.controlloop.participant.intermediary.parameters.ParticipantIntermediaryParameters;
  35 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  36
  37 /**
  38  * This interface is used by participant implementations to use the participant intermediary.
  39  */
  40 public interface ParticipantIntermediaryApi {
  41     /**
  42      * Initialise the participant intermediary.
  43      *
  44      * @param parameters the parameters for the intermediary
  45      */
  46     void init(ParticipantIntermediaryParameters parameters);
  47
  48     /**
  49      * Close the intermediary.
  50      */
  51     void close();
  52
  53     /**
  54      * Register a listener for control loop elements that are mediated by the intermediary.
  55      *
  56      * @param controlLoopElementListener The control loop element listener to register
  57      */
  58     void registerControlLoopElementListener(ControlLoopElementListener controlLoopElementListener);
  59
  60     /**
  61      * Get participants loops from the intermediary API.
  62      *
  63      * @param name the participant name, null for all
  64      * @param version the participant version, null for all
  65      * @return the participants
  66      */
  67     List<Participant> getParticipants(String name, String version);
  68
  69     /**
  70      * Update the state of a participant.
  71      *
  72      * @param definition the definition of the participant to update the state on
  73      * @param state the state of the participant
  74      * @return the participant
  75      */
  76     Participant updateParticipantState(ToscaConceptIdentifier definition, ParticipantState state);
  77
  78     /**
  79      * Update the statistics of a participant.
  80      *
  81      * @param participantStatistics the statistics of the participant
  82      */
  83     void updateParticipantStatistics(ParticipantStatistics participantStatistics);
  84
  85     /**
  86      * Get control loops from the intermediary API.
  87      *
  88      * @param name the control loop element name, null for all
  89      * @param version the control loop element version, null for all
  90      * @return the control loop elements
  91      */
  92     ControlLoops getControlLoops(String name, String version);
  93
  94     /**
  95      * Get control loop elements from the intermediary API.
  96      *
  97      * @param name the control loop element name, null for all
  98      * @param version the control loop element version, null for all
  99      * @return the control loop elements
 100      */
 101     List<ControlLoopElement> getControlLoopElements(String name, String version);
 102
 103     /**
 104      * Update the state of a control loop.
 105      *
 106      * @param definition the ID of the control loop to update the state on
 107      * @param state the state of the control loop
 108      * @return ControlLoop updated control loop
 109      */
 110     ControlLoop updateControlLoopState(ToscaConceptIdentifier definition, ControlLoopOrderedState state);
 111
 112     /**
 113      * Update the state of a control loop element.
 114      *
 115      * @param id the ID of the control loop element to update the state on
 116      * @param state the state of the control loop element
 117      * @return ControlLoopElement updated control loop element
 118      */
 119     ControlLoopElement updateControlLoopElementState(UUID id, ControlLoopOrderedState state);
 120
 121     /**
 122      * Update the control loop element statistics.
 123      *
 124      * @param elementStatistics the updated statistics
 125      */
 126     void updateControlLoopElementStatistics(ClElementStatistics elementStatistics);
 127
 128     /**
 129      * Returns participantHandler, This will not be used in real world, but for junits,
 130      * if participantHandler is not returned, there is no way to test state change messages
 131      * without dmaap simulator.
 132      *
 133      * @return ParticipantHandler returns a participantHandler
 134      */
 135     ParticipantHandler getParticipantHandler();
 136 }