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
|
/*-
* ============LICENSE_START=======================================================
* ONAP - SO
* ================================================================================
* Copyright (C) 2017 - 2018 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.so.bpmn.common.validation;
import java.lang.annotation.Annotation;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
import javax.annotation.Priority;
import org.camunda.bpm.engine.delegate.DelegateExecution;
import org.javatuples.Pair;
import org.onap.so.bpmn.common.BuildingBlockExecution;
import org.onap.so.bpmn.common.DelegateExecutionImpl;
import org.onap.so.client.exception.ExceptionBuilder;
import org.reflections.Reflections;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Component;
/**
* Controls running all pre and post validation for flows.
*
* To define a validation you must make it a spring bean and implement either {@link org.onap.so.bpmn.common.validation.PreFlowValidator} or
* {@link org.onap.so.bpmn.common.validation.PostFlowValidator} your validation will automatically be
* run by this class.
*
*/
@Component
public abstract class FlowValidatorRunner<S extends FlowValidator, E extends FlowValidator> {
private static Logger logger = LoggerFactory.getLogger(FlowValidatorRunner.class);
@Autowired
protected ApplicationContext context;
@Autowired
protected ExceptionBuilder exceptionBuilder;
protected List<S> preFlowValidators;
protected List<E> postFlowValidators;
/**
* Changed to object because JUEL does not support overloaded methods
*
* @param bbName
* @param execution
* @return
*/
public boolean preValidate(String bbName, Object execution) {
return validateHelper(bbName, preFlowValidators, execution);
}
/**
* Changed to object because JUEL does not support overloaded methods
*
* @param bbName
* @param execution
* @return
*/
public boolean postValidate(String bbName, Object execution) {
return validateHelper(bbName, postFlowValidators, execution);
}
protected boolean validateHelper(String bbName, List<? extends FlowValidator> validators, Object obj) {
if (obj instanceof DelegateExecution) {
return validate(validators, bbName, new DelegateExecutionImpl((DelegateExecution)obj));
} else if (obj instanceof BuildingBlockExecution) {
return validate(validators, bbName, (BuildingBlockExecution)obj);
} else {
return false;
}
}
protected boolean validate(List<? extends FlowValidator> validators, String bbName, BuildingBlockExecution execution) {
List<Pair<String, Optional<String>>> results = runValidations(validators, bbName, execution);
if (!results.isEmpty()) {
exceptionBuilder.buildAndThrowWorkflowException(execution, 7000,
"Failed Validations:\n" + results.stream().map(item -> String.format("%s: %s", item.getValue0(), item.getValue1().get())).collect(Collectors.joining("\n")));
}
return true;
}
protected List<Pair<String, Optional<String>>> runValidations(List<? extends FlowValidator> validators, String bbName, BuildingBlockExecution execution) {
List<FlowValidator> filtered = filterValidators(validators, bbName);
List<Pair<String,Optional<String>>> results = new ArrayList<>();
filtered.forEach(item -> results.add(new Pair<>(item.getClass().getName(), item.validate(execution))));
return results.stream().filter(item -> item.getValue1().isPresent()).collect(Collectors.toList());
}
protected List<FlowValidator> filterValidators(List<? extends FlowValidator> validators, String bbName) {
return validators.stream()
.filter(item -> {
return item.shouldRunFor(bbName);
})
.sorted(Comparator.comparing(item -> {
Priority p = Optional.ofNullable(item.getClass().getAnnotation(Priority.class)).orElse(new Priority() {
public int value() {
return 1000;
}
@Override
public Class<? extends Annotation> annotationType() {
return Priority.class;
}
});
return p.value();
})).collect(Collectors.toList());
}
protected <T> List<T> buildalidatorList(Reflections reflections, Class<T> clazz) {
List<T> result = new ArrayList<>();
try {
for (Class<? extends T> klass : reflections.getSubTypesOf(clazz)) {
result.add(klass.newInstance());
}
} catch (InstantiationException | IllegalAccessException e) {
logger.error("failed to build validator list for " + clazz.getName(), e);
throw new RuntimeException(e);
}
return result;
}
protected abstract List<S> getPreFlowValidators();
protected abstract List<E> getPostFlowValidators();
}
|
