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.AutomationComposition;
  27 import org.onap.policy.clamp.models.acm.concepts.DeployState;
  28 import org.onap.policy.clamp.models.acm.concepts.LockState;
  29
  30 /**
  31  * This interface is used by participant implementations to use the participant intermediary.
  32  */
  33 public interface ParticipantIntermediaryApi {
  34
  35     /**
  36      * Register a listener for automation composition elements that are mediated by the intermediary.
  37      *
  38      * @param automationCompositionElementListener The automation composition element listener to register
  39      */
  40     void registerAutomationCompositionElementListener(
  41             AutomationCompositionElementListener automationCompositionElementListener);
  42
  43     /**
  44      * Update the state of a automation composition element.
  45      *
  46      * @param automationCompositionId the ID of the automation composition to update the state on
  47      * @param id the ID of the automation composition element to update the state on
  48      * @param deployState the Deploy State of the automation composition element
  49      * @param lockState the Lock State of the automation composition element
  50      * @param message the message
  51      */
  52     void updateAutomationCompositionElementState(UUID automationCompositionId, UUID id, DeployState deployState,
  53             LockState lockState, String message);
  54
  55     /**
  56      * Get AutomationCompositions.
  57      *
  58      * @return get all AutomationCompositions
  59      */
  60     Map<UUID, AutomationComposition> getAutomationCompositions();
  61
  62     /**
  63      * Send Automation Composition Element update Info to AC-runtime.
  64      *
  65      * @param automationCompositionId the ID of the automation composition to update the states
  66      * @param id the ID of the automation composition element to update the states
  67      * @param useState the use State
  68      * @param operationalState the operational State
  69      * @param statusProperties the status Properties Map
  70      */
  71     void sendAcElementInfo(UUID automationCompositionId, UUID id, String useState, String operationalState,
  72             Map<String, Object> statusProperties);
  73 }