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.Map;
  26 import java.util.Set;
  27 import org.onap.policy.common.capabilities.Configurable;
  28 import org.onap.policy.common.capabilities.Startable;
  29 import org.onap.policy.controlloop.actorserviceprovider.Operator;
  30
  31 /**
  32  * This is the service interface for defining an Actor used in Control Loop Operational
  33  * Policies for performing actions on runtime entities.
  34  *
  35  * @author pameladragosh
  36  *
  37  */
  38 public interface Actor extends Startable, Configurable<Map<String, Object>> {
  39
  40     /**
  41      * Gets the name of the actor.
  42      *
  43      * @return the actor name
  44      */
  45     String getName();
  46
  47     /**
  48      * Gets a particular operator.
  49      *
  50      * @param name name of the operation of interest
  51      * @return the desired operation
  52      * @throws IllegalArgumentException if no operation by the given name exists
  53      */
  54     Operator getOperator(String name);
  55
  56     /**
  57      * Gets the supported operations.
  58      *
  59      * @return the supported operations
  60      */
  61     public Collection<Operator> getOperators();
  62
  63     /**
  64      * Gets the names of the supported operations.
  65      *
  66      * @return the names of the supported operations
  67      */
  68     public Set<String> getOperationNames();
  69
  70     /**
  71      * Gets the actor sequence number. Lower numbered actors take precedence over higher
  72      * numbered actors.
  73      *
  74      * @return the actor sequence number
  75      */
  76     public int getSequenceNumber();
  77 }