controlloop/m2/base/src/main/java/org/onap/policy/m2/base/Actor.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * m2/base
   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.m2.base;
  22
  23 import org.onap.policy.controlloop.ControlLoopEvent;
  24 import org.onap.policy.controlloop.policy.Policy;
  25
  26 /**
  27  * This is the 'Actor' interface -- objects implementing this interface
  28  * are placed within the 'nameToActor' table within class 'Transaction'.
  29  * All of the instances are created and inserted in the table at initialization
  30  * time, and are located using the 'Policy.actor' field as a key.
  31  */
  32 public interface Actor {
  33     /**
  34      * Return the name associated with this Actor.
  35      *
  36      * @return the name associated with this Actor (as it appears in the 'yaml')
  37      */
  38     String getName();
  39
  40     /**
  41      * Create an operation for this actor, based on the supplied policy.
  42      *
  43      * @param transaction the transaction the operation is running under
  44      * @param policy the policy associated with this operation
  45      * @param onset the initial onset event that triggered the transaction
  46      * @param attempt this value starts at 1, and is incremented for each retry
  47      * @return the Operation instance
  48      */
  49     Operation createOperation(
  50         Transaction transaction, Policy policy, ControlLoopEvent onset,
  51         int attempt);
  52 }