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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2024 Nordix Foundation.
   4  *  Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.clamp.acm.participant.intermediary.api;
  23
  24 import java.util.Map;
  25 import java.util.UUID;
  26 import org.onap.policy.clamp.models.acm.concepts.AcTypeState;
  27 import org.onap.policy.clamp.models.acm.concepts.AutomationComposition;
  28 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionElement;
  29 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionElementDefinition;
  30 import org.onap.policy.clamp.models.acm.concepts.DeployState;
  31 import org.onap.policy.clamp.models.acm.concepts.LockState;
  32 import org.onap.policy.clamp.models.acm.concepts.StateChangeResult;
  33 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  34
  35 /**
  36  * This interface is used by participant implementations to use the participant intermediary.
  37  */
  38 public interface ParticipantIntermediaryApi {
  39
  40     /**
  41      * Update the state of a AutomationComposition Instance Element.
  42      *
  43      * @param instance the ID of the AutomationComposition Instance to update the state on
  44      * @param elementId the ID of the AutomationComposition Instance element to update the state on
  45      * @param deployState the Deploy State of the AutomationComposition Instance element
  46      * @param lockState the Lock State of the AutomationComposition Instance element
  47      * @param stateChangeResult the indicator if error occurs
  48      * @param message the message
  49      */
  50     void updateAutomationCompositionElementState(UUID instance, UUID elementId, DeployState deployState,
  51             LockState lockState, StateChangeResult stateChangeResult, String message);
  52
  53     /**
  54      * Update the stage of a AutomationComposition Instance Element.
  55      *
  56      * @param instance the ID of the AutomationComposition Instance to update the state on
  57      * @param elementId the ID of the AutomationComposition Instance Element to update the state on
  58      * @param stateChangeResult the indicator if error occurs
  59      * @param message the message
  60      */
  61     void updateAutomationCompositionElementStage(UUID instance, UUID elementId, StateChangeResult stateChangeResult,
  62             int stage, String message);
  63
  64     /**
  65      * Get a copy of all AutomationComposition Instances.
  66      *
  67      * @return get all AutomationComposition Instances
  68      */
  69     Map<UUID, AutomationComposition> getAutomationCompositions();
  70
  71     /**
  72      * Get a copy of the AutomationComposition Instance by AutomationComposition Instance Id.
  73      *
  74      * @param instanceId the ID of the AutomationComposition Instance to update the state on
  75      * @return get the AutomationComposition Instance
  76      */
  77     AutomationComposition getAutomationComposition(UUID instanceId);
  78
  79     /**
  80      * Get a copy of the AutomationCompositionElement by AutomationComposition Instance Id and elementId.
  81      *
  82      * @param instanceId the ID of the AutomationComposition Instance to update the state on
  83      * @param elementId the ID of the AutomationComposition Instance Element to update the state on
  84      * @return get the AutomationCompositionElement
  85      */
  86     AutomationCompositionElement getAutomationCompositionElement(UUID instanceId, UUID elementId);
  87
  88     /**
  89      * Get a copy of all AutomationCompositionElementDefinition from all primed compositions.
  90      *
  91      * @return a Map by compositionId of Maps of AutomationCompositionElement
  92      */
  93     Map<UUID, Map<ToscaConceptIdentifier, AutomationCompositionElementDefinition>> getAcElementsDefinitions();
  94
  95     /**
  96      * Get a copy of AutomationCompositionElementDefinitions of a composition.
  97      *
  98      * @param compositionId the composition id
  99      * @return a Map by element definition Id of AutomationCompositionElementDefinitions
 100      */
 101     Map<ToscaConceptIdentifier, AutomationCompositionElementDefinition> getAcElementsDefinitions(UUID compositionId);
 102
 103     /**
 104      * Get a copy of the AutomationCompositionElementDefinition by compositionId and element definition Id.
 105      *
 106      * @param compositionId the composition id
 107      * @param elementId the element definition Id
 108      * @return the AutomationCompositionElementDefinition
 109      */
 110     AutomationCompositionElementDefinition getAcElementDefinition(UUID compositionId, ToscaConceptIdentifier elementId);
 111
 112     /**
 113      * Send AutomationComposition Instance Element update Info to AC-runtime.
 114      *
 115      * @param instanceId the ID of the AutomationComposition Instance to update the states
 116      * @param elementId the ID of the AutomationComposition Instance Element to update the states
 117      * @param useState the use State
 118      * @param operationalState the operational State
 119      * @param outProperties the output Properties Map
 120      */
 121     void sendAcElementInfo(UUID instanceId, UUID elementId, String useState, String operationalState,
 122             Map<String, Object> outProperties);
 123
 124     /**
 125      * Send Automation Composition Definition update Info to AC-runtime.
 126      *
 127      * @param compositionId the composition id
 128      * @param elementId the element definition Id
 129      * @param outProperties the output Properties Map
 130      */
 131     void sendAcDefinitionInfo(UUID compositionId, ToscaConceptIdentifier elementId, Map<String, Object> outProperties);
 132
 133     /**
 134      * Update the state of a Automation Composition Definition.
 135      *
 136      * @param compositionId the composition id
 137      * @param state the state of Automation Composition Definition
 138      * @param stateChangeResult the indicator if error occurs
 139      * @param message the message
 140      */
 141     void updateCompositionState(UUID compositionId, AcTypeState state, StateChangeResult stateChangeResult,
 142             String message);
 143 }