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.clamp.controlloop.models.messages.dmaap.participant.ParticipantMessageType;
  35 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  36 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  37
  38 /**
  39  * This interface is used by participant implementations to use the participant intermediary.
  40  */
  41 public interface ParticipantIntermediaryApi {
  42
  43     /**
  44      * Register a listener for control loop elements that are mediated by the intermediary.
  45      *
  46      * @param controlLoopElementListener The control loop element listener to register
  47      */
  48     void registerControlLoopElementListener(ControlLoopElementListener controlLoopElementListener);
  49
  50     /**
  51      * Send participant register message to controlloop runtime.
  52      */
  53     void sendParticipantRegister();
  54
  55     /**
  56      * Send participant deregister message to controlloop runtime.
  57      */
  58     void sendParticipantDeregister();
  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     Map<UUID, ControlLoopElement> getControlLoopElements(String name, String version);
 102
 103     /**
 104      * Get ToscaServiceTemplate from the intermediary API.
 105      *
 106      * @return the control loop element
 107      */
 108     ToscaServiceTemplate getToscaServiceTemplate();
 109
 110     /**
 111      * Get control loop element from the intermediary API.
 112      *
 113      * @param id control loop element ID
 114      * @return the control loop element
 115      */
 116     ControlLoopElement getControlLoopElement(UUID id);
 117
 118     /**
 119      * Update the state of a control loop element.
 120      *
 121      * @param id the ID of the control loop element to update the state on
 122      * @param currentState the state of the control loop element
 123      * @param newState the state of the control loop element
 124      * @return ControlLoopElement updated control loop element
 125      */
 126     ControlLoopElement updateControlLoopElementState(UUID id, ControlLoopOrderedState currentState,
 127             ControlLoopState newState, ParticipantMessageType messageType);
 128
 129     /**
 130      * Update the control loop element statistics.
 131      *
 132      * @param id the ID of the control loop element to update the state on
 133      * @param elementStatistics the updated statistics
 134      */
 135     void updateControlLoopElementStatistics(UUID id, ClElementStatistics elementStatistics);
 136 }