Initial OpenECOMP policy/engine commit

[policy/engine.git] / PolicyEngineAPI / src / main / java / org / openecomp / policy / api / ConfigRequestParameters.java

diff --git a/PolicyEngineAPI/src/main/java/org/openecomp/policy/api/ConfigRequestParameters.java b/PolicyEngineAPI/src/main/java/org/openecomp/policy/api/ConfigRequestParameters.java
new file mode 100644 (file)
index 0000000..1830679
--- /dev/null
+++ b/PolicyEngineAPI/src/main/java/org/openecomp/policy/api/ConfigRequestParameters.java
@@ -0,0 +1,148 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * PolicyEngineAPI
+ * ================================================================================
+ * Copyright (C) 2017 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.openecomp.policy.api;
+
+import java.util.Map;
+import java.util.UUID;
+
+/**
+ * <code>ConfigRequestParameters</code> defines the Config Policy Request Parameters
+ *  which retrieve(s) the policy from PDP if the request parameters match with any Config Policy.  
+ * 
+ * @version 0.1
+ */
+public class ConfigRequestParameters {
+       private String policyName;
+       private String eCOMPComponentName;
+       private String configName;
+       private Map<String,String> configAttributes;
+       private UUID requestID;
+       private Boolean unique = false;
+       
+       /**
+        * Sets the PolicyName of the Config policy which needs to be retrieved. 
+        * 
+        * @param policyName the <code>String</code> format of the PolicyFile Name whose configuration is required.
+        */
+       public void setPolicyName(String policyName){
+               this.policyName = policyName;
+       }
+       
+       /**
+        * Sets the ECOMP Component Name of the Config policy which needs to be retrieved. 
+        * 
+        * @param eCOMPComponentName the <code>String</code> format of the eCOMPComponentName whose configuration is required.
+        */
+       public void setEcompName(String eCOMPComponentName){
+               this.eCOMPComponentName = eCOMPComponentName;
+       }
+       
+       /**
+        * 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.
+        */
+       public void setConfigName(String configName){
+               this.configName = configName;
+       }
+       
+       /**
+        * Sets the ConfigAttributes of the Config policy which needs to be retrieved. 
+        * 
+        * @param configAttributes the <code>Map</code> of <code>String,String</code> format of the configuration attributes which are required.
+        */
+       public void setConfigAttributes(Map<String, String> configAttributes){
+               this.configAttributes = configAttributes;
+       }
+       
+       /**
+        * Sets the Request ID of the ECOMP request. 
+        * 
+        * @param requestID unique <code>UUID</code> requestID which will be passed throughout the ECOMP components to correlate logging messages.
+        */
+       public void setRequestID(UUID requestID){
+               this.requestID = requestID;
+       }
+       
+       /**
+        * Gets the policyName of the Request Parameters.
+        * 
+        * @return <code>String</code> format of the policyName.
+        */
+       public String getPolicyName(){
+               return policyName;
+       }
+       
+       /**
+        * Gets the ECOMP Component Name of the Request Parameters. 
+        * 
+        * @return <code>String</code> format of the ECOMP Component Name. 
+        */
+       public String getEcompName(){
+               return eCOMPComponentName;
+       }
+       
+       /**
+        * Gets the Config name of the Request Parameters. 
+        * 
+        * @return <code>String</code> format of the Config Name.  
+        */
+       public String getConfigName(){
+               return configName;
+       }
+       
+       /**
+        *  Gets the Config Attributes of the Request Parameters. 
+        *  
+        * @return <code>Map</code> of <code>String</code>,<code>String</code> format of the config Attributes. 
+        */
+       public Map<String,String> getConfigAttributes(){
+               return configAttributes;
+       }
+       
+       /**
+        *  Gets the Request ID of the Request Paramters.
+        *  
+        * @return <code>UUID</code> format of requestID. 
+        */
+       public UUID getRequestID(){
+               return requestID;
+       }
+       
+       /**
+        * Makes the results Unique, priority based. If set to True. Default Value is set to False. 
+        * 
+        * @param unique flag which is either true or false. 
+        */
+       public void makeUnique(Boolean unique){
+               this.unique = unique;
+       }
+       
+       /**
+        * Gets the Unique flag value from the Config Request Parameters. 
+        * 
+        * @return unique flag which is either true or false. 
+        */
+       public Boolean getUnique(){
+               return this.unique;
+       }
+
+}