blob: d555107093ad57377817e4563e49e5e8bdc92f3b (
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
/*-
* ============LICENSE_START=======================================================
* ECOMP Policy Engine
* ================================================================================
* Copyright (C) 2017 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.openecomp.policy.controlloop.policy.guard.builder;
import org.openecomp.policy.controlloop.policy.builder.BuilderException;
import org.openecomp.policy.controlloop.policy.builder.Results;
import org.openecomp.policy.controlloop.policy.guard.Constraint;
import org.openecomp.policy.controlloop.policy.guard.ControlLoopGuard;
import org.openecomp.policy.controlloop.policy.guard.Guard;
import org.openecomp.policy.controlloop.policy.guard.GuardPolicy;
import org.openecomp.policy.controlloop.policy.guard.builder.impl.ControlLoopGuardBuilderImpl;
public interface ControlLoopGuardBuilder {
/**
* Adds one or more guard policies to the Control Loop Guard
*
*
* @param policies
* @return
* @throws BuilderException
*/
public ControlLoopGuardBuilder addGuardPolicy(GuardPolicy... policies) throws BuilderException;
/**
* Removes one or more guard policies from the Control Loop Guard
*
*
* @param policies
* @return
* @throws BuilderException
*/
public ControlLoopGuardBuilder removeGuardPolicy(GuardPolicy... policies) throws BuilderException;
/**
* Removes all guard policies from the Control Loop Guard
*
*
* @param
* @return
* @throws BuilderException
*/
public ControlLoopGuardBuilder removeAllGuardPolicies() throws BuilderException;
/**
* Adds one or more time limit constraints to the guard policy
*
*
* @param id (guard policy id)
* @param constraints
* @return
* @throws BuilderException
*/
public ControlLoopGuardBuilder addLimitConstraint(String id, Constraint... constraints) throws BuilderException;
/**
* Removes one or more time limit constraints from the guard policy
*
*
* @param id (guard policy id)
* @param constraints
* @return
* @throws BuilderException
*/
public ControlLoopGuardBuilder removeLimitConstraint(String id, Constraint... constraints) throws BuilderException;
/**
* Removes all time limit constraints from the guard policy
*
*
* @param id (guard policy id)
* @return
* @throws BuilderException
*/
public ControlLoopGuardBuilder removeAllLimitConstraints(String id) throws BuilderException;
/**
* Simply return a copy of control loop guard
*
* @return ControlLoopGuard
*/
public ControlLoopGuard getControlLoopGuard();
/**
* This will compile and build the YAML specification for the Control Loop Guard. Please iterate the Results object for details.
* The Results object will contains warnings and errors. If the specification compiled successfully, you will be able to retrieve the
* YAML.
*
* @return Results
*/
public Results buildSpecification();
/**
* The Factory is used to build a ControlLoopGuardBuilder implementation.
*
*/
public static class Factory {
private Factory(){
//Do Nothing Private Constructor.
}
/**
* @param guard
* @return ControlLoopGuardBuilder object
* @throws BuilderException
*/
public static ControlLoopGuardBuilder buildControlLoopGuard (Guard guard) throws BuilderException {
return new ControlLoopGuardBuilderImpl(guard);
}
}
}
|
