* ============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.
package org.onap.policy.api.main.rest.provider;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.LinkedHashMap;
+import java.util.List;
import java.util.Map;
+import java.util.Map.Entry;
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.provider.PolicyModelsProvider;
-import org.onap.policy.models.provider.PolicyModelsProviderFactory;
-import org.onap.policy.models.provider.PolicyModelsProviderParameters;
+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.tosca.authorative.concepts.ToscaPolicyIdentifier;
import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyInput;
import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyOutput;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
/**
* Class to provide all kinds of legacy guard policy operations.
*
* @author Chenfei Gao (cgao@research.att.com)
*/
-public class LegacyGuardPolicyProvider {
+public class LegacyGuardPolicyProvider extends CommonModelProvider {
+
+ private static final Logger LOGGER = LoggerFactory.getLogger(LegacyGuardPolicyProvider.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 Map<String, PfConceptKey> GUARD_POLICY_TYPE_MAP = new LinkedHashMap<>();
+
+ static {
+ GUARD_POLICY_TYPE_MAP.put("guard.frequency.",
+ new PfConceptKey("onap.policies.controlloop.guard.FrequencyLimiter:1.0.0"));
+ GUARD_POLICY_TYPE_MAP.put("guard.minmax.",
+ new PfConceptKey("onap.policies.controlloop.guard.MinMax:1.0.0"));
+ GUARD_POLICY_TYPE_MAP.put("guard.blacklist.",
+ new PfConceptKey("onap.policies.controlloop.guard.Blacklist:1.0.0"));
+ }
/**
* Default constructor.
*/
public LegacyGuardPolicyProvider() throws PfModelException {
-
- ApiParameterGroup parameterGroup = ParameterService.get("ApiGroup");
- PolicyModelsProviderParameters providerParameters = parameterGroup.getDatabaseProviderParameters();
- modelsProvider = new PolicyModelsProviderFactory().createPolicyModelsProvider(providerParameters);
- modelsProvider.init();
+ super();
}
/**
*
* @return the map of LegacyGuardPolicyOutput objects
*/
- public Map<String, LegacyGuardPolicyOutput> fetchGuardPolicies(String policyId, String policyVersion)
+ public Map<String, LegacyGuardPolicyOutput> fetchGuardPolicy(String policyId, String policyVersion)
+ throws PfModelException {
+
+ if (policyVersion != null) {
+ validNumber(policyVersion, INVALID_POLICY_VERSION);
+ }
+ return modelsProvider.getGuardPolicy(policyId, policyVersion);
+ }
+
+ /**
+ * Retrieves a list of deployed guard 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>, Map<String, LegacyGuardPolicyOutput>> fetchDeployedGuardPolicies(String policyId)
throws PfModelException {
- Map<String, LegacyGuardPolicyOutput> guardPolicies = modelsProvider.getGuardPolicy(policyId);
- close();
- return guardPolicies;
+ return collectDeployedPolicies(
+ policyId, getGuardPolicyType(policyId), modelsProvider::getGuardPolicy, Map::putAll, new HashMap<>());
}
/**
*
* @return the map of LegacyGuardPolicyOutput objectst
*/
- public Map<String, LegacyGuardPolicyOutput> createGuardPolicy(LegacyGuardPolicyInput body) throws PfModelException {
- Map<String, LegacyGuardPolicyOutput> guardPolicies = modelsProvider.createGuardPolicy(body);
- close();
- return guardPolicies;
+ public Map<String, LegacyGuardPolicyOutput> createGuardPolicy(LegacyGuardPolicyInput body)
+ throws PfModelException {
+
+ validateGuardPolicyVersion(body);
+ return modelsProvider.createGuardPolicy(body);
}
/**
*
* @return the map of LegacyGuardPolicyOutput objects
*/
- public Map<String, LegacyGuardPolicyOutput> deleteGuardPolicies(String policyId, String policyVersion)
+ public Map<String, LegacyGuardPolicyOutput> deleteGuardPolicy(String policyId, String policyVersion)
throws PfModelException {
- Map<String, LegacyGuardPolicyOutput> guardPolicies = modelsProvider.deleteGuardPolicy(policyId);
- close();
- return guardPolicies;
+ validNumber(policyVersion, INVALID_POLICY_VERSION);
+ validateDeleteEligibility(policyId, policyVersion);
+
+ return modelsProvider.deleteGuardPolicy(policyId, policyVersion);
+ }
+
+ /**
+ * Validates whether specified policy can be deleted based on the rule that deployed policy cannot be deleted.
+ *
+ * @param policyId the ID of policy
+ * @param policyVersion the version of policy
+ *
+ * @throws PfModelException the PfModel parsing exception
+ */
+ private void validateDeleteEligibility(String policyId, String policyVersion) throws PfModelException {
+
+ List<ToscaPolicyIdentifier> policies = new ArrayList<>();
+ 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,
+ constructDeletePolicyViolationMessage(policyId, policyVersion, pdpGroups));
+ }
+ }
+
+ /**
+ * Validates the provided guard policy version in the payload.
+ *
+ * @param body the guard policy payload
+ *
+ * @throws PfModelException the PfModel parsing exception
+ */
+ private void validateGuardPolicyVersion(LegacyGuardPolicyInput body) throws PfModelException {
+
+ validateGuardPolicyVersionExist(body);
+ validateNoDuplicateVersionInDb(body);
+ }
+
+ /**
+ * Validates that the guard policy has version specified.
+ *
+ * @param body the guard policy payload
+ *
+ * @throws PfModelException the PfModel parsing exception
+ */
+ private void validateGuardPolicyVersionExist(LegacyGuardPolicyInput 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);
+ }
}
/**
- * Closes the connection to database.
+ * Validates that there is no duplicate version already stored in the database.
+ *
+ * @param body the guard policy payload
*
* @throws PfModelException the PfModel parsing exception
*/
- private void close() throws PfModelException {
+ private void validateNoDuplicateVersionInDb(LegacyGuardPolicyInput body) throws PfModelException {
+
try {
- modelsProvider.close();
- } catch (Exception e) {
- throw new PfModelException(
- Response.Status.INTERNAL_SERVER_ERROR, "error closing connection to database", e);
+ modelsProvider.getGuardPolicy(body.getPolicyId(), body.getPolicyVersion());
+ } catch (PfModelRuntimeException exc) {
+ if (!hasSameGuardPolicyFound(body, exc)) {
+ return;
+ }
+ throw new PfModelException(exc.getErrorResponse().getResponseCode(), "unexpected runtime error", exc);
+ }
+
+ // If it gets here, there is one duplicate version stored in the DB.
+ // Try to get the latest version and return it to the user.
+ Map<String, LegacyGuardPolicyOutput> latest = modelsProvider.getGuardPolicy(body.getPolicyId(), null);
+ final String[] versionArray = latest.values().iterator().next().getVersion().split("\\.");
+ String errMsg = "guard policy " + body.getPolicyId() + ":" + body.getPolicyVersion()
+ + " already exists; its latest version is " + versionArray[0];
+ throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errMsg);
+ }
+
+ /**
+ * Checks if the same guard policy found in the database.
+ *
+ * @param body the legacy guard policy payload
+ * @param exc the thrown runtime exception from policy model provider
+ *
+ * @return a boolean flag indicating the check result
+ */
+ private boolean hasSameGuardPolicyFound(LegacyGuardPolicyInput body, PfModelRuntimeException exc) {
+
+ 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;
+ }
+
+ /**
+ * Retrieves guard policy type given guard policy ID.
+ *
+ * @param policyId the ID of guard policy
+ *
+ * @return the concept key of guard policy type
+ *
+ * @throws PfModelException the PfModel parsing exception
+ */
+ private PfConceptKey getGuardPolicyType(String policyId) throws PfModelException {
+
+ for (Entry<String, PfConceptKey> guardPolicyTypeEntry : GUARD_POLICY_TYPE_MAP.entrySet()) {
+ if (policyId.startsWith(guardPolicyTypeEntry.getKey())) {
+ return guardPolicyTypeEntry.getValue();
+ }
}
+ throw new PfModelException(Response.Status.BAD_REQUEST, "No policy type defined for " + policyId);
}
}
\ No newline at end of file
Code Review / policy / api.git / blobdiff