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.List;
  24 import java.util.Map;
  25 import java.util.UUID;
  26 import org.onap.policy.clamp.models.acm.concepts.AcElementDeploy;
  27 import org.onap.policy.clamp.models.acm.concepts.AcTypeState;
  28 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionElementDefinition;
  29 import org.onap.policy.clamp.models.acm.concepts.DeployState;
  30 import org.onap.policy.clamp.models.acm.concepts.LockState;
  31 import org.onap.policy.models.base.PfModelException;
  32
  33 /**
  34  * This interface is implemented by participant implementations to receive updates on automation composition elements.
  35  */
  36 public interface AutomationCompositionElementListener {
  37     /**
  38      * Handle a automation composition element state change.
  39      *
  40      * @param automationCompositionElementId the ID of the automation composition element
  41      * @throws PfModelException in case of a model exception
  42      */
  43     void undeploy(UUID automationCompositionId, UUID automationCompositionElementId) throws PfModelException;
  44
  45     /**
  46      * Handle an update on a automation composition element.
  47      *
  48      * @param automationCompositionId the automationComposition Id
  49      * @param element the information on the automation composition element
  50      * @param properties properties Map
  51      * @throws PfModelException from Policy framework
  52      */
  53     void deploy(UUID automationCompositionId, AcElementDeploy element, Map<String, Object> properties)
  54             throws PfModelException;
  55
  56     void lock(UUID automationCompositionId, UUID automationCompositionElementId) throws PfModelException;
  57
  58     void unlock(UUID automationCompositionId, UUID automationCompositionElementId) throws PfModelException;
  59
  60     void delete(UUID automationCompositionId, UUID automationCompositionElementId) throws PfModelException;
  61
  62     void update(UUID automationCompositionId, AcElementDeploy element, Map<String, Object> properties)
  63             throws PfModelException;
  64
  65     void prime(UUID compositionId, List<AutomationCompositionElementDefinition> elementDefinitionList)
  66             throws PfModelException;
  67
  68     void deprime(UUID compositionId) throws PfModelException;
  69
  70     void handleRestartComposition(UUID compositionId,
  71             List<AutomationCompositionElementDefinition> elementDefinitionList, AcTypeState state)
  72             throws PfModelException;
  73
  74     void handleRestartInstance(UUID automationCompositionId, AcElementDeploy element, Map<String, Object> properties,
  75             DeployState deployState, LockState lockState) throws PfModelException;
  76
  77     void migrate(UUID instanceId, AcElementDeploy element, UUID compositionTargetId, Map<String, Object> properties)
  78             throws PfModelException;
  79 }