aboutsummaryrefslogtreecommitdiffstats
path: root/applications/common/src
diff options
context:
space:
mode:
Diffstat (limited to 'applications/common/src')
-rw-r--r--applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/OnapPolicyFinderFactory.java38
-rw-r--r--applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/OnapPolicyFinderFactoryException.java48
-rw-r--r--applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/ToscaDictionary.java7
-rw-r--r--applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/ToscaPolicyConverter.java10
-rw-r--r--applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/XacmlApplicationServiceProvider.java12
-rw-r--r--applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/XacmlPolicyUtils.java338
-rw-r--r--applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/XacmlUpdatePolicyUtils.java88
-rw-r--r--applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/OnapPolicyFinderFactoryExceptionTest.java35
-rw-r--r--applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/OnapPolicyFinderFactoryTest.java38
-rw-r--r--applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/XacmlPolicyUtilsTest.java (renamed from applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/XacmlUpdatePolicyUtilsTest.java)162
10 files changed, 588 insertions, 188 deletions
diff --git a/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/OnapPolicyFinderFactory.java b/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/OnapPolicyFinderFactory.java
index 1e47c5b5..7da455c0 100644
--- a/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/OnapPolicyFinderFactory.java
+++ b/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/OnapPolicyFinderFactory.java
@@ -18,7 +18,6 @@
* ============LICENSE_END=========================================================
*/
-
package org.onap.policy.pdp.xacml.application.common;
import com.att.research.xacml.std.StdStatusCode;
@@ -64,18 +63,16 @@ public class OnapPolicyFinderFactory extends PolicyFinderFactory {
private List<PolicyDef> referencedPolicies;
private boolean needsInit = true;
- private Properties properties = null;
+ private Properties properties;
/**
- * Empty constructor.
+ * Empty private constructor. We do not want to create
+ * an instance of this without giving Properties object.
+ *
+ * @throws OnapPolicyFinderFactoryException Exception will be thrown
*/
- public OnapPolicyFinderFactory() {
- logger.debug("Constructed without properties");
- //
- // Here we differ from the StdPolicyFinderFactory in that we initialize right away.
- // We do not wait for a policy request to happen to look for and load policies.
- //
- this.init();
+ public OnapPolicyFinderFactory() throws OnapPolicyFinderFactoryException {
+ throw new OnapPolicyFinderFactoryException("Please use the constructor with Properties object.");
}
/**
@@ -106,12 +103,7 @@ public class OnapPolicyFinderFactory extends PolicyFinderFactory {
* @return a <code>PolicyDef</code> loaded from the given identifier
*/
protected PolicyDef loadPolicyDef(String policyId) {
- String propLocation = null;
- if (this.properties == null) {
- propLocation = XACMLProperties.getProperty(policyId + PROP_FILE);
- } else {
- propLocation = this.properties.getProperty(policyId + PROP_FILE);
- }
+ String propLocation = this.properties.getProperty(policyId + PROP_FILE);
if (propLocation != null) {
//
// Try to load it from the file
@@ -121,11 +113,8 @@ public class OnapPolicyFinderFactory extends PolicyFinderFactory {
return policy;
}
}
- if (this.properties == null) {
- propLocation = XACMLProperties.getProperty(policyId + PROP_URL);
- } else {
- propLocation = this.properties.getProperty(policyId + PROP_URL);
- }
+
+ propLocation = this.properties.getProperty(policyId + PROP_URL);
if (propLocation != null) {
PolicyDef policy = this.loadPolicyUrlDef(propLocation);
if (policy != null) {
@@ -200,12 +189,7 @@ public class OnapPolicyFinderFactory extends PolicyFinderFactory {
* @return a <code>List</code> of <code>PolicyDef</code>s loaded from the given property name
*/
protected List<PolicyDef> getPolicyDefs(String propertyName) {
- String policyIds;
- if (this.properties != null) {
- policyIds = this.properties.getProperty(propertyName);
- } else {
- policyIds = XACMLProperties.getProperty(propertyName);
- }
+ String policyIds = this.properties.getProperty(propertyName);
if (Strings.isNullOrEmpty(policyIds)) {
return Collections.emptyList();
}
diff --git a/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/OnapPolicyFinderFactoryException.java b/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/OnapPolicyFinderFactoryException.java
new file mode 100644
index 00000000..a42b3a5f
--- /dev/null
+++ b/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/OnapPolicyFinderFactoryException.java
@@ -0,0 +1,48 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2019 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.pdp.xacml.application.common;
+
+public class OnapPolicyFinderFactoryException extends Exception {
+
+ private static final long serialVersionUID = -1643639780835366726L;
+
+ public OnapPolicyFinderFactoryException() {
+ super();
+ }
+
+ public OnapPolicyFinderFactoryException(String message) {
+ super(message);
+ }
+
+ public OnapPolicyFinderFactoryException(Throwable cause) {
+ super(cause);
+ }
+
+ public OnapPolicyFinderFactoryException(String message, Throwable cause) {
+ super(message, cause);
+ }
+
+ public OnapPolicyFinderFactoryException(String message, Throwable cause, boolean enableSuppression,
+ boolean writableStackTrace) {
+ super(message, cause, enableSuppression, writableStackTrace);
+ }
+
+}
diff --git a/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/ToscaDictionary.java b/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/ToscaDictionary.java
index c65d7a17..785ed9a8 100644
--- a/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/ToscaDictionary.java
+++ b/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/ToscaDictionary.java
@@ -28,10 +28,6 @@ import com.att.research.xacml.std.IdentifierImpl;
public final class ToscaDictionary {
- private ToscaDictionary() {
- super();
- }
-
/*
* These are the ID's for various TOSCA Policy Types we are supporting in the Applications.
*/
@@ -65,5 +61,8 @@ public final class ToscaDictionary {
public static final Identifier ID_OBLIGATION_ISSUER =
new IdentifierImpl(URN_ONAP, "issuer:monitoring");
+ private ToscaDictionary() {
+ super();
+ }
}
diff --git a/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/ToscaPolicyConverter.java b/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/ToscaPolicyConverter.java
index f6f75a4c..8852eb08 100644
--- a/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/ToscaPolicyConverter.java
+++ b/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/ToscaPolicyConverter.java
@@ -22,15 +22,25 @@
package org.onap.policy.pdp.xacml.application.common;
+import com.att.research.xacml.api.Request;
+import com.att.research.xacml.api.Response;
+
import java.io.InputStream;
import java.util.List;
import java.util.Map;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.PolicyType;
+import org.onap.policy.models.decisions.concepts.DecisionRequest;
+import org.onap.policy.models.decisions.concepts.DecisionResponse;
+
public interface ToscaPolicyConverter {
List<PolicyType> convertPolicies(InputStream isToscaPolicy) throws ToscaPolicyConversionException;
List<PolicyType> convertPolicies(Map<String, Object> toscaObject) throws ToscaPolicyConversionException;
+
+ Request convertRequest(DecisionRequest request);
+
+ DecisionResponse convertResponse(Response response);
}
diff --git a/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/XacmlApplicationServiceProvider.java b/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/XacmlApplicationServiceProvider.java
index 65648ea8..2ddcd027 100644
--- a/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/XacmlApplicationServiceProvider.java
+++ b/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/XacmlApplicationServiceProvider.java
@@ -25,7 +25,8 @@ import java.nio.file.Path;
import java.util.List;
import java.util.Map;
-import org.json.JSONObject;
+import org.onap.policy.models.decisions.concepts.DecisionRequest;
+import org.onap.policy.models.decisions.concepts.DecisionResponse;
/**
* This interface is how the XACML REST controller can communicate
@@ -87,12 +88,9 @@ public interface XacmlApplicationServiceProvider {
/**
* Makes a decision given the incoming request and returns a response.
*
- * <P>NOTE: I may want to change this to an object that represents the
- * schema.
- *
- * @param jsonSchema Incoming Json
- * @return response
+ * @param request Incoming DecisionRequest object
+ * @return response Responding DecisionResponse object
*/
- JSONObject makeDecision(JSONObject jsonSchema);
+ DecisionResponse makeDecision(DecisionRequest request);
}
diff --git a/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/XacmlPolicyUtils.java b/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/XacmlPolicyUtils.java
new file mode 100644
index 00000000..19adaf6c
--- /dev/null
+++ b/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/XacmlPolicyUtils.java
@@ -0,0 +1,338 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2019 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.pdp.xacml.application.common;
+
+import com.att.research.xacml.api.Identifier;
+import com.att.research.xacml.api.pdp.PDPEngine;
+import com.att.research.xacml.api.pdp.PDPEngineFactory;
+import com.att.research.xacml.util.FactoryException;
+import com.att.research.xacml.util.XACMLProperties;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Properties;
+import java.util.Set;
+import java.util.StringJoiner;
+import java.util.stream.Collectors;
+
+import oasis.names.tc.xacml._3_0.core.schema.wd_17.IdReferenceType;
+import oasis.names.tc.xacml._3_0.core.schema.wd_17.ObjectFactory;
+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.TargetType;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class XacmlPolicyUtils {
+
+ private static final Logger LOGGER = LoggerFactory.getLogger(XacmlPolicyUtils.class);
+
+ private XacmlPolicyUtils() {
+ super();
+ }
+
+ /**
+ * Creates an empty PolicySetType object given the id and combining algorithm. Note,there
+ * will also be an empty Target created. You can easily override that if need be.
+ *
+ * @param policyId Policy Id
+ * @param policyCombiningAlgorithm Policy Combining Algorithm
+ * @return PolicySetType object
+ */
+ public static PolicySetType createEmptyPolicySet(String policyId, Identifier policyCombiningAlgorithm) {
+ PolicySetType policy = new PolicySetType();
+ policy.setPolicySetId(policyId);
+ policy.setPolicyCombiningAlgId(policyCombiningAlgorithm.stringValue());
+ policy.setTarget(new TargetType());
+ return policy;
+ }
+
+ /**
+ * Creates an empty PolicySetType object given the id and combining algorithm. Note,there
+ * will also be an empty Target created. You can easily override that if need be.
+ *
+ * @param policyId Policy Id
+ * @param ruleCombiningAlgorithm Rule Combining Algorithm
+ * @return PolicyType object
+ */
+ public static PolicyType createEmptyPolicy(String policyId, Identifier ruleCombiningAlgorithm) {
+ PolicyType policy = new PolicyType();
+ policy.setPolicyId(policyId);
+ policy.setRuleCombiningAlgId(ruleCombiningAlgorithm.stringValue());
+ policy.setTarget(new TargetType());
+ return policy;
+ }
+
+ /**
+ * This method adds a list of PolicyType objects to a root PolicySetType as
+ * referenced policies.
+ *
+ * @param rootPolicy Root PolicySet being updated
+ * @param referencedPolicies A list of PolicyType being added as a references
+ * @return the rootPolicy PolicySet object
+ */
+ public static PolicySetType addPoliciesToXacmlRootPolicy(PolicySetType rootPolicy,
+ PolicyType... referencedPolicies) {
+ ObjectFactory factory = new ObjectFactory();
+ //
+ // Iterate each policy
+ //
+ for (PolicyType referencedPolicy : referencedPolicies) {
+ IdReferenceType reference = new IdReferenceType();
+ reference.setValue(referencedPolicy.getPolicyId());
+ //
+ // Add it in
+ //
+ rootPolicy.getPolicySetOrPolicyOrPolicySetIdReference().add(factory.createPolicyIdReference(reference));
+ }
+ //
+ // Return the updated object
+ //
+ return rootPolicy;
+ }
+
+ /**
+ * This method updates a root PolicySetType by adding in a PolicyType as a reference.
+ *
+ * @param rootPolicy Root PolicySet being updated
+ * @param referencedPolicySets A list of PolicySetType being added as a references
+ * @return the rootPolicy PolicySet object
+ */
+ public static PolicySetType addPolicySetsToXacmlRootPolicy(PolicySetType rootPolicy,
+ PolicySetType... referencedPolicySets) {
+ ObjectFactory factory = new ObjectFactory();
+ //
+ // Iterate each policy
+ //
+ for (PolicySetType referencedPolicySet : referencedPolicySets) {
+ IdReferenceType reference = new IdReferenceType();
+ reference.setValue(referencedPolicySet.getPolicySetId());
+ //
+ // Add it in
+ //
+ rootPolicy.getPolicySetOrPolicyOrPolicySetIdReference().add(factory.createPolicySetIdReference(reference));
+ }
+ //
+ // Return the updated object
+ //
+ return rootPolicy;
+ }
+
+ /**
+ * Adds in the referenced policy to the PDP properties object.
+ *
+ * @param properties Input properties
+ * @param refPolicyPath Path to the referenced policy file
+ * @return Properties object
+ */
+ public static Properties addReferencedPolicy(Properties properties, Path refPolicyPath) {
+ //
+ // Get the current set of referenced policy ids
+ //
+ Set<String> referencedPolicies = XACMLProperties.getReferencedPolicyIDs(properties);
+ //
+ // Construct a unique id
+ //
+ int id = 1;
+ while (true) {
+ String refId = "ref" + id;
+ if (referencedPolicies.contains(refId)) {
+ id++;
+ } else {
+ referencedPolicies.add(refId);
+ properties.put(refId + ".file", refPolicyPath.toAbsolutePath().toString());
+ break;
+ }
+ }
+ //
+ // Set the new comma separated list
+ //
+ properties.setProperty(XACMLProperties.PROP_REFERENCEDPOLICIES,
+ referencedPolicies.stream().collect(Collectors.joining(",")));
+ return properties;
+ }
+
+ /**
+ * Removes a referenced policy from the Properties object. Both in the line
+ * that identifies the policy and the .file property that points to the path.
+ *
+ * @param properties Input Properties object to remove
+ * @param refPolicyPath The policy file path
+ * @return Properties object
+ */
+ public static Properties removeReferencedPolicy(Properties properties, Path refPolicyPath) {
+ //
+ // Get the current set of referenced policy ids
+ //
+ StringJoiner join = new StringJoiner(",");
+ boolean found = false;
+ Set<String> referencedPolicies = XACMLProperties.getReferencedPolicyIDs(properties);
+ for (String refPolicy : referencedPolicies) {
+ String refPolicyFile = refPolicy + ".file";
+ //
+ // If the key and value match, then it will return true
+ //
+ if (properties.remove(refPolicyFile, refPolicyPath.toString())) {
+ //
+ // Record that we actually removed it
+ //
+ found = true;
+ } else {
+ //
+ // Retain it
+ //
+ join.add(refPolicy);
+ }
+ }
+ //
+ // Did we remove it?
+ //
+ if (found) {
+ //
+ // Now update the list of referenced properties
+ //
+ properties.setProperty(XACMLProperties.PROP_REFERENCEDPOLICIES, join.toString());
+ }
+ return properties;
+ }
+
+ /**
+ * Does a debug dump of referenced and root policy values.
+ *
+ * @param properties Input Properties object
+ * @param logger Logger object to use
+ */
+ public static void debugDumpPolicyProperties(Properties properties, Logger logger) {
+ //
+ // I hate surrounding this all with an if, but by
+ // doing so I clear sonar issues with passing System.lineSeparator()
+ // as an argument.
+ //
+ if (logger.isDebugEnabled()) {
+ //
+ // Get the current set of referenced policy ids
+ //
+ Set<String> rootPolicies = XACMLProperties.getRootPolicyIDs(properties);
+ logger.debug("Root Policies: {}", properties.getProperty(XACMLProperties.PROP_ROOTPOLICIES));
+ for (String root : rootPolicies) {
+ logger.debug("{}", properties.getProperty(root + ".file", "NOT FOUND"));
+ }
+ //
+ // Get the current set of referenced policy ids
+ //
+ Set<String> referencedPolicies = XACMLProperties.getReferencedPolicyIDs(properties);
+ logger.debug("Referenced Policies: {}", properties.getProperty(XACMLProperties.PROP_REFERENCEDPOLICIES));
+ for (String ref : referencedPolicies) {
+ logger.debug("{}", properties.getProperty(ref + ".file", "NOT FOUND"));
+ }
+ }
+ }
+
+ /**
+ * Constructs a unique policy filename for a given policy.
+ *
+ * <P>It could be dangerous to use policy-id and policy-version if the user
+ * gives us an invalid policy-id and policy-versions.
+ *
+ * <P>Should we append a UUID also to guarantee uniqueness?
+ *
+ * <P>How do we track that in case we need to know what policies we have loaded?
+ *
+ * @param policy PolicyType object
+ * @param path Path for policy
+ * @return Path unique file path for the Policy
+ */
+ public static Path constructUniquePolicyFilename(PolicyType policy, Path path) {
+ //
+ //
+ // Can it be possible to produce an invalid filename?
+ // Should we insert a UUID
+ //
+ String filename = policy.getPolicyId() + "_" + policy.getVersion() + ".xml";
+ //
+ // Construct the Path
+ //
+ return Paths.get(path.toAbsolutePath().toString(), filename);
+ }
+
+ /**
+ * Load properties from given file.
+ *
+ * @throws IOException If unable to read file
+ */
+ public static Properties loadXacmlProperties(Path propertyPath) throws IOException {
+ LOGGER.debug("Loading xacml properties {}", propertyPath);
+ try (InputStream is = Files.newInputStream(propertyPath)) {
+ Properties properties = new Properties();
+ properties.load(is);
+ return properties;
+ }
+ }
+
+ /**
+ * Stores the XACML Properties to the given file location.
+ *
+ * @throws IOException If unable to store the file.
+ */
+ public static void storeXacmlProperties(Properties properties, Path propertyPath) throws IOException {
+ try (OutputStream os = Files.newOutputStream(propertyPath)) {
+ String strComments = "#";
+ properties.store(os, strComments);
+ }
+ }
+
+ /**
+ * Appends 'xacml.properties' to a root Path object
+ *
+ * @param rootPath Root Path object
+ * @return Path to rootPath/xacml.properties file
+ */
+ public static Path getPropertiesPath(Path rootPath) {
+ return Paths.get(rootPath.toAbsolutePath().toString(), "xacml.properties");
+ }
+
+
+ /**
+ * Creates an instance of PDP engine given the Properties object.
+ *
+ * @param properties Incoming Properties object
+ * @return PDPEngine instance or null if failed
+ */
+ public static PDPEngine createEngine(Properties properties) {
+ //
+ // Now initialize the XACML PDP Engine
+ //
+ try {
+ PDPEngineFactory factory = PDPEngineFactory.newInstance();
+ return factory.newEngine(properties);
+ } catch (FactoryException e) {
+ LOGGER.error("Failed to create XACML PDP Engine {}", e);
+ }
+ return null;
+ }
+}
diff --git a/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/XacmlUpdatePolicyUtils.java b/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/XacmlUpdatePolicyUtils.java
deleted file mode 100644
index 957242c5..00000000
--- a/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/XacmlUpdatePolicyUtils.java
+++ /dev/null
@@ -1,88 +0,0 @@
-/*-
- * ============LICENSE_START=======================================================
- * ONAP
- * ================================================================================
- * Copyright (C) 2019 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.
- *
- * SPDX-License-Identifier: Apache-2.0
- * ============LICENSE_END=========================================================
- */
-
-package org.onap.policy.pdp.xacml.application.common;
-
-import oasis.names.tc.xacml._3_0.core.schema.wd_17.IdReferenceType;
-import oasis.names.tc.xacml._3_0.core.schema.wd_17.ObjectFactory;
-import oasis.names.tc.xacml._3_0.core.schema.wd_17.PolicySetType;
-import oasis.names.tc.xacml._3_0.core.schema.wd_17.PolicyType;
-
-public class XacmlUpdatePolicyUtils {
-
- private XacmlUpdatePolicyUtils() {
- super();
- }
-
- /**
- * This method updates a root PolicySetType by adding in a PolicyType as a reference.
- *
- * @param rootPolicy Root PolicySet being updated
- * @param referencedPolicies A list of PolicyType being added as a references
- * @return the rootPolicy PolicySet object
- */
- public static PolicySetType updateXacmlRootPolicy(PolicySetType rootPolicy, PolicyType... referencedPolicies) {
- ObjectFactory factory = new ObjectFactory();
- //
- // Iterate each policy
- //
- for (PolicyType referencedPolicy : referencedPolicies) {
- IdReferenceType reference = new IdReferenceType();
- reference.setValue(referencedPolicy.getPolicyId());
- //
- // Add it in
- //
- rootPolicy.getPolicySetOrPolicyOrPolicySetIdReference().add(factory.createPolicySetIdReference(reference));
- }
- //
- // Return the updated object
- //
- return rootPolicy;
- }
-
- /**
- * This method updates a root PolicySetType by adding in a PolicyType as a reference.
- *
- * @param rootPolicy Root PolicySet being updated
- * @param referencedPolicySets A list of PolicySetType being added as a references
- * @return the rootPolicy PolicySet object
- */
- public static PolicySetType updateXacmlRootPolicy(PolicySetType rootPolicy, PolicySetType... referencedPolicySets) {
- ObjectFactory factory = new ObjectFactory();
- //
- // Iterate each policy
- //
- for (PolicySetType referencedPolicySet : referencedPolicySets) {
- IdReferenceType reference = new IdReferenceType();
- reference.setValue(referencedPolicySet.getPolicySetId());
- //
- // Add it in
- //
- rootPolicy.getPolicySetOrPolicyOrPolicySetIdReference().add(factory.createPolicySetIdReference(reference));
- }
- //
- // Return the updated object
- //
- return rootPolicy;
- }
-
-}
diff --git a/applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/OnapPolicyFinderFactoryExceptionTest.java b/applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/OnapPolicyFinderFactoryExceptionTest.java
new file mode 100644
index 00000000..86708284
--- /dev/null
+++ b/applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/OnapPolicyFinderFactoryExceptionTest.java
@@ -0,0 +1,35 @@
+/*
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2019 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.policy.pdp.xacml.application.common;
+
+import static org.junit.Assert.assertEquals;
+
+import org.junit.Test;
+import org.onap.policy.common.utils.test.ExceptionsTester;
+
+public class OnapPolicyFinderFactoryExceptionTest {
+
+ @Test
+ public void test() {
+ assertEquals(5, new ExceptionsTester().test(OnapPolicyFinderFactoryException.class));
+ }
+
+}
diff --git a/applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/OnapPolicyFinderFactoryTest.java b/applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/OnapPolicyFinderFactoryTest.java
new file mode 100644
index 00000000..5cd1cdc7
--- /dev/null
+++ b/applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/OnapPolicyFinderFactoryTest.java
@@ -0,0 +1,38 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2019 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.pdp.xacml.application.common;
+
+import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
+
+import org.junit.Test;
+
+public class OnapPolicyFinderFactoryTest {
+
+ @Test
+ public void test() throws NoSuchMethodException, SecurityException {
+ assertThatExceptionOfType(OnapPolicyFinderFactoryException.class).isThrownBy(() -> {
+ new OnapPolicyFinderFactory();
+ }).withMessageContaining("Please use the constructor with Properties object.");
+ }
+
+}
diff --git a/applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/XacmlUpdatePolicyUtilsTest.java b/applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/XacmlPolicyUtilsTest.java
index 84fefa5c..57800d9e 100644
--- a/applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/XacmlUpdatePolicyUtilsTest.java
+++ b/applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/XacmlPolicyUtilsTest.java
@@ -22,11 +22,11 @@
package org.onap.policy.pdp.xacml.application.common;
+import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatCode;
import com.att.research.xacml.api.XACML3;
import com.att.research.xacml.util.XACMLPolicyWriter;
-import com.att.research.xacml.util.XACMLProperties;
import java.io.ByteArrayOutputStream;
import java.io.File;
@@ -36,8 +36,9 @@ import java.io.InputStream;
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.Path;
-import java.util.Map.Entry;
+import java.nio.file.Paths;
import java.util.Properties;
+
import oasis.names.tc.xacml._3_0.core.schema.wd_17.AnyOfType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.EffectType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.MatchType;
@@ -46,6 +47,7 @@ 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.junit.BeforeClass;
import org.junit.ClassRule;
import org.junit.Test;
@@ -60,22 +62,27 @@ import org.slf4j.LoggerFactory;
* @author pameladragosh
*
*/
-public class XacmlUpdatePolicyUtilsTest {
- private static final Logger LOGGER = LoggerFactory.getLogger(XacmlUpdatePolicyUtilsTest.class);
+public class XacmlPolicyUtilsTest {
+ private static final Logger LOGGER = LoggerFactory.getLogger(XacmlPolicyUtilsTest.class);
static Properties properties;
- static PolicySetType rootPolicy = new PolicySetType();
+ static PolicySetType rootPolicy = XacmlPolicyUtils.createEmptyPolicySet("root", XACML3.ID_POLICY_FIRST_APPLICABLE);
static Path rootPath;
- static PolicyType policy1 = new PolicyType();
- static PolicyType policy2 = new PolicyType();
+ static PolicyType policy1 = XacmlPolicyUtils.createEmptyPolicy("policy1", XACML3.ID_RULE_DENY_UNLESS_PERMIT);
+ static PolicyType policy2 = XacmlPolicyUtils.createEmptyPolicy("policy2", XACML3.ID_RULE_DENY_UNLESS_PERMIT);
+ static PolicyType policy3 = XacmlPolicyUtils.createEmptyPolicy("policy3", XACML3.ID_RULE_DENY_UNLESS_PERMIT);
+ static PolicyType policy4 = XacmlPolicyUtils.createEmptyPolicy("policy4", XACML3.ID_RULE_DENY_UNLESS_PERMIT);
- static PolicySetType policySet3 = new PolicySetType();
+ static PolicySetType policySet5 = XacmlPolicyUtils.createEmptyPolicySet(
+ "policyset1", XACML3.ID_POLICY_FIRST_APPLICABLE);
static Path path1;
static Path path2;
+ static Path path3;
+ static Path path4;
static Path policySetPath;
@@ -86,7 +93,8 @@ public class XacmlUpdatePolicyUtilsTest {
public static TemporaryFolder policyFolder = new TemporaryFolder();
/**
- * Setup the JUnit tests.
+ * Setup the JUnit tests by finishing creating the policies and
+ * writing them out to the temporary folder.
*
* @throws Exception thrown
*/
@@ -101,43 +109,59 @@ public class XacmlUpdatePolicyUtilsTest {
properties.load(is);
}
//
- // Create a very basic Root policy
+ // Save root policy
//
- rootPolicy.setPolicySetId("root");
- rootPolicy.setTarget(new TargetType());
- rootPolicy.setPolicyCombiningAlgId(XACML3.ID_POLICY_FIRST_APPLICABLE.stringValue());
File rootFile = policyFolder.newFile("root.xml");
LOGGER.info("Creating Root Policy {}", rootFile.getAbsolutePath());
rootPath = XACMLPolicyWriter.writePolicyFile(rootFile.toPath(), rootPolicy);
//
- // Create policies
+ // Create policies - Policies 1 and 2 will become references in the
+ // root policy. While Policies 3 and 4 will become references in the
+ // soon to be created PolicySet 5 below.
//
- path1 = createPolicy(policy1, "policy1", "resource1");
+ path1 = createPolicyContents(policy1, "resource1");
LOGGER.info(new String(Files.readAllBytes(path1)));
- path2 = createPolicy(policy2, "policy2", "resource2");
+ path2 = createPolicyContents(policy2, "resource2");
LOGGER.info(new String(Files.readAllBytes(path2)));
+ path3 = createPolicyContents(policy3, "resourc31");
+ LOGGER.info(new String(Files.readAllBytes(path3)));
+ path4 = createPolicyContents(policy4, "resource4");
+ LOGGER.info(new String(Files.readAllBytes(path4)));
//
- // Create another PolicySet
+ // Create our PolicySet
//
- policySet3.setPolicySetId("policyset1");
- policySet3.setTarget(new TargetType());
- policySet3.setPolicyCombiningAlgId(XACML3.ID_POLICY_FIRST_APPLICABLE.stringValue());
+ policySet5.setPolicySetId("policyset5");
+ policySet5.setTarget(new TargetType());
+ policySet5.setPolicyCombiningAlgId(XACML3.ID_POLICY_FIRST_APPLICABLE.stringValue());
ObjectFactory factory = new ObjectFactory();
-
- policySet3.getPolicySetOrPolicyOrPolicySetIdReference().add(factory.createPolicy(policy1));
- policySet3.getPolicySetOrPolicyOrPolicySetIdReference().add(factory.createPolicy(policy2));
- File policySetFile = policyFolder.newFile("policySet1.xml");
+ //
+ // Add Policies 3 and 4 to the PolicySet
+ //
+ policySet5.getPolicySetOrPolicyOrPolicySetIdReference().add(factory.createPolicy(policy1));
+ policySet5.getPolicySetOrPolicyOrPolicySetIdReference().add(factory.createPolicy(policy2));
+ assertThat(policySet5.getPolicySetOrPolicyOrPolicySetIdReference()).hasSize(2);
+ //
+ // Save that to disk
+ //
+ File policySetFile = policyFolder.newFile("policySet5.xml");
LOGGER.info("Creating PolicySet {}", policySetFile.getAbsolutePath());
- policySetPath = XACMLPolicyWriter.writePolicyFile(policySetFile.toPath(), policySet3);
+ policySetPath = XACMLPolicyWriter.writePolicyFile(policySetFile.toPath(), policySet5);
}).doesNotThrowAnyException();
}
- private static Path createPolicy(PolicyType policy, String id, String resource) throws IOException {
+ /**
+ * Helper method that creates a very simple Policy and Rule and saves it to disk.
+ *
+ * @param policy Policy to store contents in
+ * @param resource A simple resource id for the Target
+ * @return Path object of the policy
+ * @throws IOException If unable to write to disk
+ */
+ private static Path createPolicyContents(PolicyType policy, String resource) throws IOException {
//
- // Create Policy 1
+ // Create The Match
//
- policy.setPolicyId(id);
MatchType matchPolicyId = ToscaPolicyConverterUtils.buildMatchTypeDesignator(
XACML3.ID_FUNCTION_STRING_EQUAL,
resource,
@@ -164,7 +188,7 @@ public class XacmlUpdatePolicyUtilsTest {
//
policy.getCombinerParametersOrRuleCombinerParametersOrVariableDefinition().add(rule);
//
- // Create a file
+ // Save it to disk
//
File file = policyFolder.newFile(policy.getPolicyId() + ".xml");
LOGGER.info("Creating Policy {}", file.getAbsolutePath());
@@ -172,55 +196,69 @@ public class XacmlUpdatePolicyUtilsTest {
}
@Test
- public void test() {
+ public void testUpdatingPolicies() {
assertThatCode(() -> {
//
// Just update root and policies
//
- XacmlUpdatePolicyUtils.updateXacmlRootPolicy(rootPolicy, policy1, policy2);
- try (OutputStream os = new ByteArrayOutputStream()) {
- XACMLPolicyWriter.writePolicyFile(os, rootPolicy);
- LOGGER.debug("New Root Policy:{}{}", System.lineSeparator(), os.toString());
- }
+ XacmlPolicyUtils.addPoliciesToXacmlRootPolicy(rootPolicy, policy1, policy2);
//
- // Test updating the properties
+ // Make sure it is correct
//
- XACMLProperties.setXacmlRootProperties(properties, rootPath);
- XACMLProperties.setXacmlReferencedProperties(properties, path1, path2);
+ assertThat(rootPolicy.getPolicySetOrPolicyOrPolicySetIdReference()).hasSize(2);
//
- // Dump this out so I can see what I'm doing
+ // Save to disk
//
- for (Entry<Object, Object> entry : properties.entrySet()) {
- LOGGER.info("{}={}", entry.getKey(), entry.getValue());
+ try (OutputStream os = new ByteArrayOutputStream()) {
+ XACMLPolicyWriter.writePolicyFile(os, rootPolicy);
+ LOGGER.debug("New Root Policy:{}{}", System.lineSeparator(), os.toString());
}
- LOGGER.info("Properties {}", properties.toString());
- //
- // Somehow I have to figure out how to test this in assertj
- //
//
// Just update root and PolicySet
//
- XacmlUpdatePolicyUtils.updateXacmlRootPolicy(rootPolicy, policySet3);
+ XacmlPolicyUtils.addPolicySetsToXacmlRootPolicy(rootPolicy, policySet5);
try (OutputStream os = new ByteArrayOutputStream()) {
XACMLPolicyWriter.writePolicyFile(os, rootPolicy);
LOGGER.debug("New Root Policy:{}{}", System.lineSeparator(), os.toString());
}
- //
- // Test updating the properties
- //
- XACMLProperties.setXacmlRootProperties(properties, rootPath);
- XACMLProperties.setXacmlReferencedProperties(properties, policySetPath);
- //
- // Dump this out so I can see what I'm doing
- //
- for (Entry<Object, Object> entry : properties.entrySet()) {
- LOGGER.info("{}={}", entry.getKey(), entry.getValue());
- }
- LOGGER.info("Properties {}", properties.toString());
- //
- // Somehow I have to figure out how to test this in assertj
- //
-
}).doesNotThrowAnyException();
}
+
+ @Test
+ public void testRemovingProperties() {
+ //
+ // Dump what we are starting with
+ //
+ XacmlPolicyUtils.debugDumpPolicyProperties(properties, LOGGER);
+ //
+ // Remove referenced policies
+ //
+ Path ref = Paths.get("src/test/resources/ref1.xml");
+ XacmlPolicyUtils.removeReferencedPolicy(properties, ref);
+ XacmlPolicyUtils.debugDumpPolicyProperties(properties, LOGGER);
+ assertThat(properties.getProperty("refstart1.file")).isNullOrEmpty();
+
+ ref = Paths.get("src/test/resources/ref2.xml");
+ XacmlPolicyUtils.removeReferencedPolicy(properties, ref);
+ XacmlPolicyUtils.debugDumpPolicyProperties(properties, LOGGER);
+ assertThat(properties.getProperty("refstart2.file")).isNullOrEmpty();
+
+ //
+ // Test one that isn't in there
+ //
+ ref = Paths.get("src/test/resources/NotThere.xml");
+ XacmlPolicyUtils.removeReferencedPolicy(properties, ref);
+ XacmlPolicyUtils.debugDumpPolicyProperties(properties, LOGGER);
+ assertThat(properties.getProperty("refstart3.file")).isNotBlank();
+
+ ref = Paths.get("src/test/resources/ref3.xml");
+ XacmlPolicyUtils.removeReferencedPolicy(properties, ref);
+ XacmlPolicyUtils.debugDumpPolicyProperties(properties, LOGGER);
+ assertThat(properties.getProperty("refstart3.file")).isNullOrEmpty();
+
+ ref = Paths.get("src/test/resources/ref4.xml");
+ XacmlPolicyUtils.removeReferencedPolicy(properties, ref);
+ XacmlPolicyUtils.debugDumpPolicyProperties(properties, LOGGER);
+ assertThat(properties.getProperty("refstart4.file")).isNullOrEmpty();
+ }
}