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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2025 OpenInfra Foundation Europe. All rights reserved.
   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 an 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 an 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 instanceId.
  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 instanceId 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 an InstanceElementDto by AutomationComposition instanceId and elementId.
  90      *
  91      * @param instanceId the ID of the AutomationComposition Instance to update the state on
  92      * @param elementId the ID of the AutomationComposition Instance Element to update the state on
  93      * @return get the InstanceElementDto
  94      */
  95     InstanceElementDto getInstanceElementDto(UUID instanceId, UUID elementId);
  96
  97     /**
  98      * Get a copy of all AutomationCompositionElementDefinition from all primed compositions.
  99      *
 100      * @return a Map by compositionId of Maps of AutomationCompositionElement
 101      */
 102     Map<UUID, Map<ToscaConceptIdentifier, AutomationCompositionElementDefinition>> getAcElementsDefinitions();
 103
 104     /**
 105      * Get a copy of AutomationCompositionElementDefinitions of a composition.
 106      *
 107      * @param compositionId the composition id
 108      * @return a Map by element definition id of AutomationCompositionElementDefinitions
 109      */
 110     Map<ToscaConceptIdentifier, AutomationCompositionElementDefinition> getAcElementsDefinitions(UUID compositionId);
 111
 112     /**
 113      * Get a copy of the AutomationCompositionElementDefinition by compositionId and element definition id.
 114      *
 115      * @param compositionId the composition id
 116      * @param elementId the element definition id
 117      * @return the AutomationCompositionElementDefinition
 118      */
 119     AutomationCompositionElementDefinition getAcElementDefinition(UUID compositionId, ToscaConceptIdentifier elementId);
 120
 121     /**
 122      * Get a CompositionElementDto by compositionId and element definition id.
 123      *
 124      * @param compositionId the composition id
 125      * @param elementId the element definition id
 126      * @return the AutomationCompositionElementDefinition
 127      */
 128     CompositionElementDto getCompositionElementDto(UUID compositionId, ToscaConceptIdentifier elementId);
 129
 130     /**
 131      * Send AutomationComposition Instance Element update Info to AC-runtime.
 132      *
 133      * @param instanceId the ID of the AutomationComposition Instance to update the states
 134      * @param elementId the ID of the AutomationComposition Instance Element to update the states
 135      * @param useState the use State
 136      * @param operationalState the operational State
 137      * @param outProperties the output Properties Map
 138      */
 139     void sendAcElementInfo(UUID instanceId, UUID elementId, String useState, String operationalState,
 140             Map<String, Object> outProperties);
 141
 142     /**
 143      * Send Automation Composition Definition update Info to AC-runtime.
 144      *
 145      * @param compositionId the composition id
 146      * @param elementId the element definition id
 147      * @param outProperties the output Properties Map
 148      */
 149     void sendAcDefinitionInfo(UUID compositionId, ToscaConceptIdentifier elementId, Map<String, Object> outProperties);
 150
 151     /**
 152      * Update the state of an Automation Composition Definition.
 153      *
 154      * @param compositionId the composition id
 155      * @param state the state of Automation Composition Definition
 156      * @param stateChangeResult the indicator if error occurs
 157      * @param message the message
 158      */
 159     void updateCompositionState(UUID compositionId, AcTypeState state, StateChangeResult stateChangeResult,
 160             String message);
 161 }