models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/Operation.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.controlloop.actorserviceprovider;
  22
  23 import java.util.List;
  24 import java.util.concurrent.CompletableFuture;
  25
  26 /**
  27  * This is the service interface for defining an Actor operation used in Control Loop
  28  * Operational Policies for performing actions on runtime entities.
  29  */
  30 public interface Operation {
  31
  32     /**
  33      * Gets the name of the associated actor.
  34      *
  35      * @return the name of the associated actor
  36      */
  37     String getActorName();
  38
  39     /**
  40      * Gets the name of the operation.
  41      *
  42      * @return the operation name
  43      */
  44     String getName();
  45
  46     /**
  47      * Gets the names of the properties required by the operation.
  48      *
  49      * @return the names of the properties required by the operation
  50      */
  51     List<String> getPropertyNames();
  52
  53     /**
  54      * Determines if a property has been assigned for the operation.
  55      *
  56      * @param name property name
  57      * @return {@code true} if the given property has been assigned for the operation,
  58      *         {@code false} otherwise
  59      */
  60     public boolean containsProperty(String name);
  61
  62     /**
  63      * Sets a property.
  64      *
  65      * @param name property name
  66      * @param value new value
  67      */
  68     public void setProperty(String name, Object value);
  69
  70     /**
  71      * Gets a property's value.
  72      *
  73      * @param name name of the property of interest
  74      * @return the property's value, or {@code null} if it has no value
  75      */
  76     public <T> T getProperty(String name);
  77
  78     /**
  79      * Called by enforcement PDP engine to start the operation. As part of the operation,
  80      * it invokes the "start" and "complete" call-backs found within the parameters.
  81      *
  82      * @return a future that can be used to cancel or await the result of the operation
  83      */
  84     CompletableFuture<OperationOutcome> start();
  85 }