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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2023 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 automation composition element.
  42      *
  43      * @param automationCompositionId the ID of the automation composition to update the state on
  44      * @param elementId the ID of the automation composition element to update the state on
  45      * @param deployState the Deploy State of the automation composition element
  46      * @param lockState the Lock State of the automation composition element
  47      * @param stateChangeResult the indicator if error occurs
  48      * @param message the message
  49      */
  50     void updateAutomationCompositionElementState(UUID automationCompositionId, UUID elementId, DeployState deployState,
  51             LockState lockState, StateChangeResult stateChangeResult, String message);
  52
  53     /**
  54      * Get a copy of all AutomationCompositions.
  55      *
  56      * @return get all AutomationCompositions
  57      */
  58     Map<UUID, AutomationComposition> getAutomationCompositions();
  59
  60     /**
  61      * Get a copy of the AutomationComposition by automationCompositionId.
  62      *
  63      * @param automationCompositionId the ID of the automation composition to update the state on
  64      * @return get the AutomationComposition
  65      */
  66     AutomationComposition getAutomationComposition(UUID automationCompositionId);
  67
  68     /**
  69      * Get a copy of the AutomationCompositionElement by automationCompositionId and elementId.
  70      *
  71      * @param automationCompositionId the ID of the automation composition to update the state on
  72      * @param elementId the ID of the automation composition element to update the state on
  73      * @return get the AutomationCompositionElement
  74      */
  75     AutomationCompositionElement getAutomationCompositionElement(UUID automationCompositionId, UUID elementId);
  76
  77     /**
  78      * Get a copy of all AutomationCompositionElementDefinition from all primed compositions.
  79      *
  80      * @return a Map by compositionId of Maps of AutomationCompositionElement
  81      */
  82     Map<UUID, Map<ToscaConceptIdentifier, AutomationCompositionElementDefinition>> getAcElementsDefinitions();
  83
  84     /**
  85      * Get a copy of AutomationCompositionElementDefinitions of a composition.
  86      *
  87      * @param compositionId the composition id
  88      * @return a Map by element definition Id of AutomationCompositionElementDefinitions
  89      */
  90     Map<ToscaConceptIdentifier, AutomationCompositionElementDefinition> getAcElementsDefinitions(UUID compositionId);
  91
  92     /**
  93      * Get a copy of the AutomationCompositionElementDefinition by compositionId and element definition Id.
  94      *
  95      * @param compositionId the composition id
  96      * @param elementId the element definition Id
  97      * @return the AutomationCompositionElementDefinition
  98      */
  99     AutomationCompositionElementDefinition getAcElementDefinition(UUID compositionId, ToscaConceptIdentifier elementId);
 100
 101     /**
 102      * Send Automation Composition Element update Info to AC-runtime.
 103      *
 104      * @param automationCompositionId the ID of the automation composition to update the states
 105      * @param elementId the ID of the automation composition element to update the states
 106      * @param useState the use State
 107      * @param operationalState the operational State
 108      * @param outProperties the output Properties Map
 109      */
 110     void sendAcElementInfo(UUID automationCompositionId, UUID elementId, String useState, String operationalState,
 111             Map<String, Object> outProperties);
 112
 113     /**
 114      * Send Automation Composition Definition update Info to AC-runtime.
 115      *
 116      * @param compositionId the composition id
 117      * @param elementId the element definition Id
 118      * @param outProperties the output Properties Map
 119      */
 120     void sendAcDefinitionInfo(UUID compositionId, ToscaConceptIdentifier elementId, Map<String, Object> outProperties);
 121
 122     /**
 123      * Update the state of a Automation Composition Definition.
 124      *
 125      * @param compositionId the composition id
 126      * @param state the state of Automation Composition Definition
 127      * @param stateChangeResult the indicator if error occurs
 128      * @param message the message
 129      */
 130     void updateCompositionState(UUID compositionId, AcTypeState state, StateChangeResult stateChangeResult,
 131             String message);
 132 }