2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2019-2022 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
19 * SPDX-License-Identifier: Apache-2.0
20 * ============LICENSE_END=========================================================
23 package org.onap.policy.pdp.xacml.application.common.std;
25 import com.att.research.xacml.api.Advice;
26 import com.att.research.xacml.api.DataTypeException;
27 import com.att.research.xacml.api.Identifier;
28 import com.att.research.xacml.api.Obligation;
29 import com.att.research.xacml.api.Request;
30 import com.att.research.xacml.api.XACML3;
31 import com.att.research.xacml.std.annotations.RequestParser;
32 import com.google.common.base.Strings;
33 import java.util.Collection;
35 import lombok.NoArgsConstructor;
36 import oasis.names.tc.xacml._3_0.core.schema.wd_17.AnyOfType;
37 import oasis.names.tc.xacml._3_0.core.schema.wd_17.EffectType;
38 import oasis.names.tc.xacml._3_0.core.schema.wd_17.PolicyType;
39 import oasis.names.tc.xacml._3_0.core.schema.wd_17.RuleType;
40 import oasis.names.tc.xacml._3_0.core.schema.wd_17.TargetType;
41 import org.onap.policy.common.utils.coder.CoderException;
42 import org.onap.policy.common.utils.coder.StandardCoder;
43 import org.onap.policy.models.decisions.concepts.DecisionRequest;
44 import org.onap.policy.models.decisions.concepts.DecisionResponse;
45 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
46 import org.onap.policy.pdp.xacml.application.common.OnapObligation;
47 import org.onap.policy.pdp.xacml.application.common.ToscaDictionary;
48 import org.onap.policy.pdp.xacml.application.common.ToscaPolicyConversionException;
49 import org.onap.policy.pdp.xacml.application.common.ToscaPolicyTranslatorUtils;
50 import org.slf4j.Logger;
51 import org.slf4j.LoggerFactory;
54 public class StdCombinedPolicyResultsTranslator extends StdBaseTranslator {
56 private static final Logger LOGGER = LoggerFactory.getLogger(StdCombinedPolicyResultsTranslator.class);
59 public Object convertPolicy(ToscaPolicy toscaPolicy) throws ToscaPolicyConversionException {
63 if (toscaPolicy == null) {
64 throw new ToscaPolicyConversionException("Cannot convert a NULL policy");
66 if (toscaPolicy.getMetadata() == null) {
67 throw new ToscaPolicyConversionException("Cannot convert a policy with missing metadata section");
72 String policyId = toscaPolicy.getMetadata().get(POLICY_ID);
74 // Set it as the policy ID
76 var newPolicyType = new PolicyType();
77 newPolicyType.setPolicyId(policyId);
79 // Optional description
81 newPolicyType.setDescription(toscaPolicy.getDescription());
83 // There should be a metadata section
85 this.fillMetadataSection(newPolicyType, toscaPolicy.getMetadata());
87 // Set the combining rule
89 newPolicyType.setRuleCombiningAlgId(XACML3.ID_RULE_FIRST_APPLICABLE.stringValue());
91 // Generate the TargetType
93 var target = this.generateTargetType(policyId, toscaPolicy.getType(), toscaPolicy.getVersion());
94 newPolicyType.setTarget(target);
96 // Now create the Permit Rule
97 // No target since the policy has a target
100 var rule = new RuleType();
101 rule.setDescription("Default is to PERMIT if the policy matches.");
102 rule.setRuleId(policyId + ":rule");
103 rule.setEffect(EffectType.PERMIT);
104 rule.setTarget(new TargetType());
106 // Now represent the policy as Json
108 var coder = new StandardCoder();
111 jsonPolicy = coder.encode(toscaPolicy);
112 } catch (CoderException e) {
113 throw new ToscaPolicyConversionException(e);
115 addObligation(rule, policyId, jsonPolicy, null, toscaPolicy.getType());
117 // Add the rule to the policy
119 newPolicyType.getCombinerParametersOrRuleCombinerParametersOrVariableDefinition().add(rule);
121 // Return our new policy
123 return newPolicyType;
127 public Request convertRequest(DecisionRequest request) throws ToscaPolicyConversionException {
128 LOGGER.info("Converting Request {}", request);
130 return RequestParser.parseRequest(StdCombinedPolicyRequest.createInstance(request));
131 } catch (IllegalArgumentException | IllegalAccessException | DataTypeException e) {
132 throw new ToscaPolicyConversionException("Failed to parse request", e);
137 * scanObligations - scans the list of obligations and make appropriate method calls to process
140 * @param obligations Collection of obligation objects
141 * @param decisionResponse DecisionResponse object used to store any results from obligations.
144 protected void scanObligations(Collection<Obligation> obligations, DecisionResponse decisionResponse) {
145 for (Obligation obligation : obligations) {
146 Identifier obligationId = obligation.getId();
147 LOGGER.info("Obligation: {}", obligationId);
148 if (ToscaDictionary.ID_OBLIGATION_REST_BODY.equals(obligationId)) {
149 scanContentObligation(obligation, decisionResponse);
155 * scanAdvice - not implemented in this class.
157 * @param advice Collection of advice objects
158 * @param decisionResponse DecisionResponse object
161 protected void scanAdvice(Collection<Advice> advice, DecisionResponse decisionResponse) {
163 // By default there are no advice supported in this object. Please override and provide
164 // any needed functionality.
166 LOGGER.warn("Advice found - not supported in this class {}", this.getClass());
170 * scanContentObligation - scans the specific obligation for policy-id and policy-content.
172 * @param obligation Obligation incoming obligation object
173 * @param decisionResponse DecisionResponse object
175 protected void scanContentObligation(Obligation obligation, DecisionResponse decisionResponse) {
177 // Create our OnapObligation which will scan for attributes
179 var onapObligation = new OnapObligation(obligation);
181 // Get the attributes we care about
183 String policyId = onapObligation.getPolicyId();
184 Map<String, Object> policyContent = onapObligation.getPolicyContentAsMap();
186 // Sanity check that we got the attributes we care about. NOTE: This translator
187 // ensures that these are set when convertPolicy is called.
189 if (! Strings.isNullOrEmpty(policyId) && !policyContent.isEmpty()) {
190 decisionResponse.getPolicies().put(policyId, policyContent);
192 LOGGER.error("Missing obligation policyId {} or policyContent {}", policyId,
193 policyContent == null ? "null" : policyContent.size());
198 * generateTargetType - Generates a TargetType object for the policy-id and policy-type.
200 * @param policyId String policy-id
201 * @param policyType String policy type
202 * @param policyTypeVersion String policy type version
203 * @return TargetType object
205 protected TargetType generateTargetType(String policyId, String policyType, String policyTypeVersion) {
207 // Create all the match's that are possible
209 // This is for the Policy Id
211 var matchPolicyId = ToscaPolicyTranslatorUtils.buildMatchTypeDesignator(
212 XACML3.ID_FUNCTION_STRING_EQUAL,
214 XACML3.ID_DATATYPE_STRING,
215 ToscaDictionary.ID_RESOURCE_POLICY_ID,
216 XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE);
218 // This is for the Policy Type
220 var matchPolicyType = ToscaPolicyTranslatorUtils.buildMatchTypeDesignator(
221 XACML3.ID_FUNCTION_STRING_EQUAL,
223 XACML3.ID_DATATYPE_STRING,
224 ToscaDictionary.ID_RESOURCE_POLICY_TYPE,
225 XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE);
227 // This is for the Policy Type version
229 var matchPolicyTypeVersion = ToscaPolicyTranslatorUtils.buildMatchTypeDesignator(
230 XACML3.ID_FUNCTION_STRING_EQUAL,
232 XACML3.ID_DATATYPE_STRING,
233 ToscaDictionary.ID_RESOURCE_POLICY_TYPE_VERSION,
234 XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE);
236 // This is our outer AnyOf - which is an OR
238 var anyOf = new AnyOfType();
240 // Create AllOf (AND) of just Policy Id
242 anyOf.getAllOf().add(ToscaPolicyTranslatorUtils.buildAllOf(matchPolicyId));
244 // Create AllOf (AND) of just Policy Type
246 anyOf.getAllOf().add(ToscaPolicyTranslatorUtils.buildAllOf(matchPolicyType));
248 // Create AllOf (AND) of Policy Type and Policy Type Version
250 anyOf.getAllOf().add(ToscaPolicyTranslatorUtils.buildAllOf(matchPolicyType, matchPolicyTypeVersion));
252 // Now we can create the TargetType, add the top-level anyOf (OR),
253 // and return the value.
255 var target = new TargetType();
256 target.getAnyOf().add(anyOf);