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.Map;
  25 import java.util.UUID;
  26 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ClElementStatistics;
  27 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoop;
  28 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopElement;
  29 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopOrderedState;
  30 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopState;
  31 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoops;
  32 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.Participant;
  33 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantState;
  34 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantStatistics;
  35 import org.onap.policy.clamp.controlloop.participant.intermediary.handler.ParticipantHandler;
  36 import org.onap.policy.clamp.controlloop.participant.intermediary.parameters.ParticipantIntermediaryParameters;
  37 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  38
  39 /**
  40  * This interface is used by participant implementations to use the participant intermediary.
  41  */
  42 public interface ParticipantIntermediaryApi {
  43     /**
  44      * Initialise the participant intermediary.
  45      *
  46      * @param parameters the parameters for the intermediary
  47      */
  48     void init(ParticipantIntermediaryParameters parameters);
  49
  50     /**
  51      * Close the intermediary.
  52      */
  53     void close();
  54
  55     /**
  56      * Register a listener for control loop elements that are mediated by the intermediary.
  57      *
  58      * @param controlLoopElementListener The control loop element listener to register
  59      */
  60     void registerControlLoopElementListener(ControlLoopElementListener controlLoopElementListener);
  61
  62     /**
  63      * Get participants loops from the intermediary API.
  64      *
  65      * @param name the participant name, null for all
  66      * @param version the participant version, null for all
  67      * @return the participants
  68      */
  69     List<Participant> getParticipants(String name, String version);
  70
  71     /**
  72      * Update the state of a participant.
  73      *
  74      * @param definition the definition of the participant to update the state on
  75      * @param state the state of the participant
  76      * @return the participant
  77      */
  78     Participant updateParticipantState(ToscaConceptIdentifier definition, ParticipantState state);
  79
  80     /**
  81      * Update the statistics of a participant.
  82      *
  83      * @param participantStatistics the statistics of the participant
  84      */
  85     void updateParticipantStatistics(ParticipantStatistics participantStatistics);
  86
  87     /**
  88      * Get control loops from the intermediary API.
  89      *
  90      * @param name the control loop element name, null for all
  91      * @param version the control loop element version, null for all
  92      * @return the control loop elements
  93      */
  94     ControlLoops getControlLoops(String name, String version);
  95
  96     /**
  97      * Get control loop elements from the intermediary API.
  98      *
  99      * @param name the control loop element name, null for all
 100      * @param version the control loop element version, null for all
 101      * @return the control loop elements
 102      */
 103     Map<UUID, ControlLoopElement> getControlLoopElements(String name, String version);
 104
 105     /**
 106      * Get control loop element from the intermediary API.
 107      *
 108      * @param id control loop element ID
 109      * @return the control loop element
 110      */
 111     ControlLoopElement getControlLoopElement(UUID id);
 112
 113     /**
 114      * Update the state of a control loop element.
 115      *
 116      * @param id the ID of the control loop element to update the state on
 117      * @param currentState the state of the control loop element
 118      * @param newState the state of the control loop element
 119      * @return ControlLoopElement updated control loop element
 120      */
 121     ControlLoopElement updateControlLoopElementState(UUID id, ControlLoopOrderedState currentState,
 122             ControlLoopState newState);
 123
 124     /**
 125      * Update the control loop element statistics.
 126      *
 127      * @param id the ID of the control loop element to update the state on
 128      * @param elementStatistics the updated statistics
 129      */
 130     void updateControlLoopElementStatistics(UUID id, ClElementStatistics elementStatistics);
 131
 132     /**
 133      * Return participantHandler, This will not be used in real world, but for junits,
 134      * if participantHandler is not returned, there is no way to test state change messages
 135      * without dmaap simulator.
 136      *
 137      */
 138     ParticipantHandler getParticipantHandler();
 139 }