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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
|
/*-
* ============LICENSE_START=======================================================
* ONAP Policy Engine
* ================================================================================
* Copyright (C) 2017, 2019 AT&T Intellectual Property. All rights reserved.
* Modifications Copyright (C) 2019 Bell Canada
* ================================================================================
* 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.controller;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import javax.xml.bind.JAXBElement;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.AllOfType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.AnyOfType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.ApplyType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.AttributeAssignmentExpressionType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.AttributeDesignatorType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.AttributeValueType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.ObligationExpressionType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.ObligationExpressionsType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.PolicyType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.RuleType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.TargetType;
import org.onap.policy.common.logging.flexlogger.FlexLogger;
import org.onap.policy.common.logging.flexlogger.Logger;
import org.onap.policy.rest.adapter.PolicyRestAdapter;
import org.onap.portalsdk.core.controller.RestrictedBaseController;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
@RequestMapping({"/"})
public class ActionPolicyController extends RestrictedBaseController {
private static final Logger LOGGER = FlexLogger.getLogger(ActionPolicyController.class);
private static final String PERFORMER_ATTRIBUTE_ID = "performer";
private static final String DYNAMIC_RULE_ALGORITHM_FIELD_1 = "dynamicRuleAlgorithmField1";
private static final String DYNAMIC_RULE_ALGORITHM_FIELD_2 = "dynamicRuleAlgorithmField2";
private LinkedList<Integer> ruleAlgorithmTracker;
private Map<String, String> performer = new HashMap<>();
private List<Object> ruleAlgorithmList;
public ActionPolicyController() {
// Default Constructor
}
/**
* prePopulateActionPolicyData.
*
* @param policyAdapter PolicyRestAdapter
*/
public void prePopulateActionPolicyData(PolicyRestAdapter policyAdapter) {
ruleAlgorithmList = new ArrayList<>();
performer.put("PDP", "PDPAction");
performer.put("PEP", "PEPAction");
if (policyAdapter.getPolicyData() instanceof PolicyType) {
PolicyType policy = (PolicyType) policyAdapter.getPolicyData();
// 1. Set policy-name, policy-filename and description to Policy Adapter
setPolicyAdapterPolicyNameAndDesc(policyAdapter, policy);
// 2a. Get the target data under policy for Action.
TargetType target = policy.getTarget();
if (target == null) {
return;
}
// 2b. Set attributes to Policy Adapter
setPolicyAdapterAttributes(policyAdapter, target.getAnyOf());
List<Object> ruleList = policy.getCombinerParametersOrRuleCombinerParametersOrVariableDefinition();
// Under rule we have Condition and obligation.
for (Object o : ruleList) {
if (!(o instanceof RuleType)) {
continue;
}
// 3. Set rule-algorithm choices to Policy Adapter
setPolicyAdapterRuleAlgorithmschoices(policyAdapter, (RuleType) o);
// 4a. Get the Obligation data under the rule for Form elements.
ObligationExpressionsType obligations = ((RuleType) o).getObligationExpressions();
// 4b. Set action attribute-value and action-performer to Policy Adapter
setPolicyAdapterActionData(policyAdapter, obligations);
}
}
}
private void setPolicyAdapterActionData(PolicyRestAdapter policyAdapter, ObligationExpressionsType obligations) {
if (obligations == null) {
return;
}
// Under the obligationExpressions we have obligationExpression.
// NOTE: getObligationExpression() will never return NULL.
//
for (ObligationExpressionType obligation : obligations.getObligationExpression()) {
policyAdapter.setActionAttributeValue(obligation.getObligationId());
// Under the obligationExpression we have attributeAssignmentExpression.
//
// NOTE: obligation.getAttributeAssignmentExpression() will NEVER be null
// It will always return a list.
//
for (AttributeAssignmentExpressionType attributeAssignmentExpression :
obligation.getAttributeAssignmentExpression()) {
//
//
//
String attributeID = attributeAssignmentExpression.getAttributeId();
AttributeValueType attributeValue =
(AttributeValueType) attributeAssignmentExpression.getExpression().getValue();
if (!attributeID.equals(PERFORMER_ATTRIBUTE_ID)) {
continue;
}
performer.forEach((key, keyValue) -> {
if (keyValue.equals(attributeValue.getContent().get(0))) {
policyAdapter.setActionPerformer(key);
}
});
}
}
}
private void setPolicyAdapterPolicyNameAndDesc(PolicyRestAdapter policyAdapter, PolicyType policy) {
policyAdapter.setOldPolicyFileName(policyAdapter.getPolicyName());
String policyNameValue =
policyAdapter.getPolicyName().substring(policyAdapter.getPolicyName().indexOf('_') + 1);
policyAdapter.setPolicyName(policyNameValue);
String description;
try {
description = policy.getDescription().substring(0, policy.getDescription().indexOf("@CreatedBy:"));
} catch (Exception e) {
LOGGER.error("Error while collecting the description tag in ActionPolicy " + policyNameValue, e);
description = policy.getDescription();
}
policyAdapter.setPolicyDescription(description);
}
private void setPolicyAdapterRuleAlgorithmschoices(PolicyRestAdapter policyAdapter, RuleType ruleType) {
if (ruleType.getCondition() != null) {
int index = 0;
ApplyType actionApply = (ApplyType) ruleType.getCondition().getExpression().getValue();
ruleAlgorithmTracker = new LinkedList<>();
// Populating Rule Algorithms starting from compound.
prePopulateCompoundRuleAlgorithm(index, actionApply);
}
policyAdapter.setRuleAlgorithmschoices(ruleAlgorithmList);
}
private void setPolicyAdapterAttributes(PolicyRestAdapter policyAdapter, List<AnyOfType> anyOfList) {
List<Object> attributeList = new ArrayList<>();
//
// NOTE: If using xacml3 code and doing a getAnyOf(), the anyOfList will
// NEVER be null as that code will create it if it is null.
//
// Remove the null check as its impossible to cover it.
//
// under target we have AnyOFType
for (AnyOfType anyOf : anyOfList) {
// Under AntOfType we have AllOfType
//
// NOTE: This will NEVER be null as the method call in the
// previous line getAllOf() will never return a null. It
// always creates it if its empty.
//
List<AllOfType> allOfList = anyOf.getAllOf();
// Under AllOfType we have Match.
for (AllOfType allOfType : allOfList) {
//
// NOTE: allOfType.getMatch() will NEVER be null as the method
// call getMatch will always return something. If its
// not there it will create it.
//
//
// Under the match we have attributeValue and
// attributeDesignator. So,finally down to the actual attribute.
//
// Component attributes are saved under Target here we are fetching them back.
// One row is default so we are not adding dynamic component at index 0.
allOfType.getMatch().forEach(match -> {
AttributeValueType attributeValue = match.getAttributeValue();
String value = (String) attributeValue.getContent().get(0);
AttributeDesignatorType designator = match.getAttributeDesignator();
String attributeId = designator.getAttributeId();
Map<String, String> attribute = new HashMap<>();
attribute.put("key", attributeId);
attribute.put("value", value);
attributeList.add(attribute);
});
policyAdapter.setAttributes(attributeList);
}
}
}
private int prePopulateCompoundRuleAlgorithm(int index, ApplyType actionApply) {
boolean isCompoundRule = true;
List<JAXBElement<?>> jaxbActionTypes = actionApply.getExpression();
for (JAXBElement<?> jaxbElement : jaxbActionTypes) {
// If There is Attribute Value under Action Type that means we came to the final child
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("Prepopulating rule algoirthm: " + index);
}
// Check to see if Attribute Value exists, if yes then it is not a compound rule
if (jaxbElement.getValue() instanceof AttributeValueType
|| jaxbElement.getValue() instanceof AttributeDesignatorType) {
prePopulateRuleAlgorithms(index, actionApply, jaxbActionTypes);
ruleAlgorithmTracker.addLast(index);
isCompoundRule = false;
index++;
}
}
if (isCompoundRule) {
// As it's compound rule, Get the Apply types
for (JAXBElement<?> jaxbElement : jaxbActionTypes) {
ApplyType innerActionApply = (ApplyType) jaxbElement.getValue();
index = prePopulateCompoundRuleAlgorithm(index, innerActionApply);
}
// Populate combo box
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("Prepopulating Compound rule algorithm: " + index);
}
Map<String, String> rule = new HashMap<>();
for (String key : PolicyController.getDropDownMap().keySet()) {
String keyValue = PolicyController.getDropDownMap().get(key);
if (keyValue.equals(actionApply.getFunctionId())) {
rule.put("dynamicRuleAlgorithmCombo", key);
}
}
rule.put("id", "A" + (index + 1));
// Populate Key and values for Compound Rule
rule.put(DYNAMIC_RULE_ALGORITHM_FIELD_1, "A" + (ruleAlgorithmTracker.getLast() + 1));
ruleAlgorithmTracker.removeLast();
rule.put(DYNAMIC_RULE_ALGORITHM_FIELD_2, "A" + (ruleAlgorithmTracker.getLast() + 1));
ruleAlgorithmTracker.removeLast();
ruleAlgorithmTracker.addLast(index);
ruleAlgorithmList.add(rule);
index++;
}
return index;
}
private void prePopulateRuleAlgorithms(int index, ApplyType actionApply, List<JAXBElement<?>> jaxbActionTypes) {
Map<String, String> ruleMap = new HashMap<>();
ruleMap.put("id", "A" + (index + 1));
// Populate combo box
Map<String, String> dropDownMap = PolicyController.getDropDownMap();
for (Entry<String, String> entry : dropDownMap.entrySet()) {
if (entry.getValue().equals(actionApply.getFunctionId())) {
ruleMap.put("dynamicRuleAlgorithmCombo", entry.getKey());
}
}
// Populate the key and value fields
// Rule Attribute added as key
if ((jaxbActionTypes.get(0).getValue()) instanceof ApplyType) {
// Get from Attribute Designator
ApplyType innerActionApply = (ApplyType) jaxbActionTypes.get(0).getValue();
List<JAXBElement<?>> jaxbInnerActionTypes = innerActionApply.getExpression();
AttributeDesignatorType attributeDesignator =
(AttributeDesignatorType) jaxbInnerActionTypes.get(0).getValue();
ruleMap.put(DYNAMIC_RULE_ALGORITHM_FIELD_1, attributeDesignator.getAttributeId());
// Get from Attribute Value
AttributeValueType actionConditionAttributeValue = (AttributeValueType) jaxbActionTypes.get(1).getValue();
String attributeValue = (String) actionConditionAttributeValue.getContent().get(0);
ruleMap.put(DYNAMIC_RULE_ALGORITHM_FIELD_2, attributeValue);
}
// Rule Attribute added as value
else if ((jaxbActionTypes.get(0).getValue()) instanceof AttributeValueType) {
AttributeValueType actionConditionAttributeValue = (AttributeValueType) jaxbActionTypes.get(0).getValue();
String attributeValue = (String) actionConditionAttributeValue.getContent().get(0);
ruleMap.put(DYNAMIC_RULE_ALGORITHM_FIELD_2, attributeValue);
//
// This is making a BIG assumption here that there exists an innerApply. This IF
// statement was added to support JUnit code coverage. For lack of any example of what
// this policy should actually look like.
//
if (jaxbActionTypes.size() > 1) {
ApplyType innerActionApply = (ApplyType) jaxbActionTypes.get(1).getValue();
List<JAXBElement<?>> jaxbInnerActionTypes = innerActionApply.getExpression();
AttributeDesignatorType attributeDesignator =
(AttributeDesignatorType) jaxbInnerActionTypes.get(0).getValue();
ruleMap.put(DYNAMIC_RULE_ALGORITHM_FIELD_1, attributeDesignator.getAttributeId());
}
}
ruleAlgorithmList.add(ruleMap);
}
}
|