Use Policy Translator abstract class

Instead of applications implementing the converter, use a
protected abstract class that implements common code.

Newer applications could re-use existing application, and
shared code can be put into the base translator class.

Fixed sonar issue and changed guard xml.

Removed Converter and made translator into an implementation
class that is an object in the Application Provider.

Issue-ID: POLICY-1273
Change-Id: I9b48cbcdaf80d6d2ef19ef53e4b7cd4830e7e7b2
Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>

2 files changed, 20 insertions, 419 deletions

diff --git a/applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/application/monitoring/MonitoringPdpApplication.java b/applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/application/monitoring/MonitoringPdpApplication.java
index ab48d134..d4ffb487 100644
--- a/applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/application/monitoring/MonitoringPdpApplication.java
+++ b/applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/application/monitoring/MonitoringPdpApplication.java
@@ -22,22 +22,12 @@
 
 package org.onap.policy.xacml.pdp.application.monitoring;
 
-import com.att.research.xacml.api.AttributeAssignment;
-import com.att.research.xacml.api.DataTypeException;
-import com.att.research.xacml.api.Decision;
-import com.att.research.xacml.api.Obligation;
 import com.att.research.xacml.api.Request;
 import com.att.research.xacml.api.Response;
-import com.att.research.xacml.api.Result;
-import com.att.research.xacml.api.XACML3;
-import com.att.research.xacml.api.pdp.PDPEngine;
-import com.att.research.xacml.api.pdp.PDPException;
-import com.att.research.xacml.std.annotations.RequestParser;
 import com.att.research.xacml.util.XACMLPolicyScanner;
 import com.att.research.xacml.util.XACMLPolicyWriter;
 import com.att.research.xacml.util.XACMLProperties;
 import com.google.common.collect.Lists;
-import com.google.gson.Gson;
 
 import java.io.ByteArrayOutputStream;
 import java.io.FileInputStream;
@@ -45,40 +35,24 @@ import java.io.IOException;
 import java.io.InputStream;
 import java.nio.file.Path;
 import java.nio.file.Paths;
-import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Map.Entry;
 import java.util.Properties;
 import java.util.Set;
 
-import oasis.names.tc.xacml._3_0.core.schema.wd_17.AnyOfType;
-import oasis.names.tc.xacml._3_0.core.schema.wd_17.AttributeAssignmentExpressionType;
-import oasis.names.tc.xacml._3_0.core.schema.wd_17.AttributeValueType;
-import oasis.names.tc.xacml._3_0.core.schema.wd_17.EffectType;
-import oasis.names.tc.xacml._3_0.core.schema.wd_17.MatchType;
-import oasis.names.tc.xacml._3_0.core.schema.wd_17.ObjectFactory;
-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.PolicySetType;
 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.json.JSONObject;
 import org.onap.policy.models.decisions.concepts.DecisionRequest;
 import org.onap.policy.models.decisions.concepts.DecisionResponse;
-import org.onap.policy.pdp.xacml.application.common.ToscaDictionary;
 import org.onap.policy.pdp.xacml.application.common.ToscaPolicyConversionException;
-import org.onap.policy.pdp.xacml.application.common.ToscaPolicyConverter;
-import org.onap.policy.pdp.xacml.application.common.ToscaPolicyConverterUtils;
-import org.onap.policy.pdp.xacml.application.common.XacmlApplicationServiceProvider;
 import org.onap.policy.pdp.xacml.application.common.XacmlPolicyUtils;
+import org.onap.policy.pdp.xacml.application.common.std.StdCombinedPolicyResultsTranslator;
+import org.onap.policy.pdp.xacml.application.common.std.StdXacmlApplicationServiceProvider;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.yaml.snakeyaml.Yaml;
 
 /**
  * This is the engine class that manages the instance of the XACML PDP engine.
@@ -89,15 +63,13 @@ import org.yaml.snakeyaml.Yaml;
  * @author pameladragosh
  *
  */
-public class MonitoringPdpApplication implements ToscaPolicyConverter, XacmlApplicationServiceProvider {
+public class MonitoringPdpApplication extends StdXacmlApplicationServiceProvider {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(MonitoringPdpApplication.class);
     private static final String ONAP_MONITORING_BASE_POLICY_TYPE = "onap.Monitoring";
     private static final String ONAP_MONITORING_DERIVED_POLICY_TYPE = "onap.policies.monitoring";
 
-    private Path pathForData = null;
-    private Properties pdpProperties = null;
-    private PDPEngine pdpEngine = null;
+    private StdCombinedPolicyResultsTranslator translator = new StdCombinedPolicyResultsTranslator();
     private Map<String, String> supportedPolicyTypes = new HashMap<>();
 
     /**
@@ -121,31 +93,6 @@ public class MonitoringPdpApplication implements ToscaPolicyConverter, XacmlAppl
     }
 
     @Override
-    public synchronized void initialize(Path pathForData) {
-        //
-        // Save our path
-        //
-        this.pathForData = pathForData;
-        LOGGER.debug("New Path is {}", this.pathForData.toAbsolutePath());
-        //
-        // Look for and load the properties object
-        //
-        try {
-            pdpProperties = XacmlPolicyUtils.loadXacmlProperties(XacmlPolicyUtils.getPropertiesPath(pathForData));
-            LOGGER.debug("{}", pdpProperties);
-        } catch (IOException e) {
-            LOGGER.error("{}", e);
-        }
-        //
-        // Create an engine
-        //
-        PDPEngine newEngine = XacmlPolicyUtils.createEngine(pdpProperties);
-        if (newEngine != null) {
-            pdpEngine = newEngine;
-        }
-    }
-
-    @Override
     public synchronized List<String> supportedPolicyTypes() {
         return Lists.newArrayList(supportedPolicyTypes.keySet());
     }
@@ -167,21 +114,25 @@ public class MonitoringPdpApplication implements ToscaPolicyConverter, XacmlAppl
             //
             // Convert the policies first
             //
-            List<PolicyType> listPolicies = this.convertPolicies(toscaPolicies);
+            List<PolicyType> listPolicies = translator.scanAndConvertPolicies(toscaPolicies);
             if (listPolicies.isEmpty()) {
                 throw new ToscaPolicyConversionException("Converted 0 policies");
             }
             //
+            // Get our properties because we are going to update
+            //
+            Properties currentProperties = this.getProperties();
+            //
             // Read in our Root Policy
             //
-            Set<String> roots = XACMLProperties.getRootPolicyIDs(pdpProperties);
+            Set<String> roots = XACMLProperties.getRootPolicyIDs(currentProperties);
             if (roots.isEmpty()) {
                 throw new ToscaPolicyConversionException("There are NO root policies defined");
             }
             //
             // Really only should be one
             //
-            String rootFile = pdpProperties.getProperty(roots.iterator().next() + ".file");
+            String rootFile = currentProperties.getProperty(roots.iterator().next() + ".file");
             try (InputStream is = new FileInputStream(rootFile)) {
                 //
                 // Read the Root Policy into memory
@@ -211,7 +162,7 @@ public class MonitoringPdpApplication implements ToscaPolicyConverter, XacmlAppl
                         //
                         // Construct the filename
                         //
-                        Path refPath = XacmlPolicyUtils.constructUniquePolicyFilename(policy, pathForData);
+                        Path refPath = XacmlPolicyUtils.constructUniquePolicyFilename(policy, this.getDataPath());
                         //
                         // Write the policy to disk
                         // Maybe check for an error
@@ -220,7 +171,7 @@ public class MonitoringPdpApplication implements ToscaPolicyConverter, XacmlAppl
                         //
                         // Save it off
                         //
-                        XacmlPolicyUtils.addReferencedPolicy(pdpProperties, refPath);
+                        XacmlPolicyUtils.addReferencedPolicy(currentProperties, refPath);
                     }
                     //
                     // Save the root policy to disk
@@ -229,15 +180,12 @@ public class MonitoringPdpApplication implements ToscaPolicyConverter, XacmlAppl
                     //
                     // Write the policies to disk
                     //
-                    XacmlPolicyUtils.storeXacmlProperties(pdpProperties,
-                            XacmlPolicyUtils.getPropertiesPath(pathForData));
+                    XacmlPolicyUtils.storeXacmlProperties(currentProperties,
+                            XacmlPolicyUtils.getPropertiesPath(this.getDataPath()));
                     //
                     // Reload the engine
                     //
-                    PDPEngine newEngine = XacmlPolicyUtils.createEngine(pdpProperties);
-                    if (newEngine != null) {
-                        pdpEngine = newEngine;
-                    }
+                    this.createEngine(currentProperties);
                 } else {
                     throw new ToscaPolicyConversionException("Root policy isn't a PolicySet");
                 }
@@ -252,7 +200,7 @@ public class MonitoringPdpApplication implements ToscaPolicyConverter, XacmlAppl
         //
         // Convert to a XacmlRequest
         //
-        Request xacmlRequest = this.convertRequest(request);
+        Request xacmlRequest = translator.convertRequest(request);
         //
         // Now get a decision
         //
@@ -260,354 +208,7 @@ public class MonitoringPdpApplication implements ToscaPolicyConverter, XacmlAppl
         //
         // Convert to a DecisionResponse
         //
-        return this.convertResponse(xacmlResponse);
-    }
-
-    @Override
-    public List<PolicyType> convertPolicies(Map<String, Object> toscaObject) throws ToscaPolicyConversionException {
-        //
-        // Return the policies
-        //
-        return scanAndConvertPolicies(toscaObject);
-    }
-
-    @Override
-    public List<PolicyType> convertPolicies(InputStream isToscaPolicy) throws ToscaPolicyConversionException {
-        //
-        // Have snakeyaml parse the object
-        //
-        Yaml yaml = new Yaml();
-        Map<String, Object> toscaObject = yaml.load(isToscaPolicy);
-        //
-        // Return the policies
-        //
-        return scanAndConvertPolicies(toscaObject);
+        return translator.convertResponse(xacmlResponse);
     }
 
-    @SuppressWarnings("unchecked")
-    private List<PolicyType> scanAndConvertPolicies(Map<String, Object> toscaObject)
-            throws ToscaPolicyConversionException {
-        //
-        // Our return object
-        //
-        List<PolicyType> scannedPolicies = new ArrayList<>();
-        //
-        // Iterate each of the Policies
-        //
-        List<Object> policies = (List<Object>) toscaObject.get("policies");
-        for (Object policyObject : policies) {
-            //
-            // Get the contents
-            //
-            LOGGER.debug("Found policy {}", policyObject.getClass());
-            Map<String, Object> policyContents = (Map<String, Object>) policyObject;
-            for (Entry<String, Object> entrySet : policyContents.entrySet()) {
-                LOGGER.debug("Entry set {}", entrySet);
-                //
-                // Convert this policy
-                //
-                PolicyType policy = this.convertPolicy(entrySet);
-                try (ByteArrayOutputStream os = new ByteArrayOutputStream()) {
-                    XACMLPolicyWriter.writePolicyFile(os, policy);
-                    LOGGER.debug("{}", os);
-                } catch (IOException e) {
-                    LOGGER.error("Failed to convert {}", e);
-                }
-                //
-                // Convert and add in the new policy
-                //
-                scannedPolicies.add(policy);
-            }
-        }
-
-        return scannedPolicies;
-    }
-
-    @SuppressWarnings("unchecked")
-    private PolicyType convertPolicy(Entry<String, Object> entrySet) throws ToscaPolicyConversionException {
-        //
-        // Policy name should be at the root
-        //
-        String policyName = entrySet.getKey();
-        Map<String, Object> policyDefinition = (Map<String, Object>) entrySet.getValue();
-        //
-        // Set it as the policy ID
-        //
-        PolicyType newPolicyType = new PolicyType();
-        newPolicyType.setPolicyId(policyName);
-        //
-        // Optional description
-        //
-        if (policyDefinition.containsKey("description")) {
-            newPolicyType.setDescription(policyDefinition.get("description").toString());
-        }
-        //
-        // There should be a metadata section
-        //
-        if (! policyDefinition.containsKey("metadata")) {
-            throw new ToscaPolicyConversionException(policyName + " missing metadata section");
-        }
-        this.fillMetadataSection(newPolicyType,
-                (Map<String, Object>) policyDefinition.get("metadata"));
-        //
-        // Set the combining rule
-        //
-        newPolicyType.setRuleCombiningAlgId(XACML3.ID_RULE_FIRST_APPLICABLE.stringValue());
-        //
-        // Generate the TargetType
-        //
-        //
-        // There should be a metadata section
-        //
-        if (! policyDefinition.containsKey("type")) {
-            throw new ToscaPolicyConversionException(policyName + " missing type value");
-        }
-        if (! policyDefinition.containsKey("version")) {
-            throw new ToscaPolicyConversionException(policyName + " missing version value");
-        }
-        TargetType target = this.generateTargetType(policyName,
-                policyDefinition.get("type").toString(),
-                policyDefinition.get("version").toString());
-        newPolicyType.setTarget(target);
-        //
-        // Now create the Permit Rule
-        // No target since the policy has a target
-        // With obligations.
-        //
-        RuleType rule = new RuleType();
-        rule.setDescription("Default is to PERMIT if the policy matches.");
-        rule.setRuleId(policyName + ":rule");
-        rule.setEffect(EffectType.PERMIT);
-        rule.setTarget(new TargetType());
-        //
-        // Now represent the policy as Json
-        //
-        JSONObject jsonObligation = new JSONObject();
-        jsonObligation.put(policyName, policyDefinition);
-        addObligation(rule, jsonObligation);
-        //
-        // Add the rule to the policy
-        //
-        newPolicyType.getCombinerParametersOrRuleCombinerParametersOrVariableDefinition().add(rule);
-        //
-        // Return our new policy
-        //
-        return newPolicyType;
-    }
-
-    /**
-     * From the TOSCA metadata section, pull in values that are needed into the XACML policy.
-     *
-     * @param policy Policy Object to store the metadata
-     * @param metadata The Metadata TOSCA Map
-     * @return Same Policy Object
-     * @throws ToscaPolicyConversionException If there is something missing from the metadata
-     */
-    private PolicyType fillMetadataSection(PolicyType policy,
-            Map<String, Object> metadata) throws ToscaPolicyConversionException {
-        if (! metadata.containsKey("policy-id")) {
-            throw new ToscaPolicyConversionException(policy.getPolicyId() + " missing metadata policy-id");
-        } else {
-            //
-            // Do nothing here - the XACML PolicyId is used from TOSCA Policy Name field
-            //
-        }
-        if (! metadata.containsKey("policy-version")) {
-            throw new ToscaPolicyConversionException(policy.getPolicyId() + " missing metadata policy-version");
-        } else {
-            //
-            // Add in the Policy Version
-            //
-            policy.setVersion(metadata.get("policy-version").toString());
-        }
-        return policy;
-    }
-
-    private TargetType generateTargetType(String policyId, String policyType, String policyTypeVersion) {
-        //
-        // Create all the match's that are possible
-        //
-        // This is for the Policy Id
-        //
-        MatchType matchPolicyId = ToscaPolicyConverterUtils.buildMatchTypeDesignator(
-                XACML3.ID_FUNCTION_STRING_EQUAL,
-                policyId,
-                XACML3.ID_DATATYPE_STRING,
-                ToscaDictionary.ID_RESOURCE_POLICY_ID,
-                XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE);
-        //
-        // This is for the Policy Type
-        //
-        MatchType matchPolicyType = ToscaPolicyConverterUtils.buildMatchTypeDesignator(
-                XACML3.ID_FUNCTION_STRING_EQUAL,
-                policyType,
-                XACML3.ID_DATATYPE_STRING,
-                ToscaDictionary.ID_RESOURCE_POLICY_TYPE,
-                XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE);
-        //
-        // This is for the Policy Type version
-        //
-        MatchType matchPolicyTypeVersion = ToscaPolicyConverterUtils.buildMatchTypeDesignator(
-                XACML3.ID_FUNCTION_STRING_EQUAL,
-                policyTypeVersion,
-                XACML3.ID_DATATYPE_STRING,
-                ToscaDictionary.ID_RESOURCE_POLICY_TYPE_VERSION,
-                XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE);
-        //
-        // This is our outer AnyOf - which is an OR
-        //
-        AnyOfType anyOf = new AnyOfType();
-        //
-        // Create AllOf (AND) of just Policy Id
-        //
-        anyOf.getAllOf().add(ToscaPolicyConverterUtils.buildAllOf(matchPolicyId));
-        //
-        // Create AllOf (AND) of just Policy Type
-        //
-        anyOf.getAllOf().add(ToscaPolicyConverterUtils.buildAllOf(matchPolicyType));
-        //
-        // Create AllOf (AND) of Policy Type and Policy Type Version
-        //
-        anyOf.getAllOf().add(ToscaPolicyConverterUtils.buildAllOf(matchPolicyType, matchPolicyTypeVersion));
-        //
-        // Now we can create the TargetType, add the top-level anyOf (OR),
-        // and return the value.
-        //
-        TargetType target = new TargetType();
-        target.getAnyOf().add(anyOf);
-        return target;
-    }
-
-    private RuleType addObligation(RuleType rule, JSONObject jsonPolicy) {
-        //
-        // Convert the YAML Policy to JSON Object
-        //
-        if (LOGGER.isDebugEnabled()) {
-            LOGGER.debug("JSON DCAE Policy {}{}", System.lineSeparator(), jsonPolicy);
-        }
-        //
-        // Create an AttributeValue for it
-        //
-        AttributeValueType value = new AttributeValueType();
-        value.setDataType(ToscaDictionary.ID_OBLIGATION_POLICY_MONITORING_DATATYPE.stringValue());
-        value.getContent().add(jsonPolicy.toString());
-        //
-        // Create our AttributeAssignmentExpression where we will
-        // store the contents of the policy in JSON format.
-        //
-        AttributeAssignmentExpressionType expressionType = new AttributeAssignmentExpressionType();
-        expressionType.setAttributeId(ToscaDictionary.ID_OBLIGATION_POLICY_MONITORING_CONTENTS.stringValue());
-        ObjectFactory factory = new ObjectFactory();
-        expressionType.setExpression(factory.createAttributeValue(value));
-        //
-        // Create an ObligationExpression for it
-        //
-        ObligationExpressionType obligation = new ObligationExpressionType();
-        obligation.setFulfillOn(EffectType.PERMIT);
-        obligation.setObligationId(ToscaDictionary.ID_OBLIGATION_REST_BODY.stringValue());
-        obligation.getAttributeAssignmentExpression().add(expressionType);
-        //
-        // Now we can add it into the rule
-        //
-        ObligationExpressionsType obligations = new ObligationExpressionsType();
-        obligations.getObligationExpression().add(obligation);
-        rule.setObligationExpressions(obligations);
-        return rule;
-    }
-
-    @Override
-    public Request convertRequest(DecisionRequest request) {
-        LOGGER.debug("Converting Request {}", request);
-        try {
-            return RequestParser.parseRequest(MonitoringRequest.createInstance(request));
-        } catch (IllegalArgumentException | IllegalAccessException | DataTypeException e) {
-            LOGGER.error("Failed to convert DecisionRequest: {}", e);
-        }
-        //
-        // TODO throw exception
-        //
-        return null;
-    }
-
-    @Override
-    public DecisionResponse convertResponse(Response xacmlResponse) {
-        LOGGER.debug("Converting Response {}", xacmlResponse);
-        DecisionResponse decisionResponse = new DecisionResponse();
-        //
-        // Iterate through all the results
-        //
-        for (Result xacmlResult : xacmlResponse.getResults()) {
-            //
-            // Check the result
-            //
-            if (xacmlResult.getDecision() == Decision.PERMIT) {
-                //
-                // Setup policies
-                //
-                decisionResponse.setPolicies(new ArrayList<>());
-                //
-                // Go through obligations
-                //
-                for (Obligation obligation : xacmlResult.getObligations()) {
-                    LOGGER.debug("Obligation: {}", obligation);
-                    for (AttributeAssignment assignment : obligation.getAttributeAssignments()) {
-                        LOGGER.debug("Attribute Assignment: {}", assignment);
-                        //
-                        // We care about the content attribute
-                        //
-                        if (ToscaDictionary.ID_OBLIGATION_POLICY_MONITORING_CONTENTS
-                                .equals(assignment.getAttributeId())) {
-                            //
-                            // The contents are in Json form
-                            //
-                            Object stringContents = assignment.getAttributeValue().getValue();
-                            if (LOGGER.isDebugEnabled()) {
-                                LOGGER.debug("DCAE contents: {}{}", System.lineSeparator(), stringContents);
-                            }
-                            //
-                            // Let's parse it into a map using Gson
-                            //
-                            Gson gson = new Gson();
-                            @SuppressWarnings("unchecked")
-                            Map<String, Object> result = gson.fromJson(stringContents.toString() ,Map.class);
-                            decisionResponse.getPolicies().add(result);
-                        }
-                    }
-                }
-            } else {
-                decisionResponse.setErrorMessage("A better error message");
-            }
-        }
-
-        return decisionResponse;
-    }
-
-    /**
-     * Make a decision call.
-     *
-     * @param request Incoming request object
-     * @return Response object
-     */
-    private synchronized Response xacmlDecision(Request request) {
-        //
-        // This is what we need to return
-        //
-        Response response = null;
-        //
-        // Track some timing
-        //
-        long timeStart = System.currentTimeMillis();
-        try {
-            response = this.pdpEngine.decide(request);
-        } catch (PDPException e) {
-            LOGGER.error("Xacml PDP Engine failed {}", e);
-        } finally {
-            //
-            // Track the end of timing
-            //
-            long timeEnd = System.currentTimeMillis();
-            LOGGER.info("Elapsed Time: {}ms", (timeEnd - timeStart));
-        }
-        return response;
-    }
 }
diff --git a/applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/application/monitoring/MonitoringRequest.java b/applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/application/monitoring/MonitoringRequest.java
index f3bee71b..ce0bd3f2 100644
--- a/applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/application/monitoring/MonitoringRequest.java
+++ b/applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/application/monitoring/MonitoringRequest.java
@@ -56,14 +56,14 @@ public class MonitoringRequest {
 
         Map<String, Object> resources = decisionRequest.getResource();
         for (Entry<String, Object> entry : resources.entrySet()) {
-            if ("policy-id".contentEquals(entry.getKey())) {
+            if ("policy-id".equals(entry.getKey())) {
                 //
                 // TODO handle lists of policies
                 //
                 request.resource = entry.getValue().toString();
                 continue;
             }
-            if ("policy-type".contentEquals(entry.getKey())) {
+            if ("policy-type".equals(entry.getKey())) {
                 //
                 // TODO handle lists of policies
                 //