2 * ============LICENSE_START=======================================================
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
22 package org.onap.policy.controlloop.actorserviceprovider.spi;
24 import java.util.Collection;
27 import org.onap.policy.common.capabilities.Configurable;
28 import org.onap.policy.common.capabilities.Startable;
29 import org.onap.policy.controlloop.actorserviceprovider.Operator;
32 * This is the service interface for defining an Actor used in Control Loop Operational
33 * Policies for performing actions on runtime entities.
35 * @author pameladragosh
38 public interface Actor extends Startable, Configurable<Map<String, Object>> {
41 * Gets the name of the actor.
43 * @return the actor name
48 * Gets a particular operator.
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
54 Operator getOperator(String name);
57 * Gets the supported operations.
59 * @return the supported operations
61 public Collection<Operator> getOperators();
64 * Gets the names of the supported operations.
66 * @return the names of the supported operations
68 public Set<String> getOperationNames();
71 * Gets the actor sequence number. Lower numbered actors take precedence over higher
74 * @return the actor sequence number
76 public int getSequenceNumber();