blob: dfa0865951dd6576a38ec08ca1107307a009eedb (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
/*-
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=========================================================
*/
package org.onap.policy.controlloop.actorserviceprovider;
import java.util.List;
import java.util.concurrent.CompletableFuture;
/**
* This is the service interface for defining an Actor operation used in Control Loop
* Operational Policies for performing actions on runtime entities.
*/
public interface Operation {
/**
* Gets the name of the associated actor.
*
* @return the name of the associated actor
*/
String getActorName();
/**
* Gets the name of the operation.
*
* @return the operation name
*/
String getName();
/**
* Gets the names of the properties required by the operation.
*
* @return the names of the properties required by the operation
*/
List<String> getPropertyNames();
/**
* Sets a property.
*
* @param name property name
* @param value new value
*/
public void setProperty(String name, Object value);
/**
* Called by enforcement PDP engine to start the operation. As part of the operation,
* it invokes the "start" and "complete" call-backs found within the parameters.
*
* @return a future that can be used to cancel or await the result of the operation
*/
CompletableFuture<OperationOutcome> start();
}
|
