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.UUID;
  24 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopElement;
  25 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopOrderedState;
  26 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopState;
  27 import org.onap.policy.models.base.PfModelException;
  28 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  29 import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeTemplate;
  30
  31 /**
  32  * This interface is implemented by participant implementations to receive updates on control loop elements.
  33  */
  34 public interface ControlLoopElementListener {
  35     /**
  36      * Handle a control loop element state change.
  37      *
  38      * @param controlLoopElementId the ID of the control loop element
  39      * @param currentState the current state of the control loop element
  40      * @param newState the state to which the control loop element is changing to
  41      * @throws PfModelException in case of a model exception
  42      */
  43     public void controlLoopElementStateChange(ToscaConceptIdentifier controlLoopId, UUID controlLoopElementId,
  44         ControlLoopState currentState, ControlLoopOrderedState newState) throws PfModelException;
  45
  46     /**
  47      * Handle an update on a control loop element.
  48      *
  49      * @param element the information on the control loop element
  50      * @param controlLoopElementDefinition toscaNodeTemplate
  51      * @throws PfModelException from Policy framework
  52      */
  53     public void controlLoopElementUpdate(ToscaConceptIdentifier controlLoopId, ControlLoopElement element,
  54             ToscaNodeTemplate controlLoopElementDefinition) throws PfModelException;
  55
  56     /**
  57      * Handle controlLoopElement statistics.
  58      *
  59      * @param controlLoopElementId controlLoopElement id
  60      * @throws PfModelException in case of a model exception
  61      */
  62     public void handleStatistics(UUID controlLoopElementId) throws PfModelException;
  63 }