Add JUnit tests policy/engine PolicyEngineAPI

[policy/engine.git] / PolicyEngineAPI / src / main / java / org / onap / policy / api / PolicyEngine.java

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 2b5252c..0d224ce 100644 (file)
--- a/PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyEngine.java
+++ b/PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyEngine.java
@@ -37,7 +37,7 @@ import org.onap.policy.std.StdPolicyEngine;
  */
 public class PolicyEngine{
        private String propertyFilePath = null;
-       private StdPolicyEngine stdPolicyEngine;
+       private final StdPolicyEngine stdPolicyEngine;
        private NotificationScheme scheme = null;
        private NotificationHandler handler = null;
        
@@ -47,7 +47,7 @@ public class PolicyEngine{
         * @param propertiesFilePathname the <code>String</code> format of the propertiesFilePathname 
         * @throws PolicyEngineException PolicyEngine Exception
         */
-       public PolicyEngine(String propertiesFilePathname) throws PolicyEngineException {
+       public PolicyEngine(final String propertiesFilePathname) throws PolicyEngineException {
                this.propertyFilePath = propertiesFilePathname ; 
                this.stdPolicyEngine= new StdPolicyEngine(this.propertyFilePath, (String)null);
        }
@@ -59,7 +59,7 @@ public class PolicyEngine{
         * @param clientKey depicts String format of Password/ Client_Key.  
         * @throws PolicyEngineException PolicyEngine Exception
         */
-       public PolicyEngine(String propertiesFilePathname, String clientKey) throws PolicyEngineException {
+       public PolicyEngine(final String propertiesFilePathname, final String clientKey) throws PolicyEngineException {
                this.propertyFilePath = propertiesFilePathname ; 
                this.stdPolicyEngine= new StdPolicyEngine(this.propertyFilePath, clientKey);
        }
@@ -71,7 +71,7 @@ public class PolicyEngine{
         * @param scheme the <code>NotificationScheme</code> of {@link org.onap.policy.api.NotificationScheme} which defines the Notification Scheme
         * @throws PolicyEngineException PolicyEngine Exception
         */
-       public PolicyEngine(String propertiesFilePathname, NotificationScheme scheme) throws PolicyEngineException{
+       public PolicyEngine(final String propertiesFilePathname, final NotificationScheme scheme) throws PolicyEngineException{
                this.propertyFilePath = propertiesFilePathname;
                this.scheme = scheme;
                this.stdPolicyEngine = new StdPolicyEngine(this.propertyFilePath, this.scheme);
@@ -85,7 +85,7 @@ public class PolicyEngine{
         *  @param handler the <code>NotificationHandler</code> of {@link org.onap.policy.api.NotificationHandler} which defines what should happen when a notification is received.
         *  @throws PolicyEngineException PolicyEngine Exception
         */
-       public PolicyEngine(String propertiesFilePathname, NotificationScheme scheme, NotificationHandler handler) throws PolicyEngineException {
+       public PolicyEngine(final String propertiesFilePathname, final NotificationScheme scheme, final NotificationHandler handler) throws PolicyEngineException {
                this.propertyFilePath = propertiesFilePathname ;
                this.scheme = scheme;
                this.handler = handler;
@@ -101,7 +101,7 @@ public class PolicyEngine{
         * @deprecated use {@link #getConfig(ConfigRequestParameters configRequestParameters)} Instead.
         */
        @Deprecated
-       public Collection<PolicyConfig> getConfigByPolicyName(String policyName) throws PolicyConfigException {
+       public Collection<PolicyConfig> getConfigByPolicyName(final String policyName) throws PolicyConfigException {
                return getConfig(setConfigRequestParameters(policyName, null, null, null, null));
        }
        
@@ -116,7 +116,7 @@ public class PolicyEngine{
         * @deprecated use {@link #getConfig(ConfigRequestParameters configRequestParameters)} Instead.
         */
        @Deprecated
-       public Collection<PolicyConfig> getConfigByPolicyName(String policyName, UUID requestID) throws PolicyConfigException {
+       public Collection<PolicyConfig> getConfigByPolicyName(final String policyName, final UUID requestID) throws PolicyConfigException {
                return getConfig(setConfigRequestParameters(policyName, null, null, null, requestID));  
        }
        
@@ -129,7 +129,7 @@ public class PolicyEngine{
         * @deprecated use {@link #getConfig(ConfigRequestParameters)} Instead.
         */
        @Deprecated
-       public Collection<PolicyConfig> getConfig(String onapName) throws PolicyConfigException {
+       public Collection<PolicyConfig> getConfig(final String onapName) throws PolicyConfigException {
                return getConfig(setConfigRequestParameters(null, onapName, null, null, null));
        }
        
@@ -144,7 +144,7 @@ public class PolicyEngine{
         * @deprecated use {@link #getConfig(ConfigRequestParameters)} Instead.
         */
        @Deprecated
-       public Collection<PolicyConfig> getConfig(String onapName, UUID requestID) throws PolicyConfigException {
+       public Collection<PolicyConfig> getConfig(final String onapName, final UUID requestID) throws PolicyConfigException {
                return getConfig(setConfigRequestParameters(null, onapName, null, null, requestID));
        }
        
@@ -160,7 +160,7 @@ public class PolicyEngine{
         * @deprecated use {@link #getConfig(ConfigRequestParameters)} Instead.
         */
        @Deprecated
-       public Collection<PolicyConfig> getConfig(String onapName, String configName) throws PolicyConfigException {
+       public Collection<PolicyConfig> getConfig(final String onapName, final String configName) throws PolicyConfigException {
                return getConfig(setConfigRequestParameters(null, onapName, configName, null, null));
        }
        
@@ -178,7 +178,7 @@ public class PolicyEngine{
         * @deprecated use {@link #getConfig(ConfigRequestParameters)} Instead.
         */
        @Deprecated
-       public Collection<PolicyConfig> getConfig(String onapName, String configName, UUID requestID) throws PolicyConfigException {
+       public Collection<PolicyConfig> getConfig(final String onapName, final String configName, final UUID requestID) throws PolicyConfigException {
                return getConfig(setConfigRequestParameters(null, onapName, configName, null, requestID));
        }
        
@@ -195,7 +195,7 @@ public class PolicyEngine{
         * @deprecated use {@link #getConfig(ConfigRequestParameters)} Instead.
         */
        @Deprecated
-       public Collection<PolicyConfig> getConfig(String onapName, String configName, Map<String, String> configAttributes) throws PolicyConfigException{
+       public Collection<PolicyConfig> getConfig(final String onapName, final String configName, final Map<String, String> configAttributes) throws PolicyConfigException{
                return getConfig(setConfigRequestParameters(null, onapName, configName, configAttributes, null));
        }
        
@@ -214,7 +214,7 @@ public class PolicyEngine{
         * @deprecated use {@link #getConfig(ConfigRequestParameters)} Instead.
         */
        @Deprecated
-       public Collection<PolicyConfig> getConfig(String onapName, String configName, Map<String, String> configAttributes, UUID requestID) throws PolicyConfigException{
+       public Collection<PolicyConfig> getConfig(final String onapName, final String configName, final Map<String, String> configAttributes, final UUID requestID) throws PolicyConfigException{
                return getConfig(setConfigRequestParameters(null, onapName, configName, configAttributes, requestID));
        }
        
@@ -226,7 +226,7 @@ public class PolicyEngine{
         * @return <code>Collection</code> of {@link org.onap.policy.api.PolicyConfig} which has the configuration.
         * @throws PolicyConfigException PolicyConfig Exception
         */
-       public Collection<PolicyConfig> getConfig(ConfigRequestParameters configRequestParameters)  throws PolicyConfigException{
+       public Collection<PolicyConfig> getConfig(final ConfigRequestParameters configRequestParameters)  throws PolicyConfigException{
                return stdPolicyEngine.getConfig(configRequestParameters);
        }
        
@@ -238,7 +238,7 @@ public class PolicyEngine{
         * @return <code>Collection</code> of <code>String</code> which returns the list of policies.
         * @throws PolicyConfigException PolicyConfig Exception
         */
-       public Collection<String> listConfig(ConfigRequestParameters listPolicyRequestParameters)  throws PolicyConfigException{
+       public Collection<String> listConfig(final ConfigRequestParameters listPolicyRequestParameters)  throws PolicyConfigException{
                return stdPolicyEngine.listConfig(listPolicyRequestParameters);
        }
        
@@ -252,7 +252,7 @@ public class PolicyEngine{
         * @deprecated use {@link #sendEvent(EventRequestParameters)} Instead.
         */
        @Deprecated
-       public Collection<PolicyResponse> sendEvent(Map<String, String> eventAttributes) throws PolicyEventException {
+       public Collection<PolicyResponse> sendEvent(final Map<String, String> eventAttributes) throws PolicyEventException {
                return stdPolicyEngine.sendEvent(eventAttributes, (UUID) null);
        }
        
@@ -267,7 +267,7 @@ public class PolicyEngine{
         * @deprecated use {@link #sendEvent(EventRequestParameters)} Instead.
         */
        @Deprecated
-       public Collection<PolicyResponse> sendEvent(Map<String, String> eventAttributes, UUID requestID) throws PolicyEventException {
+       public Collection<PolicyResponse> sendEvent(final Map<String, String> eventAttributes, final UUID requestID) throws PolicyEventException {
                return stdPolicyEngine.sendEvent(eventAttributes, requestID);
        }
        
@@ -278,7 +278,7 @@ public class PolicyEngine{
         * @return <code>Collection</code> of {@link org.onap.policy.api.PolicyResponse} which has the Response.
         * @throws PolicyEventException PolicyEvent Exception
         */
-       public Collection<PolicyResponse> sendEvent(EventRequestParameters eventRequestParameters) throws PolicyEventException {
+       public Collection<PolicyResponse> sendEvent(final EventRequestParameters eventRequestParameters) throws PolicyEventException {
                return stdPolicyEngine.sendEvent(eventRequestParameters);
        }
        
@@ -292,7 +292,7 @@ public class PolicyEngine{
         * @deprecated use {@link #getDecision(DecisionRequestParameters)} Instead.
         */
        @Deprecated
-       public DecisionResponse getDecision(String onapName, Map<String,String> decisionAttributes) throws PolicyDecisionException {
+       public DecisionResponse getDecision(final String onapName, final Map<String,String> decisionAttributes) throws PolicyDecisionException {
                return stdPolicyEngine.getDecision(onapName, decisionAttributes, null);
        }
        
@@ -308,7 +308,7 @@ public class PolicyEngine{
         * @deprecated use {@link #getDecision(DecisionRequestParameters)} Instead.
         */
        @Deprecated
-       public DecisionResponse getDecision(String onapName, Map<String,String> decisionAttributes, UUID requestID) throws PolicyDecisionException {
+       public DecisionResponse getDecision(final String onapName, final Map<String,String> decisionAttributes, final UUID requestID) throws PolicyDecisionException {
                return stdPolicyEngine.getDecision(onapName, decisionAttributes, requestID);
        }
        
@@ -319,7 +319,7 @@ public class PolicyEngine{
         * @return {@link org.onap.policy.api.DecisionResponse} which has the Decision.
         * @throws PolicyDecisionException PolicyDecision Exception
         */
-       public DecisionResponse getDecision(DecisionRequestParameters decisionRequestParameters) throws PolicyDecisionException {
+       public DecisionResponse getDecision(final DecisionRequestParameters decisionRequestParameters) throws PolicyDecisionException {
                return stdPolicyEngine.getDecision(decisionRequestParameters);
        }
        
@@ -331,7 +331,7 @@ public class PolicyEngine{
         * @throws PolicyException PolicyException related to the operation      
         * 
         * */
-       public MetricsResponse getMetrics(MetricsRequestParameters parameters) throws PolicyException {
+       public MetricsResponse getMetrics(final MetricsRequestParameters parameters) throws PolicyException {
                return stdPolicyEngine.getMetrics(parameters);
        }
        
@@ -356,9 +356,9 @@ public class PolicyEngine{
         * @deprecated use {@link #createPolicy(PolicyParameters)} Instead.
         */
        @Deprecated
-       public String createConfigPolicy(String policyName, String policyDescription, String onapName, String configName, 
-                                                                                               Map<String, String> configAttributes, String configType, String body, String policyScope, UUID requestID,
-                                                                                               String riskLevel, String riskType, String guard, String ttlDate) throws PolicyException {
+       public String createConfigPolicy(final String policyName, final String policyDescription, final String onapName, final String configName, 
+                                                                                               final Map<String, String> configAttributes, final String configType, final String body, final String policyScope, final UUID requestID,
+                                                                                               final String riskLevel, final String riskType, final String guard, final String ttlDate) throws PolicyException {
                return stdPolicyEngine.createUpdateConfigPolicy(policyName, policyDescription, onapName, configName, 
                                configAttributes, configType, body, policyScope, requestID,
                                riskLevel, riskType, guard, ttlDate, false);
@@ -385,9 +385,9 @@ public class PolicyEngine{
         * @deprecated use {@link #updatePolicy(PolicyParameters)} Instead.
         */
        @Deprecated
-       public String updateConfigPolicy(String policyName, String policyDescription, String onapName, String configName, 
-                                                                                               Map<String, String> configAttributes, String configType, String body, String policyScope, UUID requestID,
-                                                                                               String riskLevel, String riskType, String guard, String ttlDate) throws PolicyException {
+       public String updateConfigPolicy(final String policyName, final String policyDescription, final String onapName, final String configName, 
+                                                                                               final Map<String, String> configAttributes, final String configType, final String body, final String policyScope, final UUID requestID,
+                                                                                               final String riskLevel, final String riskType, final String guard, final String ttlDate) throws PolicyException {
                return stdPolicyEngine.createUpdateConfigPolicy(policyName, policyDescription, onapName, configName, 
                                configAttributes, configType, body, policyScope, requestID,riskLevel, riskType, guard, ttlDate, true);
        }
@@ -408,8 +408,8 @@ public class PolicyEngine{
         * @deprecated use {@link #createPolicy(PolicyParameters)} Instead.
         */
        @Deprecated
-       public String createConfigFirewallPolicy(String policyName, JsonObject firewallJson, String policyScope, UUID requestID,
-                       String riskLevel, String riskType, String guard, String ttlDate) throws PolicyException {
+       public String createConfigFirewallPolicy(final String policyName, final JsonObject firewallJson, final String policyScope, final UUID requestID,
+                       final String riskLevel, final String riskType, final String guard, final String ttlDate) throws PolicyException {
                return stdPolicyEngine.createUpdateConfigFirewallPolicy(policyName, firewallJson, policyScope, requestID,riskLevel, 
                                riskType, guard, ttlDate, false);
        }
@@ -430,8 +430,8 @@ public class PolicyEngine{
         * @deprecated use {@link #updatePolicy(PolicyParameters)} Instead.
         */
        @Deprecated
-       public String updateConfigFirewallPolicy(String policyName, JsonObject firewallJson, String policyScope, UUID requestID,
-                       String riskLevel, String riskType, String guard, String ttlDate) throws PolicyException {
+       public String updateConfigFirewallPolicy(final String policyName, final JsonObject firewallJson, final String policyScope, final UUID requestID,
+                       final String riskLevel, final String riskType, final String guard, final String ttlDate) throws PolicyException {
                return stdPolicyEngine.createUpdateConfigFirewallPolicy(policyName, firewallJson, policyScope, requestID,riskLevel, riskType, guard, ttlDate, true);
        }
        
@@ -443,7 +443,7 @@ public class PolicyEngine{
         * @throws PolicyException PolicyException related to the operation      
         * 
         * */
-       public DictionaryResponse getDictionaryItem(DictionaryParameters parameters) throws PolicyException {
+       public DictionaryResponse getDictionaryItem(final DictionaryParameters parameters) throws PolicyException {
                return stdPolicyEngine.getDictionaryItem(parameters);
        }
        
@@ -454,7 +454,7 @@ public class PolicyEngine{
         * @return {@link org.onap.policy.api.PolicyChangeResponse} which consists of the response related to create dictionary item Request. 
         * @throws PolicyException  PolicyException related to the operation. 
         */
-       public PolicyChangeResponse createDictionaryItem(DictionaryParameters parameters) throws PolicyException {
+       public PolicyChangeResponse createDictionaryItem(final DictionaryParameters parameters) throws PolicyException {
                return stdPolicyEngine.createDictionaryItem(parameters);
        }
        
@@ -465,7 +465,7 @@ public class PolicyEngine{
         * @return {@link org.onap.policy.api.PolicyChangeResponse} which consists of the response related to update dictionary item Request. 
         * @throws PolicyException PolicyException related to the operation. 
         */
-       public PolicyChangeResponse updateDictionaryItem(DictionaryParameters parameters) throws PolicyException {
+       public PolicyChangeResponse updateDictionaryItem(final DictionaryParameters parameters) throws PolicyException {
                return stdPolicyEngine.updateDictionaryItem(parameters);
        }
        
@@ -476,7 +476,7 @@ public class PolicyEngine{
         * @return {@link org.onap.policy.api.PolicyChangeResponse} which consists of the response related to create policy Request. 
         * @throws PolicyException  PolicyException related to the operation. 
         */
-       public PolicyChangeResponse createPolicy(PolicyParameters policyParameters) throws PolicyException {
+       public PolicyChangeResponse createPolicy(final PolicyParameters policyParameters) throws PolicyException {
                return stdPolicyEngine.createPolicy(policyParameters);
        }
        
@@ -487,7 +487,7 @@ public class PolicyEngine{
         * @return {@link org.onap.policy.api.PolicyChangeResponse} which consists of the response related to create policy Request. 
         * @throws PolicyException  PolicyException related to the operation. 
         */
-       public PolicyChangeResponse updatePolicy(PolicyParameters policyParameters) throws PolicyException {
+       public PolicyChangeResponse updatePolicy(final PolicyParameters policyParameters) throws PolicyException {
                return stdPolicyEngine.updatePolicy(policyParameters);
        }
        
@@ -504,7 +504,7 @@ public class PolicyEngine{
         * @deprecated use {@link #pushPolicy(PushPolicyParameters)} instead. 
         */
        @Deprecated
-       public String pushPolicy(String policyScope, String policyName, String policyType, String pdpGroup, UUID requestID) throws PolicyException {
+       public String pushPolicy(final String policyScope, final String policyName, final String policyType, final String pdpGroup, final UUID requestID) throws PolicyException {
                return stdPolicyEngine.pushPolicy(policyScope, policyName, policyType, pdpGroup, requestID);
        }
        
@@ -515,7 +515,7 @@ public class PolicyEngine{
         * @return {@link org.onap.policy.api.PolicyChangeResponse} which consists of the response related to the push Policy Request. 
         * @throws PolicyException  PolicyException related to the operation. 
         */
-       public PolicyChangeResponse pushPolicy(PushPolicyParameters pushPolicyParameters) throws PolicyException {
+       public PolicyChangeResponse pushPolicy(final PushPolicyParameters pushPolicyParameters) throws PolicyException {
                return stdPolicyEngine.pushPolicy(pushPolicyParameters);
        }
        
@@ -526,7 +526,7 @@ public class PolicyEngine{
         * @return {@link org.onap.policy.api.PolicyChangeResponse} which consists of the response related to the Delete Policy Request.
         * @throws PolicyException PolicyException related to the operation. 
         */
-       public PolicyChangeResponse deletePolicy(DeletePolicyParameters deletePolicyParameters) throws PolicyException {
+       public PolicyChangeResponse deletePolicy(final DeletePolicyParameters deletePolicyParameters) throws PolicyException {
                return stdPolicyEngine.deletePolicy(deletePolicyParameters);
        }
        
@@ -537,7 +537,7 @@ public class PolicyEngine{
         * @return {@link org.onap.policy.api.PolicyChangeResponse} which consists of the response related to create import Service. 
         * @throws PolicyException PolicyException related to the operation. 
         */
-       public PolicyChangeResponse policyEngineImport(ImportParameters importParameters) throws PolicyException {
+       public PolicyChangeResponse policyEngineImport(final ImportParameters importParameters) throws PolicyException {
                return stdPolicyEngine.policyEngineImport(importParameters);
        }
        
@@ -547,7 +547,7 @@ public class PolicyEngine{
         * @param scheme the <code>NotificationScheme</code> of {@link org.onap.policy.api.NotificationScheme} which defines the Notification Scheme
         * @param handler the <code>NotificationHandler</code> of {@link org.onap.policy.api.NotificationHandler} which defines what should happen when a notification is received.
         */
-       public void setNotification(NotificationScheme scheme, NotificationHandler handler) {
+       public void setNotification(final NotificationScheme scheme, final NotificationHandler handler) {
                this.scheme = scheme;
                this.handler = handler;
                stdPolicyEngine.notification(this.scheme,this.handler);
@@ -565,7 +565,7 @@ public class PolicyEngine{
         * 
         * @param scheme the <code>NotificationScheme</code> of {@link org.onap.policy.api.NotificationScheme} which defines the Notification Scheme
         */
-       public void setScheme(NotificationScheme scheme){
+       public void setScheme(final NotificationScheme scheme){
                this.scheme = scheme;
                stdPolicyEngine.setScheme(this.scheme);
        }
@@ -585,13 +585,13 @@ public class PolicyEngine{
         *   
         * @param clientKey depicts String format of Password/ Client_Key.  
         */
-       public void setClientKey(String clientKey){
+       public void setClientKey(final String clientKey){
                StdPolicyEngine.setClientKey(clientKey);
        }
        
        // Internal Setter Method to help build configRequestParameters.
-       private ConfigRequestParameters setConfigRequestParameters(String policyName, String onapName, String configName, Map<String, String> configAttributes, UUID requestID){
-               ConfigRequestParameters configRequestParameters = new ConfigRequestParameters();
+       private ConfigRequestParameters setConfigRequestParameters(final String policyName, final String onapName, final String configName, final Map<String, String> configAttributes, final UUID requestID){
+               final ConfigRequestParameters configRequestParameters = new ConfigRequestParameters();
                configRequestParameters.setPolicyName(policyName);
                configRequestParameters.setOnapName(onapName);
                configRequestParameters.setConfigName(configName);