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

   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.Map;
  24 import java.util.concurrent.CompletableFuture;
  25 import org.onap.policy.common.capabilities.Configurable;
  26 import org.onap.policy.common.capabilities.Startable;
  27 import org.onap.policy.controlloop.ControlLoopOperation;
  28 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
  29
  30 /**
  31  * This is the service interface for defining an Actor operation used in Control Loop
  32  * Operational Policies for performing actions on runtime entities.
  33  */
  34 public interface Operator extends Startable, Configurable<Map<String, Object>> {
  35
  36     /**
  37      * Gets the name of the associated actor.
  38      *
  39      * @return the name of the associated actor
  40      */
  41     String getActorName();
  42
  43     /**
  44      * Gets the name of the operation.
  45      *
  46      * @return the operation name
  47      */
  48     String getName();
  49
  50     /**
  51      * Called by enforcement PDP engine to start the operation. As part of the operation,
  52      * it invokes the "start" and "complete" call-backs found within the parameters.
  53      *
  54      * @param params parameters needed to start the operation
  55      * @return a future that can be used to cancel or await the result of the operation
  56      */
  57     CompletableFuture<ControlLoopOperation> startOperation(ControlLoopOperationParams params);
  58 }