summaryrefslogtreecommitdiffstats
path: root/PolicyEngineAPI
diff options
context:
space:
mode:
Diffstat (limited to 'PolicyEngineAPI')
-rw-r--r--PolicyEngineAPI/src/main/java/org/onap/policy/api/ConfigRequestParameters.java32
-rw-r--r--PolicyEngineAPI/src/main/java/org/onap/policy/api/DecisionRequestParameters.java48
-rw-r--r--PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyConfigType.java4
-rw-r--r--PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyEngine.java68
-rw-r--r--PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyParameters.java33
-rw-r--r--PolicyEngineAPI/src/main/java/org/onap/policy/std/StdPolicyEngine.java10
-rw-r--r--PolicyEngineAPI/src/test/java/org/onap/policy/test/DecisionRequestParametersTest.java8
7 files changed, 137 insertions, 66 deletions
diff --git a/PolicyEngineAPI/src/main/java/org/onap/policy/api/ConfigRequestParameters.java b/PolicyEngineAPI/src/main/java/org/onap/policy/api/ConfigRequestParameters.java
index cdee9672b..dcdc17802 100644
--- a/PolicyEngineAPI/src/main/java/org/onap/policy/api/ConfigRequestParameters.java
+++ b/PolicyEngineAPI/src/main/java/org/onap/policy/api/ConfigRequestParameters.java
@@ -31,7 +31,7 @@ import java.util.UUID;
*/
public class ConfigRequestParameters {
private String policyName;
- private String onapComponentName;
+ private String onapName;
private String configName;
private Map<String,String> configAttributes;
private UUID requestID;
@@ -49,13 +49,24 @@ public class ConfigRequestParameters {
/**
* Sets the ONAP Component Name of the Config policy which needs to be retrieved.
*
- * @param onapComponentName the <code>String</code> format of the onapComponentName whose configuration is required.
+ * @param onapName the <code>String</code> format of the onapName whose configuration is required.
*/
- public void setOnapName(String onapComponentName){
- this.onapComponentName = onapComponentName;
+ public void setOnapName(String onapName){
+ this.onapName = onapName;
}
/**
+ * Sets the ONAP Component Name of the Config policy which needs to be retrieved.
+ *
+ * @param ecompName the <code>String</code> format of the onapName whose configuration is required.
+ * @deprecated use {@link #setOnapName(String)} instead.
+ */
+ @Deprecated
+ public void setEcompName(String ecompName){
+ this.onapName = ecompName;
+ }
+
+ /**
* Sets the Config Name of the Config policy which needs to be retrieved.
*
* @param configName the <code>String</code> format of the configurationName whose configuration is required.
@@ -97,10 +108,21 @@ public class ConfigRequestParameters {
* @return <code>String</code> format of the ONAP Component Name.
*/
public String getOnapName(){
- return onapComponentName;
+ return onapName;
}
/**
+ * Gets the ONAP Component Name of the Request Parameters.
+ *
+ * @return <code>String</code> format of the ONAP Component Name.
+ * @deprecated use {@link #getOnapName()} instead.
+ */
+ @Deprecated
+ public String getEcompName(){
+ return onapName;
+ }
+
+ /**
* Gets the Config name of the Request Parameters.
*
* @return <code>String</code> format of the Config Name.
diff --git a/PolicyEngineAPI/src/main/java/org/onap/policy/api/DecisionRequestParameters.java b/PolicyEngineAPI/src/main/java/org/onap/policy/api/DecisionRequestParameters.java
index 27e419fb1..5cf9d641d 100644
--- a/PolicyEngineAPI/src/main/java/org/onap/policy/api/DecisionRequestParameters.java
+++ b/PolicyEngineAPI/src/main/java/org/onap/policy/api/DecisionRequestParameters.java
@@ -30,7 +30,7 @@ import java.util.UUID;
* @version 0.1
*/
public class DecisionRequestParameters {
- private String onapComponentName;
+ private String onapName;
private Map<String,String> decisionAttributes;
private UUID requestID;
@@ -43,32 +43,56 @@ public class DecisionRequestParameters {
/**
* Constructor with Parameters
*
- * @param onapComponentName the <code>String</code> format of the onapComponentName whose Decision is required.
+ * @param onapName the <code>String</code> format of the onapName whose Decision is required.
* @param decisionAttributes the <code>Map</code> of <code>String,String</code> format of the decisionAttributes that contain the ID and values.
* @param requestID unique request ID which will be passed throughout the ONAP components to correlate logging messages.
*/
- public DecisionRequestParameters(String onapComponentName, Map<String,String> decisionAttributes, UUID requestID){
- this.onapComponentName = onapComponentName;
+ public DecisionRequestParameters(String onapName, Map<String,String> decisionAttributes, UUID requestID){
+ this.onapName = onapName;
this.decisionAttributes = decisionAttributes;
this.requestID = requestID;
}
/**
- * Gets the ONAPComponentName of the Decision Request Parameters.
+ * Gets the onapName of the Decision Request Parameters.
*
- * @return ONAPComponentName the <code>String</code> format of the onapComponentName of the Decision Request Parameters.
+ * @return onapName the <code>String</code> format of the onapName of the Decision Request Parameters.
*/
- public String getONAPComponentName() {
- return onapComponentName;
+ public String getOnapName() {
+ return onapName;
}
+
+ /**
+ * Gets the onapName of the Decision Request Parameters.
+ *
+ * @return onapName the <code>String</code> format of the onapName of the Decision Request Parameters.
+ * @deprecated use {@link #getOnapName()} instead.
+ */
+ @Deprecated
+ public String getECOMPComponentName() {
+ return onapName;
+ }
+
/**
- * Sets the ONAPComponentName of the Decision Request parameters.
+ * Sets the onapName of the Decision Request parameters.
*
- * @param onapComponentName the <code>String</code> format of the onapComponentName whose Decision is required.
+ * @param onapName the <code>String</code> format of the onapName whose Decision is required.
*/
- public void setONAPComponentName(String onapComponentName) {
- this.onapComponentName = onapComponentName;
+ public void setOnapName(String onapName) {
+ this.onapName = onapName;
}
+
+ /**
+ * Sets the ecompComponentName of the Decision Request parameters.
+ *
+ * @param ecompName the <code>String</code> format of the onapName whose Decision is required.
+ * @deprecated use {@link #setOnapName(String)} instead.
+ */
+ @Deprecated
+ public void setECOMPComponentName(String ecompName) {
+ this.onapName = ecompName;
+ }
+
/**
* Gets the Decision Attributes from Decision Request Parameters.
*
diff --git a/PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyConfigType.java b/PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyConfigType.java
index 77c978da4..59fd42733 100644
--- a/PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyConfigType.java
+++ b/PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyConfigType.java
@@ -57,7 +57,9 @@ public enum PolicyConfigType{
* Indicates DCAE Micro Service based Policy.
*/
MicroService("MS"),
-
+ /**
+ * Indicates Custom Extended Policy type.
+ */
Extended("EXTENDED")
;
diff --git a/PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyEngine.java b/PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyEngine.java
index bfb4f1e4f..7bd45983b 100644
--- a/PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyEngine.java
+++ b/PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyEngine.java
@@ -121,22 +121,22 @@ public class PolicyEngine{
}
/**
- * Gets the configuration from the PolicyDecisionPoint(PDP) for the <code>String</code> which represents the onapComponentName
+ * Gets the configuration from the PolicyDecisionPoint(PDP) for the <code>String</code> which represents the onapName
*
- * @param onapComponentName the <code>String</code> format of the onapComponentName whose configuration is required.
+ * @param onapName the <code>String</code> format of the onapName whose configuration is required.
* @return <code>Collection</code> of {@link org.onap.policy.api.PolicyConfig} which has the configuration.
* @throws PolicyConfigException PolicyConfig Exception
* @deprecated use {@link #getConfig(ConfigRequestParameters)} Instead.
*/
@Deprecated
- public Collection<PolicyConfig> getConfig(String onapComponentName) throws PolicyConfigException {
- return getConfig(setConfigRequestParameters(null, onapComponentName, null, null, null));
+ public Collection<PolicyConfig> getConfig(String onapName) throws PolicyConfigException {
+ return getConfig(setConfigRequestParameters(null, onapName, null, null, null));
}
/**
- * Gets the configuration from the PolicyDecisionPoint(PDP) for the <code>String</code> which represents the onapComponentName
+ * Gets the configuration from the PolicyDecisionPoint(PDP) for the <code>String</code> which represents the onapName
*
- * @param onapComponentName the <code>String</code> format of the onapComponentName whose configuration is required.
+ * @param onapName the <code>String</code> format of the onapName whose configuration is required.
* @return <code>Collection</code> of {@link org.onap.policy.api.PolicyConfig} which has the configuration.
* @param requestID unique request ID which will be passed throughout the ONAP components to correlate logging messages.
* A different request ID should be passed for each request.
@@ -144,32 +144,32 @@ public class PolicyEngine{
* @deprecated use {@link #getConfig(ConfigRequestParameters)} Instead.
*/
@Deprecated
- public Collection<PolicyConfig> getConfig(String onapComponentName, UUID requestID) throws PolicyConfigException {
- return getConfig(setConfigRequestParameters(null, onapComponentName, null, null, requestID));
+ public Collection<PolicyConfig> getConfig(String onapName, UUID requestID) throws PolicyConfigException {
+ return getConfig(setConfigRequestParameters(null, onapName, null, null, requestID));
}
/**
- * Requests the configuration of the <code>String</code> which represents the onapComponentName and <code>String</code>
+ * Requests the configuration of the <code>String</code> which represents the onapName and <code>String</code>
* which represents the configName and returns the configuration if different Configurations exist for the
- * particular onapComponentName.
+ * particular onapName.
*
- * @param onapComponentName the <code>String</code> format of the onapComponentName whose configuration is required.
+ * @param onapName the <code>String</code> format of the onapName whose configuration is required.
* @param configName the <code>String</code> format of the configurationName whose configuration is required.
* @return <code>Collection</code> of {@link org.onap.policy.api.PolicyConfig} which has the configuration.
* @throws PolicyConfigException PolicyConfig Exception
* @deprecated use {@link #getConfig(ConfigRequestParameters)} Instead.
*/
@Deprecated
- public Collection<PolicyConfig> getConfig(String onapComponentName, String configName) throws PolicyConfigException {
- return getConfig(setConfigRequestParameters(null, onapComponentName, configName, null, null));
+ public Collection<PolicyConfig> getConfig(String onapName, String configName) throws PolicyConfigException {
+ return getConfig(setConfigRequestParameters(null, onapName, configName, null, null));
}
/**
- * Requests the configuration of the <code>String</code> which represents the onapComponentName and <code>String</code>
+ * Requests the configuration of the <code>String</code> which represents the onapName and <code>String</code>
* which represents the configName and returns the configuration if different Configurations exist for the
- * particular onapComponentName.
+ * particular onapName.
*
- * @param onapComponentName the <code>String</code> format of the onapComponentName whose configuration is required.
+ * @param onapName the <code>String</code> format of the onapName whose configuration is required.
* @param configName the <code>String</code> format of the configurationName whose configuration is required.
* @param requestID unique request ID which will be passed throughout the ONAP components to correlate logging messages.
* A different request ID should be passed for each request.
@@ -178,16 +178,16 @@ public class PolicyEngine{
* @deprecated use {@link #getConfig(ConfigRequestParameters)} Instead.
*/
@Deprecated
- public Collection<PolicyConfig> getConfig(String onapComponentName, String configName, UUID requestID) throws PolicyConfigException {
- return getConfig(setConfigRequestParameters(null, onapComponentName, configName, null, requestID));
+ public Collection<PolicyConfig> getConfig(String onapName, String configName, UUID requestID) throws PolicyConfigException {
+ return getConfig(setConfigRequestParameters(null, onapName, configName, null, requestID));
}
/**
- * Requests the configuration of the <code>String</code> which represents the onapComponentName, <code>String</code>
+ * Requests the configuration of the <code>String</code> which represents the onapName, <code>String</code>
* which represents the configName and <code>Map</code> of <code>String,String</code> which has the configAttribute and returns the specific
* configuration related to the configAttributes mentioned.
*
- * @param onapComponentName the <code>String</code> format of the onapComponentName whose configuration is required.
+ * @param onapName the <code>String</code> format of the onapName whose configuration is required.
* @param configName the <code>String</code> format of the configurationName whose configuration is required.
* @param configAttributes the <code>Map</code> of <code>String,String</code> format of the configuration attributes which are required.
* @return <code>Collection</code> of {@link org.onap.policy.api.PolicyConfig} which has the configuration.
@@ -195,16 +195,16 @@ public class PolicyEngine{
* @deprecated use {@link #getConfig(ConfigRequestParameters)} Instead.
*/
@Deprecated
- public Collection<PolicyConfig> getConfig(String onapComponentName, String configName, Map<String, String> configAttributes) throws PolicyConfigException{
- return getConfig(setConfigRequestParameters(null, onapComponentName, configName, configAttributes, null));
+ public Collection<PolicyConfig> getConfig(String onapName, String configName, Map<String, String> configAttributes) throws PolicyConfigException{
+ return getConfig(setConfigRequestParameters(null, onapName, configName, configAttributes, null));
}
/**
- * Requests the configuration of the <code>String</code> which represents the onapComponentName, <code>String</code>
+ * Requests the configuration of the <code>String</code> which represents the onapName, <code>String</code>
* which represents the configName and <code>Map</code> of <code>String,String</code> which has the configAttribute and returns the specific
* configuration related to the configAttributes mentioned.
*
- * @param onapComponentName the <code>String</code> format of the onapComponentName whose configuration is required.
+ * @param onapName the <code>String</code> format of the onapName whose configuration is required.
* @param configName the <code>String</code> format of the configurationName whose configuration is required.
* @param configAttributes the <code>Map</code> of <code>String,String</code> format of the configuration attributes which are required.
* @param requestID unique request ID which will be passed throughout the ONAP components to correlate logging messages.
@@ -214,8 +214,8 @@ public class PolicyEngine{
* @deprecated use {@link #getConfig(ConfigRequestParameters)} Instead.
*/
@Deprecated
- public Collection<PolicyConfig> getConfig(String onapComponentName, String configName, Map<String, String> configAttributes, UUID requestID) throws PolicyConfigException{
- return getConfig(setConfigRequestParameters(null, onapComponentName, configName, configAttributes, requestID));
+ public Collection<PolicyConfig> getConfig(String onapName, String configName, Map<String, String> configAttributes, UUID requestID) throws PolicyConfigException{
+ return getConfig(setConfigRequestParameters(null, onapName, configName, configAttributes, requestID));
}
/**
@@ -285,21 +285,21 @@ public class PolicyEngine{
/**
* Sends the decision Attributes specified to the PEP and returns back the PolicyDecision.
*
- * @param onapComponentName the <code>String</code> format of the onapComponentName whose Decision is required.
+ * @param onapName the <code>String</code> format of the onapName whose Decision is required.
* @param decisionAttributes the <code>Map</code> of <code>String,String</code> format of the decisionAttributes that must contain the ID and values.
* @return {@link org.onap.policy.api.DecisionResponse} which has the Decision.
* @throws PolicyDecisionException PolicyDecision Exception
* @deprecated use {@link #getDecision(DecisionRequestParameters)} Instead.
*/
@Deprecated
- public DecisionResponse getDecision(String onapComponentName, Map<String,String> decisionAttributes) throws PolicyDecisionException {
- return stdPolicyEngine.getDecision(onapComponentName, decisionAttributes, null);
+ public DecisionResponse getDecision(String onapName, Map<String,String> decisionAttributes) throws PolicyDecisionException {
+ return stdPolicyEngine.getDecision(onapName, decisionAttributes, null);
}
/**
* Sends the decision Attributes specified to the PEP and returns back the PolicyDecision.
*
- * @param onapComponentName the <code>String</code> format of the onapComponentName whose Decision is required.
+ * @param onapName the <code>String</code> format of the onapName whose Decision is required.
* @param decisionAttributes the <code>Map</code> of <code>String,String</code> format of the decisionAttributes that must contain the ID and values.
* @param requestID unique request ID which will be passed throughout the ONAP components to correlate logging messages.
* A different request ID should be passed for each request.
@@ -308,8 +308,8 @@ public class PolicyEngine{
* @deprecated use {@link #getDecision(DecisionRequestParameters)} Instead.
*/
@Deprecated
- public DecisionResponse getDecision(String onapComponentName, Map<String,String> decisionAttributes, UUID requestID) throws PolicyDecisionException {
- return stdPolicyEngine.getDecision(onapComponentName, decisionAttributes, requestID);
+ public DecisionResponse getDecision(String onapName, Map<String,String> decisionAttributes, UUID requestID) throws PolicyDecisionException {
+ return stdPolicyEngine.getDecision(onapName, decisionAttributes, requestID);
}
/**
@@ -590,10 +590,10 @@ public class PolicyEngine{
}
// Internal Setter Method to help build configRequestParameters.
- private ConfigRequestParameters setConfigRequestParameters(String policyName, String onapComponentName, String configName, Map<String, String> configAttributes, UUID requestID){
+ private ConfigRequestParameters setConfigRequestParameters(String policyName, String onapName, String configName, Map<String, String> configAttributes, UUID requestID){
ConfigRequestParameters configRequestParameters = new ConfigRequestParameters();
configRequestParameters.setPolicyName(policyName);
- configRequestParameters.setOnapName(onapComponentName);
+ configRequestParameters.setOnapName(onapName);
configRequestParameters.setConfigName(configName);
configRequestParameters.setConfigAttributes(configAttributes);
configRequestParameters.setRequestID(requestID);
diff --git a/PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyParameters.java b/PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyParameters.java
index 0d76d8f13..1078916eb 100644
--- a/PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyParameters.java
+++ b/PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyParameters.java
@@ -53,7 +53,7 @@ public class PolicyParameters {
private RuleProvider ruleProvider;
private String controllerName;
private ArrayList<String> dependencyNames;
- private Date TTLDate;
+ private Date ttlDate;
private boolean guard = false;
private String riskLevel = "5";
private String riskType = "default";
@@ -146,6 +146,17 @@ public class PolicyParameters {
public String getOnapName() {
return onapName;
}
+
+ /**
+ * Gets the ONAP Name value of the Policy Paramters.
+ *
+ * @return <code>String</code> format of the ONAP Name
+ * @deprecated Use {@link #getOnapName()} instead.
+ */
+ @Deprecated
+ public String getEcompName() {
+ return onapName;
+ }
/**
* Sets the ONAP Name field of the Policy Parameters.
@@ -155,6 +166,18 @@ public class PolicyParameters {
public void setOnapName(String onapName) {
this.onapName = onapName;
}
+
+ /**
+ * Sets the ONAP Name field of the Policy Parameters.
+ *
+ * @param ecompName the <code>String</code> format of the ONAP Name
+ * @deprecated use {@link #setOnapName(String)} instead.
+ */
+ @Deprecated
+ public void setEcompName(String ecompName) {
+ this.onapName = ecompName;
+ }
+
/**
* Gets the Config Name value of the Policy Parameters.
@@ -486,10 +509,10 @@ public class PolicyParameters {
/**
* Sets the TTLDate field of the Policy Parameters.
*
- * @param TTLDate the <code>Date</code> format of the TTLDate value
+ * @param ttlDate the <code>Date</code> format of the TTLDate value
*/
- public void setTtlDate(Date TTLDate){
- this.TTLDate = TTLDate;
+ public void setTtlDate(Date ttlDate){
+ this.ttlDate = ttlDate;
}
/**
@@ -498,7 +521,7 @@ public class PolicyParameters {
* @return the <code>Date</code> value of the TTLDate for Config Policies
*/
public Date getTtlDate(){
- return TTLDate;
+ return ttlDate;
}
/**
diff --git a/PolicyEngineAPI/src/main/java/org/onap/policy/std/StdPolicyEngine.java b/PolicyEngineAPI/src/main/java/org/onap/policy/std/StdPolicyEngine.java
index 608bb8de0..8a6c6c668 100644
--- a/PolicyEngineAPI/src/main/java/org/onap/policy/std/StdPolicyEngine.java
+++ b/PolicyEngineAPI/src/main/java/org/onap/policy/std/StdPolicyEngine.java
@@ -205,8 +205,8 @@ public class StdPolicyEngine {
/*
* getDecision using the decision Attributes.
*/
- public DecisionResponse getDecision(String onapComponentName, Map<String, String> decisionAttributes, UUID requestID) throws PolicyDecisionException {
- return getDecisionImpl(onapComponentName, decisionAttributes, requestID);
+ public DecisionResponse getDecision(String onapName, Map<String, String> decisionAttributes, UUID requestID) throws PolicyDecisionException {
+ return getDecisionImpl(onapName, decisionAttributes, requestID);
}
/*
@@ -218,7 +218,7 @@ public class StdPolicyEngine {
LOGGER.error(message);
throw new PolicyDecisionException(message);
}
- return getDecisionImpl(decisionRequestParameters.getONAPComponentName(), decisionRequestParameters.getDecisionAttributes(), decisionRequestParameters.getRequestID());
+ return getDecisionImpl(decisionRequestParameters.getOnapName(), decisionRequestParameters.getDecisionAttributes(), decisionRequestParameters.getRequestID());
}
/*
@@ -523,7 +523,7 @@ public class StdPolicyEngine {
}
}
- public DecisionResponse getDecisionImpl(String onapComponentName,
+ public DecisionResponse getDecisionImpl(String onapName,
Map<String, String> decisionAttributes,
UUID requestID) throws PolicyDecisionException {
String resource= "getDecision";
@@ -533,7 +533,7 @@ public class StdPolicyEngine {
try {
DecisionRequestParameters decisionRequestParameters = new DecisionRequestParameters();
decisionRequestParameters.setDecisionAttributes(decisionAttributes);
- decisionRequestParameters.setONAPComponentName(onapComponentName);
+ decisionRequestParameters.setOnapName(onapName);
decisionRequestParameters.setRequestID(requestID);
body = PolicyUtils.objectToJsonString(decisionRequestParameters);
} catch (JsonProcessingException e) {
diff --git a/PolicyEngineAPI/src/test/java/org/onap/policy/test/DecisionRequestParametersTest.java b/PolicyEngineAPI/src/test/java/org/onap/policy/test/DecisionRequestParametersTest.java
index 746822f94..a29bb1314 100644
--- a/PolicyEngineAPI/src/test/java/org/onap/policy/test/DecisionRequestParametersTest.java
+++ b/PolicyEngineAPI/src/test/java/org/onap/policy/test/DecisionRequestParametersTest.java
@@ -51,7 +51,7 @@ public class DecisionRequestParametersTest {
// add additional test code here
assertNotNull(result);
- assertEquals(null, result.getONAPComponentName());
+ assertEquals(null, result.getOnapName());
assertEquals(null, result.getDecisionAttributes());
assertEquals(null, result.getRequestID());
}
@@ -74,7 +74,7 @@ public class DecisionRequestParametersTest {
// add additional test code here
assertNotNull(result);
- assertEquals("", result.getONAPComponentName());
+ assertEquals("", result.getOnapName());
}
/**
@@ -108,7 +108,7 @@ public class DecisionRequestParametersTest {
throws Exception {
DecisionRequestParameters fixture = new DecisionRequestParameters("", new Hashtable<String, String>(), UUID.randomUUID());
- String result = fixture.getONAPComponentName();
+ String result = fixture.getOnapName();
// add additional test code here
assertEquals("", result);
@@ -168,7 +168,7 @@ public class DecisionRequestParametersTest {
DecisionRequestParameters fixture = new DecisionRequestParameters("", new Hashtable<String, String>(), UUID.randomUUID());
String onapComponentName = "";
- fixture.setONAPComponentName(onapComponentName);
+ fixture.setOnapName(onapComponentName);
// add additional test code here
}