* ============LICENSE_START=======================================================
* ONAP Policy API
* ================================================================================
- * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2019-2020 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.
import java.util.ArrayList;
import java.util.List;
+import java.util.Map;
import javax.ws.rs.core.Response;
-import org.onap.policy.api.main.parameters.ApiParameterGroup;
-import org.onap.policy.common.parameters.ParameterService;
+
+import org.apache.commons.lang3.tuple.Pair;
+import org.onap.policy.models.base.PfConceptKey;
import org.onap.policy.models.base.PfModelException;
+import org.onap.policy.models.base.PfModelRuntimeException;
import org.onap.policy.models.pdp.concepts.PdpGroup;
import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
-import org.onap.policy.models.provider.PolicyModelsProvider;
-import org.onap.policy.models.provider.PolicyModelsProviderFactory;
-import org.onap.policy.models.provider.PolicyModelsProviderParameters;
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyIdentifier;
import org.onap.policy.models.tosca.legacy.concepts.LegacyOperationalPolicy;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
/**
* Class to provide all kinds of legacy operational policy operations.
*
* @author Chenfei Gao (cgao@research.att.com)
*/
-public class LegacyOperationalPolicyProvider implements AutoCloseable {
+public class LegacyOperationalPolicyProvider extends CommonModelProvider {
+
+ private static final Logger LOGGER = LoggerFactory.getLogger(LegacyOperationalPolicyProvider.class);
- private PolicyModelsProvider modelsProvider;
+ private static final String INVALID_POLICY_VERSION = "legacy policy version is not an integer";
+ private static final String LEGACY_MINOR_PATCH_SUFFIX = ".0.0";
+ private static final PfConceptKey LEGACY_OPERATIONAL_TYPE =
+ new PfConceptKey("onap.policies.controlloop.Operational", "1.0.0");
/**
* Default constructor.
*/
public LegacyOperationalPolicyProvider() throws PfModelException {
-
- ApiParameterGroup parameterGroup = ParameterService.get("ApiGroup");
- PolicyModelsProviderParameters providerParameters = parameterGroup.getDatabaseProviderParameters();
- modelsProvider = new PolicyModelsProviderFactory().createPolicyModelsProvider(providerParameters);
+ super();
}
/**
throws PfModelException {
if (policyVersion != null) {
- validateLegacyOperationalPolicyVersion(policyVersion);
+ validNumber(policyVersion, INVALID_POLICY_VERSION);
}
return modelsProvider.getOperationalPolicy(policyId, policyVersion);
}
+ /**
+ * Retrieves a list of deployed operational policies in each pdp group.
+ *
+ * @param policyId the ID of the policy
+ *
+ * @return a list of deployed policies in each pdp group
+ *
+ * @throws PfModelException the PfModel parsing exception
+ */
+ public Map<Pair<String, String>, List<LegacyOperationalPolicy>> fetchDeployedOperationalPolicies(String policyId)
+ throws PfModelException {
+
+ return collectDeployedPolicies(
+ policyId, LEGACY_OPERATIONAL_TYPE, modelsProvider::getOperationalPolicy, List::add, new ArrayList<>(5));
+ }
+
/**
* Creates a new operational policy.
*
*/
public LegacyOperationalPolicy createOperationalPolicy(LegacyOperationalPolicy body) throws PfModelException {
+ validateOperationalPolicyVersion(body);
return modelsProvider.createOperationalPolicy(body);
}
public LegacyOperationalPolicy deleteOperationalPolicy(String policyId, String policyVersion)
throws PfModelException {
+ validNumber(policyVersion, INVALID_POLICY_VERSION);
validateDeleteEligibility(policyId, policyVersion);
- validateLegacyOperationalPolicyVersion(policyVersion);
return modelsProvider.deleteOperationalPolicy(policyId, policyVersion);
}
*/
private void validateDeleteEligibility(String policyId, String policyVersion) throws PfModelException {
- List<ToscaPolicyIdentifier> policies = new ArrayList<>();
- policies.add(new ToscaPolicyIdentifier(policyId, policyVersion));
+ List<ToscaPolicyIdentifier> policies = new ArrayList<>(5);
+ policies.add(new ToscaPolicyIdentifier(policyId, policyVersion + LEGACY_MINOR_PATCH_SUFFIX));
PdpGroupFilter pdpGroupFilter = PdpGroupFilter.builder().policyList(policies).build();
List<PdpGroup> pdpGroups = modelsProvider.getFilteredPdpGroups(pdpGroupFilter);
if (!pdpGroups.isEmpty()) {
throw new PfModelException(Response.Status.CONFLICT,
- constructDeleteRuleViolationMessage(policyId, policyVersion, pdpGroups));
+ constructDeletePolicyViolationMessage(policyId, policyVersion, pdpGroups));
}
}
/**
- * Validates whether the legacy operational policy version is an integer.
+ * Validates the specified version of the operational policy provided in the payload.
*
- * @param policyVersion the version of policy
+ * @param body the operational policy payload
*
- * @throws PfModelException the PfModel parsing exception
+ * @throws PfModelException on errors parsing PfModel
*/
- private void validateLegacyOperationalPolicyVersion(String policyVersion) throws PfModelException {
+ private void validateOperationalPolicyVersion(LegacyOperationalPolicy body) throws PfModelException {
- try {
- Integer.valueOf(policyVersion);
- } catch (NumberFormatException exc) {
- throw new PfModelException(Response.Status.BAD_REQUEST,
- "legacy policy version is not an integer", exc);
+ validateOperationalPolicyVersionExist(body);
+ validateNoDuplicateVersionInDb(body);
+ }
+
+ /**
+ * Validates whether the version of the operational policy is specified in the payload.
+ *
+ * @param body the operational policy payload
+ *
+ * @throws PfModelException on errors parsing PfModel
+ */
+ private void validateOperationalPolicyVersionExist(LegacyOperationalPolicy body) throws PfModelException {
+
+ if (body.getPolicyVersion() == null) {
+ String errMsg = "mandatory field 'policy-version' is missing in the policy: " + body.getPolicyId();
+ throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errMsg);
}
}
/**
- * Constructs returned message for policy delete rule violation.
+ * Validates that there is no duplicate version of the operational policy which is already stored in the database.
*
- * @param policyId the ID of policy
- * @param policyVersion the version of policy
- * @param pdpGroups the list of pdp groups
+ * @param body the operational policy payload
*
- * @return the constructed message
+ * @throws PfModelException on errors parsing PfModel
*/
- private String constructDeleteRuleViolationMessage(
- String policyId, String policyVersion, List<PdpGroup> pdpGroups) {
+ private void validateNoDuplicateVersionInDb(LegacyOperationalPolicy body) throws PfModelException {
- List<String> pdpGroupNameVersionList = new ArrayList<>();
- for (PdpGroup pdpGroup : pdpGroups) {
- pdpGroupNameVersionList.add(pdpGroup.getName() + ":" + pdpGroup.getVersion());
+ try {
+ modelsProvider.getOperationalPolicy(body.getPolicyId(), body.getPolicyVersion());
+ } catch (PfModelRuntimeException exc) {
+ if (!hasSameOperationalPolicyFound(body, exc)) {
+ return;
+ }
+ throw new PfModelException(exc.getErrorResponse().getResponseCode(), "unexpected runtime error", exc);
}
- String deployedPdpGroups = String.join(",", pdpGroupNameVersionList);
- return "policy with ID " + policyId + ":" + policyVersion
- + " cannot be deleted as it is deployed in pdp groups " + deployedPdpGroups;
+
+ // There is one duplicate version stored in the DB.
+ // Try to get the latest version
+ LegacyOperationalPolicy latest = modelsProvider.getOperationalPolicy(body.getPolicyId(), null);
+ final String[] versionArray = latest.getPolicyVersion().split("\\.");
+ String errMsg = "operational policy " + body.getPolicyId() + ":" + body.getPolicyVersion()
+ + " already exists; its latest version is " + versionArray[0];
+ throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errMsg);
}
/**
- * Closes the connection to database.
+ * Checks if the same operational policy found in the database.
*
- * @throws PfModelException the PfModel parsing exception
+ * @param body the legacy operational policy payload
+ * @param exc the runtime exception thrown by policy model provider
+ *
+ * @return a boolean flag indicating the check result
*/
- @Override
- public void close() throws PfModelException {
+ private boolean hasSameOperationalPolicyFound(LegacyOperationalPolicy body, PfModelRuntimeException exc) {
- modelsProvider.close();
+ if (exc.getErrorResponse().getResponseCode() == Response.Status.BAD_REQUEST
+ && exc.getErrorResponse().getErrorMessage().contains("no policy found")) {
+ LOGGER.debug("no duplicate policy {}:{} found in the DB", body.getPolicyId(), body.getPolicyVersion());
+ return false;
+ }
+ return true;
}
}
\ No newline at end of file
Code Review / policy / api.git / blobdiff