2 * ============LICENSE_START=======================================================
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.onap.policy.controlloop.actorserviceprovider;
23 import java.util.List;
24 import java.util.concurrent.CompletableFuture;
27 * This is the service interface for defining an Actor operation used in Control Loop
28 * Operational Policies for performing actions on runtime entities.
30 public interface Operation {
33 * Gets the name of the associated actor.
35 * @return the name of the associated actor
37 String getActorName();
40 * Gets the name of the operation.
42 * @return the operation name
47 * Gets the names of the properties required by the operation.
49 * @return the names of the properties required by the operation
51 List<String> getPropertyNames();
54 * Determines if a property has been assigned for the operation.
56 * @param name property name
57 * @return {@code true} if the given property has been assigned for the operation,
58 * {@code false} otherwise
60 public boolean containsProperty(String name);
65 * @param name property name
66 * @param value new value
68 public void setProperty(String name, Object value);
71 * Gets a property's value.
73 * @param name name of the property of interest
74 * @return the property's value, or {@code null} if it has no value
76 public <T> T getProperty(String name);
79 * Called by enforcement PDP engine to start the operation. As part of the operation,
80 * it invokes the "start" and "complete" call-backs found within the parameters.
82 * @return a future that can be used to cancel or await the result of the operation
84 CompletableFuture<OperationOutcome> start();