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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2019 Nordix
* ================================================================================
* 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.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.so.bpmn.infrastructure.decisionpoint.impl;
import com.google.common.base.Strings;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
import org.onap.so.bpmn.infrastructure.decisionpoint.api.ControllerContext;
import org.onap.so.bpmn.infrastructure.decisionpoint.api.ControllerRunnable;
import org.onap.so.client.exception.ExceptionBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
/**
* Abstract class of the controller execution, it should be extended for the controller execution task.
*
* @param <T> execution context type, e.g., BuildingBlockExecution or DelegateExecution
*/
public abstract class AbstractControllerExecution<T> {
/**
* parameters from the execution context.
*/
protected static final String CONTROLLER_ACTOR_PARAM = "actor";
protected static final String CONTROLLER_ACTION_PARAM = "action";
protected static final String CONTROLLER_SCOPE_PARAM = "scope";
protected static final String RESOURCE_CUSTOMIZATION_UUID_PARAM = "resource_customization_uuid";
protected static final String RESOURCE_TYPE_PARAM = "resource_type";
protected final Logger logger = LoggerFactory.getLogger(this.getClass());
@Autowired
protected List<ControllerRunnable<T>> availableControllerRunnables;
@Autowired
protected ExceptionBuilder exceptionBuilder;
/**
* Find the {@ref ControllerRunnable} instances understanding the {@ref ControllerContext}.
*
* Only one instance should be able to understand the context. if more than one or none instances found, return
* null.
*
* @param context controller context
* @return Optional of ControllerRunnable instance
*/
protected Optional<ControllerRunnable> getController(ControllerContext<T> context) {
List<ControllerRunnable<T>> satisfiedControllers = availableControllerRunnables.stream()
.filter(controllerRunnable -> controllerRunnable.understand(context)).collect(Collectors.toList());
if (logger.isDebugEnabled()) {
for (ControllerRunnable<T> satisfiedController : satisfiedControllers) {
logger.debug("{} controllerRunnable understands the context", satisfiedController.getClass().getName());
}
}
/**
* Make sure only one {@ref ControllerRunnable} instance understands the context or else return Null.
*/
if (satisfiedControllers.size() == 1) {
return Optional.of(satisfiedControllers.get(0));
} else if (satisfiedControllers.isEmpty()) {
logger.warn("Can NOT find any ControllerRunnable for context: {}", context);
} else if (satisfiedControllers.size() > 1) {
logger.warn(
"Found {} instances understanding the context: {}, please make sure only 1 instance understands it",
satisfiedControllers.size(), context);
}
return Optional.empty();
}
/**
* Build the {@ref ControllerContext} context based on execution context.
*
* @param t execution context instance, e.g., BuildingBlockExecution or DelegateExecution instance
* @return controller context instance of the execution context type
*/
protected ControllerContext<T> buildControllerContext(final T t) {
String controllerAction = getParameterFromExecution(t, CONTROLLER_ACTION_PARAM);
String controllerScope = getParameterFromExecution(t, CONTROLLER_SCOPE_PARAM);
String resourceCustomizationUuid = getParameterFromExecution(t, RESOURCE_CUSTOMIZATION_UUID_PARAM);
String controllerActor = getControllerActor(t, controllerScope, resourceCustomizationUuid, controllerAction);
ControllerContext<T> controllerContext = new ControllerContext<>();
controllerContext.setExecution(t);
controllerContext.setControllerAction(controllerAction);
controllerContext.setControllerActor(controllerActor);
controllerContext.setControllerScope(controllerScope);
return controllerContext;
}
/**
* Retrieve the controller actor.
*
* @param t execution context instance, e.g., BuildingBlockExecution or DelegateExecution instance
* @param controllerScope controller scope, e.g, pnf, vnf, vfModule
* @param resourceCustomizationUuid resource customization UUID, e.g, pnfCustomizationUuid, vnfCustomizationUuid
* @param controllerAction controller action, e.g, configAssign, configDeploy
* @return controller actor
*/
protected abstract String getControllerActor(T t, String controllerScope, String resourceCustomizationUuid,
String controllerAction);
/**
* Controller execution based on the Controller Context.
*
* @param controllerContext ControllerContext object
*/
public abstract void controllerExecute(final ControllerContext<T> controllerContext);
/**
* Retrieve the parameter value as String from the execution context.
*
* @param t execution context instance, e.g., BuildingBlockExecution or DelegateExecution instance
* @param parameterName parameter name to be retrieved
* @return String value of the parameter
*/
protected abstract String getParameterFromExecution(final T t, String parameterName);
/**
* Check whether the controller actor value is SO ref value, i.e, equals to SO-REF-DATA.
*
* @param controllerActor controller actor, e.g, SO-REF-DATA, SDNC, CDS
* @return true if the controller actor is SO-REF-DATA, else return false
*/
protected boolean isSoRefControllerActor(final String controllerActor) {
return !Strings.isNullOrEmpty(controllerActor) && controllerActor.equalsIgnoreCase("SO-REF-DATA");
}
/**
* Check whether the controller scope is PNF resource related.
*
* @param controllerScope controller scope, e.g, pnf, vnf, vfModule
* @return true if the controller scope is pnf, else return false
*/
protected boolean isPnfResourceScope(final String controllerScope) {
return ("pnf").equalsIgnoreCase(controllerScope);
}
/**
* Check whether the controller scope is SERVICE
*
* @param controllerScope controller scope, e.g, pnf, vnf, vfModule, service
* @return true if the controller scope is service, else return false
*/
protected boolean isServiceResourceScope(final String controllerScope) {
return "service".equalsIgnoreCase(controllerScope);
}
/**
* Check whether the controller scope is VNF resource related.
*
* @param controllerScope controller scope, e.g, pnf, vnf, vfModule
* @return true if the controller scope is vnf or vfModule, else return false
*/
protected boolean isVnfResourceScope(final String controllerScope) {
if (Strings.isNullOrEmpty(controllerScope)) {
return false;
}
if (controllerScope.toLowerCase().startsWith("vnf") || controllerScope.equalsIgnoreCase("vfmodule")) {
return true;
}
return false;
}
}
|
