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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2023 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.acm.participant.intermediary.api;
  22
  23 import java.util.Map;
  24 import java.util.UUID;
  25 import org.onap.policy.clamp.models.acm.concepts.AcElementDeploy;
  26 import org.onap.policy.models.base.PfModelException;
  27
  28 /**
  29  * This interface is implemented by participant implementations to receive updates on automation composition elements.
  30  */
  31 public interface AutomationCompositionElementListener {
  32     /**
  33      * Handle a automation composition element state change.
  34      *
  35      * @param automationCompositionElementId the ID of the automation composition element
  36      * @throws PfModelException in case of a model exception
  37      */
  38     public void undeploy(UUID automationCompositionId, UUID automationCompositionElementId) throws PfModelException;
  39
  40     /**
  41      * Handle an update on a automation composition element.
  42      *
  43      * @param automationCompositionId the automationComposition Id
  44      * @param element the information on the automation composition element
  45      * @param properties properties Map
  46      * @throws PfModelException from Policy framework
  47      */
  48     public void deploy(UUID automationCompositionId, AcElementDeploy element, Map<String, Object> properties)
  49             throws PfModelException;
  50
  51     public default void lock(UUID automationCompositionId, UUID automationCompositionElementId)
  52             throws PfModelException {
  53         // default Lock Operation
  54     }
  55
  56     public default void unlock(UUID automationCompositionId, UUID automationCompositionElementId)
  57             throws PfModelException {
  58         // default Unlock Operation
  59     }
  60
  61     public default String getUseState(UUID automationCompositionId, UUID automationCompositionElementId)
  62             throws PfModelException {
  63         // default Use State
  64         return "";
  65     }
  66
  67     public default String getOperationalState(UUID automationCompositionId, UUID automationCompositionElementId)
  68             throws PfModelException {
  69         // default Operational State
  70         return "";
  71     }
  72
  73     public default Map<String, Object> getStatusProperties(UUID automationCompositionId,
  74             UUID automationCompositionElementId) throws PfModelException {
  75         // default StatusProperties
  76         return Map.of();
  77     }
  78 }