* ============LICENSE_END=========================================================
*/
-package org.openecomp.policy.api;
+package org.onap.policy.api;
import java.util.Collection;
import java.util.Map;
import javax.json.JsonObject;
-import org.openecomp.policy.api.NotificationHandler;
-import org.openecomp.policy.api.PDPNotification;
-import org.openecomp.policy.std.StdPolicyEngine;
+import org.onap.policy.api.NotificationHandler;
+import org.onap.policy.api.PDPNotification;
+import org.onap.policy.std.StdPolicyEngine;
/**
* PolicyEngine is the Interface that applications use to make policy queries against a PEPEngine
* PolicyEngine Constructor with <code>String</code> format of PropertiesFilePathname and <code>NotificationScheme</code>
*
* @param propertiesFilePathname the <code>String</code> format of the propertiesFilePathname
- * @param scheme the <code>NotificationScheme</code> of {@link org.openecomp.policy.api.NotificationScheme} which defines the Notification Scheme
+ * @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{
* PolicyEngine Constructor with <code>String</code> format of PropertiesFilePathname, <code>NotificationScheme</code> and <code>NotificationHandler</code>
*
* @param propertiesFilePathname the <code>String</code> format of the propertiesFilePathname
- * @param scheme the <code>NotificationScheme</code> of {@link org.openecomp.policy.api.NotificationScheme} which defines the Notification Scheme
- * @param handler the <code>NotificationHandler</code> of {@link org.openecomp.policy.api.NotificationHandler} which defines what should happen when a notification is received.
+ * @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.
* @throws PolicyEngineException PolicyEngine Exception
*/
public PolicyEngine(String propertiesFilePathname, NotificationScheme scheme, NotificationHandler handler) throws PolicyEngineException {
* Gets the configuration from the PolicyDecisionPoint(PDP) for the <code>String</code> which represents the Policy File Name
*
* @param policyName the <code>String</code> format of the PolicyFile Name whose configuration is required.
- * @return <code>Collection</code> of {@link org.openecomp.policy.api.PolicyConfig} which has the configuration.
+ * @return <code>Collection</code> of {@link org.onap.policy.api.PolicyConfig} which has the configuration.
* @throws PolicyConfigException PolicyConfig Exception
* @deprecated use {@link #getConfig(ConfigRequestParameters configRequestParameters)} Instead.
*/
* Gets the configuration from the PolicyDecisionPoint(PDP) for the <code>String</code> which represents the Policy File Name
*
* @param policyName the <code>String</code> format of the PolicyFile Name whose configuration is required.
- * @param requestID unique request ID which will be passed throughout the ECOMP components to correlate logging messages.
+ * @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.
- * @return <code>Collection</code> of {@link org.openecomp.policy.api.PolicyConfig} which has the configuration.
+ * @return <code>Collection</code> of {@link org.onap.policy.api.PolicyConfig} which has the configuration.
* @throws PolicyConfigException PolicyConfig Exception
* @deprecated use {@link #getConfig(ConfigRequestParameters configRequestParameters)} Instead.
*/
}
/**
- * Gets the configuration from the PolicyDecisionPoint(PDP) for the <code>String</code> which represents the eCOMPComponentName
+ * Gets the configuration from the PolicyDecisionPoint(PDP) for the <code>String</code> which represents the onapComponentName
*
- * @param eCOMPComponentName the <code>String</code> format of the eCOMPComponentName whose configuration is required.
- * @return <code>Collection</code> of {@link org.openecomp.policy.api.PolicyConfig} which has the configuration.
+ * @param onapComponentName the <code>String</code> format of the onapComponentName 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 eCOMPComponentName) throws PolicyConfigException {
- return getConfig(setConfigRequestParameters(null, eCOMPComponentName, null, null, null));
+ public Collection<PolicyConfig> getConfig(String onapComponentName) throws PolicyConfigException {
+ return getConfig(setConfigRequestParameters(null, onapComponentName, null, null, null));
}
/**
- * Gets the configuration from the PolicyDecisionPoint(PDP) for the <code>String</code> which represents the eCOMPComponentName
+ * Gets the configuration from the PolicyDecisionPoint(PDP) for the <code>String</code> which represents the onapComponentName
*
- * @param eCOMPComponentName the <code>String</code> format of the eCOMPComponentName whose configuration is required.
- * @return <code>Collection</code> of {@link org.openecomp.policy.api.PolicyConfig} which has the configuration.
- * @param requestID unique request ID which will be passed throughout the ECOMP components to correlate logging messages.
+ * @param onapComponentName the <code>String</code> format of the onapComponentName 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.
* @throws PolicyConfigException PolicyConfig Exception
* @deprecated use {@link #getConfig(ConfigRequestParameters)} Instead.
*/
@Deprecated
- public Collection<PolicyConfig> getConfig(String eCOMPComponentName, UUID requestID) throws PolicyConfigException {
- return getConfig(setConfigRequestParameters(null, eCOMPComponentName, null, null, requestID));
+ public Collection<PolicyConfig> getConfig(String onapComponentName, UUID requestID) throws PolicyConfigException {
+ return getConfig(setConfigRequestParameters(null, onapComponentName, null, null, requestID));
}
/**
- * Requests the configuration of the <code>String</code> which represents the eCOMPComponentName and <code>String</code>
+ * Requests the configuration of the <code>String</code> which represents the onapComponentName and <code>String</code>
* which represents the configName and returns the configuration if different Configurations exist for the
- * particular eCOMPComponentName.
+ * particular onapComponentName.
*
- * @param eCOMPComponentName the <code>String</code> format of the eCOMPComponentName whose configuration is required.
+ * @param onapComponentName the <code>String</code> format of the onapComponentName 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.openecomp.policy.api.PolicyConfig} which has the configuration.
+ * @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 eCOMPComponentName, String configName) throws PolicyConfigException {
- return getConfig(setConfigRequestParameters(null, eCOMPComponentName, configName, null, null));
+ public Collection<PolicyConfig> getConfig(String onapComponentName, String configName) throws PolicyConfigException {
+ return getConfig(setConfigRequestParameters(null, onapComponentName, configName, null, null));
}
/**
- * Requests the configuration of the <code>String</code> which represents the eCOMPComponentName and <code>String</code>
+ * Requests the configuration of the <code>String</code> which represents the onapComponentName and <code>String</code>
* which represents the configName and returns the configuration if different Configurations exist for the
- * particular eCOMPComponentName.
+ * particular onapComponentName.
*
- * @param eCOMPComponentName the <code>String</code> format of the eCOMPComponentName whose configuration is required.
+ * @param onapComponentName the <code>String</code> format of the onapComponentName 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 ECOMP components to correlate logging messages.
+ * @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.
- * @return <code>Collection</code> of {@link org.openecomp.policy.api.PolicyConfig} which has the configuration.
+ * @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 eCOMPComponentName, String configName, UUID requestID) throws PolicyConfigException {
- return getConfig(setConfigRequestParameters(null, eCOMPComponentName, configName, null, requestID));
+ public Collection<PolicyConfig> getConfig(String onapComponentName, String configName, UUID requestID) throws PolicyConfigException {
+ return getConfig(setConfigRequestParameters(null, onapComponentName, configName, null, requestID));
}
/**
- * Requests the configuration of the <code>String</code> which represents the eCOMPComponentName, <code>String</code>
+ * Requests the configuration of the <code>String</code> which represents the onapComponentName, <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 eCOMPComponentName the <code>String</code> format of the eCOMPComponentName whose configuration is required.
+ * @param onapComponentName the <code>String</code> format of the onapComponentName 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.openecomp.policy.api.PolicyConfig} which has the configuration.
+ * @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 eCOMPComponentName, String configName, Map<String, String> configAttributes) throws PolicyConfigException{
- return getConfig(setConfigRequestParameters(null, eCOMPComponentName, configName, configAttributes, null));
+ public Collection<PolicyConfig> getConfig(String onapComponentName, String configName, Map<String, String> configAttributes) throws PolicyConfigException{
+ return getConfig(setConfigRequestParameters(null, onapComponentName, configName, configAttributes, null));
}
/**
- * Requests the configuration of the <code>String</code> which represents the eCOMPComponentName, <code>String</code>
+ * Requests the configuration of the <code>String</code> which represents the onapComponentName, <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 eCOMPComponentName the <code>String</code> format of the eCOMPComponentName whose configuration is required.
+ * @param onapComponentName the <code>String</code> format of the onapComponentName 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 ECOMP components to correlate logging messages.
+ * @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.
- * @return <code>Collection</code> of {@link org.openecomp.policy.api.PolicyConfig} which has the configuration.
+ * @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 eCOMPComponentName, String configName, Map<String, String> configAttributes, UUID requestID) throws PolicyConfigException{
- return getConfig(setConfigRequestParameters(null, eCOMPComponentName, configName, configAttributes, requestID));
+ public Collection<PolicyConfig> getConfig(String onapComponentName, String configName, Map<String, String> configAttributes, UUID requestID) throws PolicyConfigException{
+ return getConfig(setConfigRequestParameters(null, onapComponentName, configName, configAttributes, requestID));
}
/**
* Requests the configuration of the <code>ConfigRequestParameters</code> which represents the Config policy request parameters
* and returns the specific configuration related to the matching parameters.
*
- * @param configRequestParameters {@link org.openecomp.policy.api.ConfigRequestParameters} which represents the Config policy request parameters.
- * @return <code>Collection</code> of {@link org.openecomp.policy.api.PolicyConfig} which has the configuration.
+ * @param configRequestParameters {@link org.onap.policy.api.ConfigRequestParameters} which represents the Config policy request parameters.
+ * @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{
* Requests the list of policies based on the <code>ConfigRequestParameters</code> which represents the policy request parameters
* and returns the list of policies filtered by the parameters.
*
- * @param configRequestParameters {@link org.openecomp.policy.api.ConfigRequestParameters} which represents the List Policy request parameters.
+ * @param configRequestParameters {@link org.onap.policy.api.ConfigRequestParameters} which represents the List Policy request parameters.
* @return <code>Collection</code> of <code>String</code> which returns the list of policies.
* @throws PolicyConfigException PolicyConfig Exception
*/
* Sends the Events specified to the PEP and returns back the PolicyResponse.
*
* @param eventAttributes the <code>Map</code> of <code>String,String</code> format of the eventAttributes that must contain the event ID and values.
- * @return <code>Collection</code> of {@link org.openecomp.policy.api.PolicyResponse} which has the Response.
+ * @return <code>Collection</code> of {@link org.onap.policy.api.PolicyResponse} which has the Response.
* @throws PolicyEventException PolicyEvent Exception
* @deprecated use {@link #sendEvent(EventRequestParameters)} Instead.
*/
* Sends the Events specified to the PEP and returns back the PolicyResponse.
*
* @param eventAttributes the <code>Map</code> of <code>String,String</code> format of the eventAttributes that must contain the event ID and values.
- * @param requestID unique request ID which will be passed throughout the ECOMP components to correlate logging messages.
+ * @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.
- * @return <code>Collection</code> of {@link org.openecomp.policy.api.PolicyResponse} which has the Response.
+ * @return <code>Collection</code> of {@link org.onap.policy.api.PolicyResponse} which has the Response.
* @throws PolicyEventException PolicyEvent Exception
* @deprecated use {@link #sendEvent(EventRequestParameters)} Instead.
*/
/**
* Sends the Events specified to the PEP and returns back the PolicyResponse.
*
- * @param eventRequestParameters {@link org.openecomp.policy.api.EventRequestParameters} which represents the Event Request Parameters.
- * @return <code>Collection</code> of {@link org.openecomp.policy.api.PolicyResponse} which has the Response.
+ * @param eventRequestParameters {@link org.onap.policy.api.EventRequestParameters} which represents the Event Request Parameters.
+ * @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 {
/**
* Sends the decision Attributes specified to the PEP and returns back the PolicyDecision.
*
- * @param eCOMPComponentName the <code>String</code> format of the eCOMPComponentName whose Decision is required.
+ * @param onapComponentName the <code>String</code> format of the onapComponentName 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.openecomp.policy.api.DecisionResponse} which has the Decision.
+ * @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 eCOMPComponentName, Map<String,String> decisionAttributes) throws PolicyDecisionException {
- return stdPolicyEngine.getDecision(eCOMPComponentName, decisionAttributes, null);
+ public DecisionResponse getDecision(String onapComponentName, Map<String,String> decisionAttributes) throws PolicyDecisionException {
+ return stdPolicyEngine.getDecision(onapComponentName, decisionAttributes, null);
}
/**
* Sends the decision Attributes specified to the PEP and returns back the PolicyDecision.
*
- * @param eCOMPComponentName the <code>String</code> format of the eCOMPComponentName whose Decision is required.
+ * @param onapComponentName the <code>String</code> format of the onapComponentName 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 ECOMP components to correlate logging messages.
+ * @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.
- * @return {@link org.openecomp.policy.api.DecisionResponse} which has the Decision.
+ * @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 eCOMPComponentName, Map<String,String> decisionAttributes, UUID requestID) throws PolicyDecisionException {
- return stdPolicyEngine.getDecision(eCOMPComponentName, decisionAttributes, requestID);
+ public DecisionResponse getDecision(String onapComponentName, Map<String,String> decisionAttributes, UUID requestID) throws PolicyDecisionException {
+ return stdPolicyEngine.getDecision(onapComponentName, decisionAttributes, requestID);
}
/**
* Sends the decision Attributes specified to the PEP and returns back the PolicyDecision.
*
- * @param decisionRequestParameters {@link org.openecomp.policy.api.DecisionRequestParameters} which represents the Decision Request Parameters.
- * @return {@link org.openecomp.policy.api.DecisionResponse} which has the Decision.
+ * @param decisionRequestParameters {@link org.onap.policy.api.DecisionRequestParameters} which represents the Decision Request Parameters.
+ * @return {@link org.onap.policy.api.DecisionResponse} which has the Decision.
* @throws PolicyDecisionException PolicyDecision Exception
*/
public DecisionResponse getDecision(DecisionRequestParameters decisionRequestParameters) throws PolicyDecisionException {
/**
* Retrieves the count of policies on the PAP, PDP, and Policy Engine as a whole
*
- * @param parameters {@link org.openecomp.policy.api.MetricsRequestParameters} which represents the Parameters required to get the Policy Metrics
- * @return {@link org.openecomp.policy.api.MetricsResponse} which consists of the response related to getMetrics Request.
+ * @param parameters {@link org.onap.policy.api.MetricsRequestParameters} which represents the Parameters required to get the Policy Metrics
+ * @return {@link org.onap.policy.api.MetricsResponse} which consists of the response related to getMetrics Request.
* @throws PolicyException PolicyException related to the operation
*
* */
* Creates a Config Policy based on given arguments
* @param policyName the <code>String</code> format of the Policy Name
* @param policyDescription the <code>String</code> format of the Policy Description
- * @param ecompName the <code>String</code> format of the ECOMP Name
+ * @param onapName the <code>String</code> format of the ONAP Name
* @param configName the <code>String</code> format of the Config Name
* @param configAttributes the <code>List</code> the <code>Map</code> Attributes that must contain the key and value.
* @param configType the <code>String</code> format of the Config Type
* @param body the <code>String</code> format of the Policy Body
* @param policyScope the <code>String</code> value of the sub scope directory where the policy will be created and stored
- * @param requestID unique request ID which will be passed throughout the ECOMP components to correlate logging messages.
+ * @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.
* @param riskLevel the <code>String</code> value of risk Level.
* @param riskType the <code>String</code> value of risk Type.
* @deprecated use {@link #createPolicy(PolicyParameters)} Instead.
*/
@Deprecated
- public String createConfigPolicy(String policyName, String policyDescription, String ecompName, String configName,
+ 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 {
- return stdPolicyEngine.createUpdateConfigPolicy(policyName, policyDescription, ecompName, configName,
+ return stdPolicyEngine.createUpdateConfigPolicy(policyName, policyDescription, onapName, configName,
configAttributes, configType, body, policyScope, requestID,
riskLevel, riskType, guard, ttlDate, false);
}
* Creates a Config Policy based on given arguments
* @param policyName the <code>String</code> format of the Policy Name
* @param policyDescription the <code>String</code> format of the Policy Description
- * @param ecompName the <code>String</code> format of the ECOMP Name
+ * @param onapName the <code>String</code> format of the ONAP Name
* @param configName the <code>String</code> format of the Config Name
* @param configAttributes the <code>List</code> the <code>Map</code> Attributes that must contain the key and value.
* @param configType the <code>String</code> format of the Config Type
* @param body the <code>String</code> format of the Policy Body
* @param policyScope the <code>String</code> value of the sub scope directory where the policy will be created and stored
- * @param requestID unique request ID which will be passed throughout the ECOMP components to correlate logging messages.
+ * @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.
* @param riskLevel the <code>String</code> value of risk Level.
* @param riskType the <code>String</code> value of risk Type.
* @deprecated use {@link #updatePolicy(PolicyParameters)} Instead.
*/
@Deprecated
- public String updateConfigPolicy(String policyName, String policyDescription, String ecompName, String configName,
+ 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 {
- return stdPolicyEngine.createUpdateConfigPolicy(policyName, policyDescription, ecompName, configName,
+ return stdPolicyEngine.createUpdateConfigPolicy(policyName, policyDescription, onapName, configName,
configAttributes, configType, body, policyScope, requestID,riskLevel, riskType, guard, ttlDate, true);
}
* @param policyName the <code>String</code> format of the Policy Name
* @param firewallJson the <code>JsonObject</code> representation of the Firewall Rules List
* @param policyScope the <code>String</code> value of the sub scope directory where the policy will be created and stored
- * @param requestID unique request ID which will be passed throughout the ECOMP components to correlate logging messages.
+ * @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.
* @param riskLevel the <code>String</code> value of risk Level.
* @param riskType the <code>String</code> value of risk Type.
* @param policyName the <code>String</code> format of the Policy Name
* @param firewallJson the <code>JsonObject</code> representation of the Firewall Rules List
* @param policyScope the <code>String</code> value of the sub scope directory where the policy will be created and stored
- * @param requestID unique request ID which will be passed throughout the ECOMP components to correlate logging messages.
+ * @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.
* @param riskLevel the <code>String</code> value of risk Level.
* @param riskType the <code>String</code> value of risk Type.
/**
* Retrieves Dictionary Items for a specified dictionary
*
- * @param parameters {@link org.openecomp.policy.api.DictionaryParameters} which represents the Dictionary Parameters required to create a Dictionary Item.
- * @return {@link org.openecomp.policy.api.DictionaryResponse} which consists of the response related to create dictionary item Request.
+ * @param parameters {@link org.onap.policy.api.DictionaryParameters} which represents the Dictionary Parameters required to create a Dictionary Item.
+ * @return {@link org.onap.policy.api.DictionaryResponse} which consists of the response related to create dictionary item Request.
* @throws PolicyException PolicyException related to the operation
*
* */
/**
* Creates a Dictionary Item based on given Dictionary Parameters
*
- * @param parameters {@link org.openecomp.policy.api.DictionaryParameters} which represents the Dictionary Parameters required to create a Dictionary Item.
- * @return {@link org.openecomp.policy.api.PolicyChangeResponse} which consists of the response related to create dictionary item Request.
+ * @param parameters {@link org.onap.policy.api.DictionaryParameters} which represents the Dictionary Parameters required to create a Dictionary Item.
+ * @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 {
/**
* Updates a Dictionary Item based on given Dictionary Parameters
*
- * @param parameters {@link org.openecomp.policy.api.DictionaryParameters} which represents the Dictionary Parameters required to update a Dictionary Item.
- * @return {@link org.openecomp.policy.api.PolicyChangeResponse} which consists of the response related to update dictionary item Request.
+ * @param parameters {@link org.onap.policy.api.DictionaryParameters} which represents the Dictionary Parameters required to update a Dictionary Item.
+ * @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 {
/**
* Creates a Policy based on given Policy Parameters.
*
- * @param policyParameters {@link org.openecomp.policy.api.PolicyParameters} which represents the Policy Parameters required to create a Policy.
- * @return {@link org.openecomp.policy.api.PolicyChangeResponse} which consists of the response related to create policy Request.
+ * @param policyParameters {@link org.onap.policy.api.PolicyParameters} which represents the Policy Parameters required to create a Policy.
+ * @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 {
/**
* Update Policy based on given Policy Parameters.
*
- * @param policyParameters {@link org.openecomp.policy.api.PolicyParameters} which represents the Policy Parameters required to update a Policy.
- * @return {@link org.openecomp.policy.api.PolicyChangeResponse} which consists of the response related to create policy Request.
+ * @param policyParameters {@link org.onap.policy.api.PolicyParameters} which represents the Policy Parameters required to update a Policy.
+ * @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 {
* @param policyName the <code>String</code> format of the Policy Name being pushed.
* @param policyType the <code>String</code> format of the Policy Type which is being pushed.
* @param pdpGroup the <code>String</code> format of the PDP Group name to which the policy needs to be pushed to.
- * @param requestID unique request ID which will be passed throughout the ECOMP components to correlate logging messages.
+ * @param requestID unique request ID which will be passed throughout the ONAP components to correlate logging messages.
* @return <code>String</code> format of the response related to the push Policy Request.
* @throws PolicyException PolicyException related to the operation.
* @deprecated use {@link #pushPolicy(PushPolicyParameters)} instead.
/**
* Pushes the specified policy to the PDP Group. If no PDP group is selected default is used.
*
- * @param pushPolicyParameters {@link org.openecomp.policy.api.PushPolicyParameters} which represents the Push Policy parameters required to push a policy.
- * @return {@link org.openecomp.policy.api.PolicyChangeResponse} which consists of the response related to the push Policy Request.
+ * @param pushPolicyParameters {@link org.onap.policy.api.PushPolicyParameters} which represents the Push Policy parameters required to push a policy.
+ * @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 {
/**
* Deletes the specified policy from the PAP or PDP.
*
- * @param deletePolicyParameters {@link org.openecomp.policy.api.DeletePolicyParameters} which represents the Delete Policy parameters to delete a policy.
- * @return {@link org.openecomp.policy.api.PolicyChangeResponse} which consists of the response related to the Delete Policy Request.
+ * @param deletePolicyParameters {@link org.onap.policy.api.DeletePolicyParameters} which represents the Delete Policy parameters to delete a policy.
+ * @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 {
/**
* Creates a new Policy Service based on given Service Parameters.
*
- * @param importParameters {@link org.openecomp.policy.api.ImportParameters} which represents the Service Parameters required to create a Policy Service.
- * @return {@link org.openecomp.policy.api.PolicyChangeResponse} which consists of the response related to create import Service.
+ * @param importParameters {@link org.onap.policy.api.ImportParameters} which represents the Service Parameters required to create a Policy Service.
+ * @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 {
/**
* <code>setNotification</code> allows changes to the Notification Scheme and Notification Handler
*
- * @param scheme the <code>NotificationScheme</code> of {@link org.openecomp.policy.api.NotificationScheme} which defines the Notification Scheme
- * @param handler the <code>NotificationHandler</code> of {@link org.openecomp.policy.api.NotificationHandler} which defines what should happen when a notification is received.
+ * @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) {
this.scheme = scheme;
/**
* <code>setNotification</code> allows changes to the Notification Scheme
*
- * @param scheme the <code>NotificationScheme</code> of {@link org.openecomp.policy.api.NotificationScheme} which defines the Notification Scheme
+ * @param scheme the <code>NotificationScheme</code> of {@link org.onap.policy.api.NotificationScheme} which defines the Notification Scheme
*/
public void setScheme(NotificationScheme scheme){
this.scheme = scheme;
/**
* Gets the <code>PDPNotification</code> if there is one exists. This is used for Polling Patterns.
*
- * @return <code>PDPNotification</code> of {@link org.openecomp.policy.api.PDPNotification} which has the Notification.
+ * @return <code>PDPNotification</code> of {@link org.onap.policy.api.PDPNotification} which has the Notification.
*/
public PDPNotification getNotification() {
return stdPolicyEngine.getNotification();
}
// Internal Setter Method to help build configRequestParameters.
- private ConfigRequestParameters setConfigRequestParameters(String policyName, String eCOMPComponentName, String configName, Map<String, String> configAttributes, UUID requestID){
+ private ConfigRequestParameters setConfigRequestParameters(String policyName, String onapComponentName, String configName, Map<String, String> configAttributes, UUID requestID){
ConfigRequestParameters configRequestParameters = new ConfigRequestParameters();
configRequestParameters.setPolicyName(policyName);
- configRequestParameters.setEcompName(eCOMPComponentName);
+ configRequestParameters.setOnapName(onapComponentName);
configRequestParameters.setConfigName(configName);
configRequestParameters.setConfigAttributes(configAttributes);
configRequestParameters.setRequestID(requestID);
Code Review / policy / engine.git / blobdiff