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.ControlLoopElement;
  28 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopOrderedState;
  29 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopState;
  30 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoops;
  31 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.Participant;
  32 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantState;
  33 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantStatistics;
  34 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  35
  36 /**
  37  * This interface is used by participant implementations to use the participant intermediary.
  38  */
  39 public interface ParticipantIntermediaryApi {
  40
  41     /**
  42      * Register a listener for control loop elements that are mediated by the intermediary.
  43      *
  44      * @param controlLoopElementListener The control loop element listener to register
  45      */
  46     void registerControlLoopElementListener(ControlLoopElementListener controlLoopElementListener);
  47
  48     /**
  49      * Get participants loops from the intermediary API.
  50      *
  51      * @param name the participant name, null for all
  52      * @param version the participant version, null for all
  53      * @return the participants
  54      */
  55     List<Participant> getParticipants(String name, String version);
  56
  57     /**
  58      * Update the state of a participant.
  59      *
  60      * @param definition the definition of the participant to update the state on
  61      * @param state the state of the participant
  62      * @return the participant
  63      */
  64     Participant updateParticipantState(ToscaConceptIdentifier definition, ParticipantState state);
  65
  66     /**
  67      * Update the statistics of a participant.
  68      *
  69      * @param participantStatistics the statistics of the participant
  70      */
  71     void updateParticipantStatistics(ParticipantStatistics participantStatistics);
  72
  73     /**
  74      * Get control loops from the intermediary API.
  75      *
  76      * @param name the control loop element name, null for all
  77      * @param version the control loop element version, null for all
  78      * @return the control loop elements
  79      */
  80     ControlLoops getControlLoops(String name, String version);
  81
  82     /**
  83      * Get control loop elements from the intermediary API.
  84      *
  85      * @param name the control loop element name, null for all
  86      * @param version the control loop element version, null for all
  87      * @return the control loop elements
  88      */
  89     Map<UUID, ControlLoopElement> getControlLoopElements(String name, String version);
  90
  91     /**
  92      * Get control loop element from the intermediary API.
  93      *
  94      * @param id control loop element ID
  95      * @return the control loop element
  96      */
  97     ControlLoopElement getControlLoopElement(UUID id);
  98
  99     /**
 100      * Update the state of a control loop element.
 101      *
 102      * @param id the ID of the control loop element to update the state on
 103      * @param currentState the state of the control loop element
 104      * @param newState the state of the control loop element
 105      * @return ControlLoopElement updated control loop element
 106      */
 107     ControlLoopElement updateControlLoopElementState(UUID id, ControlLoopOrderedState currentState,
 108             ControlLoopState newState);
 109
 110     /**
 111      * Update the control loop element statistics.
 112      *
 113      * @param id the ID of the control loop element to update the state on
 114      * @param elementStatistics the updated statistics
 115      */
 116     void updateControlLoopElementStatistics(UUID id, ClElementStatistics elementStatistics);
 117
 118 }