models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/Operator.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.Map;
  24 import org.onap.policy.common.capabilities.Configurable;
  25 import org.onap.policy.common.capabilities.Startable;
  26 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
  27
  28 /**
  29  * This is the service interface for defining an Actor operation used in Control Loop
  30  * Operational Policies for performing actions on runtime entities.
  31  */
  32 public interface Operator extends Startable, Configurable<Map<String, Object>> {
  33
  34     /**
  35      * Gets the name of the associated actor.
  36      *
  37      * @return the name of the associated actor
  38      */
  39     String getActorName();
  40
  41     /**
  42      * Gets the name of the operation.
  43      *
  44      * @return the operation name
  45      */
  46     String getName();
  47
  48     /**
  49      * Called by enforcement PDP engine to build the operation.
  50      *
  51      * @param params parameters needed by the operation
  52      * @return a new operation
  53      */
  54     Operation buildOperation(ControlLoopOperationParams params);
  55 }