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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Actor
   4  * ================================================================================
   5  * Copyright (C) 2017-2018, 2020 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2019 Nordix Foundation.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.controlloop.actorserviceprovider.spi;
  23
  24 import java.util.Collection;
  25 import java.util.List;
  26 import java.util.Map;
  27 import java.util.Set;
  28 import org.onap.policy.common.capabilities.Configurable;
  29 import org.onap.policy.common.capabilities.Startable;
  30 import org.onap.policy.controlloop.actorserviceprovider.Operator;
  31
  32 /**
  33  * This is the service interface for defining an Actor used in Control Loop Operational
  34  * Policies for performing actions on runtime entities.
  35  *
  36  * @author pameladragosh
  37  *
  38  */
  39 public interface Actor extends Startable, Configurable<Map<String, Object>> {
  40
  41     /**
  42      * Gets the name of the actor.
  43      *
  44      * @return the actor name
  45      */
  46     String getName();
  47
  48     /**
  49      * Gets a particular operator.
  50      *
  51      * @param name name of the operation of interest
  52      * @return the desired operation
  53      * @throws IllegalArgumentException if no operation by the given name exists
  54      */
  55     Operator getOperator(String name);
  56
  57     /**
  58      * Gets the supported operations.
  59      *
  60      * @return the supported operations
  61      */
  62     public Collection<Operator> getOperators();
  63
  64     /**
  65      * Gets the names of the supported operations.
  66      *
  67      * @return the names of the supported operations
  68      */
  69     public Set<String> getOperationNames();
  70
  71     /**
  72      * Gets the actor sequence number. Lower numbered actors take precedence over higher
  73      * numbered actors.
  74      *
  75      * @return the actor sequence number
  76      */
  77     public int getSequenceNumber();
  78
  79
  80     // TODO old code: remove lines down to **HERE**
  81
  82     String actor();
  83
  84     List<String> recipes();
  85
  86     List<String> recipeTargets(String recipe);
  87
  88     List<String> recipePayloads(String recipe);
  89
  90     // **HERE**
  91 }