main/src/main/java/org/onap/policy/api/main/rest/provider/LegacyOperationalPolicyProvider.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP Policy API
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.api.main.rest.provider;
  24
  25 import java.util.ArrayList;
  26 import java.util.List;
  27 import javax.ws.rs.core.Response;
  28 import org.onap.policy.api.main.parameters.ApiParameterGroup;
  29 import org.onap.policy.common.parameters.ParameterService;
  30 import org.onap.policy.models.base.PfModelException;
  31 import org.onap.policy.models.pdp.concepts.PdpGroup;
  32 import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
  33 import org.onap.policy.models.provider.PolicyModelsProvider;
  34 import org.onap.policy.models.provider.PolicyModelsProviderFactory;
  35 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
  36 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyIdentifier;
  37 import org.onap.policy.models.tosca.legacy.concepts.LegacyOperationalPolicy;
  38
  39 /**
  40  * Class to provide all kinds of legacy operational policy operations.
  41  *
  42  * @author Chenfei Gao (cgao@research.att.com)
  43  */
  44 public class LegacyOperationalPolicyProvider implements AutoCloseable {
  45
  46     private PolicyModelsProvider modelsProvider;
  47
  48     /**
  49      * Default constructor.
  50      */
  51     public LegacyOperationalPolicyProvider() throws PfModelException {
  52
  53         ApiParameterGroup parameterGroup = ParameterService.get("ApiGroup");
  54         PolicyModelsProviderParameters providerParameters = parameterGroup.getDatabaseProviderParameters();
  55         modelsProvider = new PolicyModelsProviderFactory().createPolicyModelsProvider(providerParameters);
  56     }
  57
  58     /**
  59      * Retrieves a list of operational policies matching specified ID and version.
  60      *
  61      * @param policyId the ID of policy
  62      * @param policyVersion the version of policy
  63      *
  64      * @return the LegacyOperationalPolicy object
  65      */
  66     public LegacyOperationalPolicy fetchOperationalPolicy(String policyId, String policyVersion)
  67             throws PfModelException {
  68
  69         return modelsProvider.getOperationalPolicy(policyId);
  70     }
  71
  72     /**
  73      * Creates a new operational policy.
  74      *
  75      * @param body the entity body of policy
  76      *
  77      * @return the LegacyOperationalPolicy object
  78      */
  79     public LegacyOperationalPolicy createOperationalPolicy(LegacyOperationalPolicy body) throws PfModelException {
  80
  81         return modelsProvider.createOperationalPolicy(body);
  82     }
  83
  84     /**
  85      * Deletes the operational policies matching specified ID and version.
  86      *
  87      * @param policyId the ID of policy
  88      * @param policyVersion the version of policy
  89      *
  90      * @return the LegacyOperationalPolicy object
  91      */
  92     public LegacyOperationalPolicy deleteOperationalPolicy(String policyId, String policyVersion)
  93             throws PfModelException {
  94
  95         validateDeleteEligibility(policyId, policyVersion);
  96
  97         return modelsProvider.deleteOperationalPolicy(policyId);
  98     }
  99
 100     /**
 101      * Validates whether specified policy can be deleted based on the rule that deployed policy cannot be deleted.
 102      *
 103      * @param policyId the ID of policy
 104      * @param policyVersion the version of policy
 105      *
 106      * @throws PfModelException the PfModel parsing exception
 107      */
 108     private void validateDeleteEligibility(String policyId, String policyVersion) throws PfModelException {
 109
 110         List<ToscaPolicyIdentifier> policies = new ArrayList<>();
 111         policies.add(new ToscaPolicyIdentifier(policyId, policyVersion));
 112         PdpGroupFilter pdpGroupFilter = PdpGroupFilter.builder().policyList(policies).build();
 113
 114         List<PdpGroup> pdpGroups = modelsProvider.getFilteredPdpGroups(pdpGroupFilter);
 115
 116         if (!pdpGroups.isEmpty()) {
 117             throw new PfModelException(Response.Status.CONFLICT,
 118                     constructDeleteRuleViolationMessage(policyId, policyVersion, pdpGroups));
 119         }
 120     }
 121
 122     /**
 123      * Constructs returned message for policy delete rule violation.
 124      *
 125      * @param policyId the ID of policy
 126      * @param policyVersion the version of policy
 127      * @param pdpGroups the list of pdp groups
 128      *
 129      * @return the constructed message
 130      */
 131     private String constructDeleteRuleViolationMessage(
 132             String policyId, String policyVersion, List<PdpGroup> pdpGroups) {
 133
 134         List<String> pdpGroupNameVersionList = new ArrayList<>();
 135         for (PdpGroup pdpGroup : pdpGroups) {
 136             pdpGroupNameVersionList.add(pdpGroup.getName() + ":" + pdpGroup.getVersion());
 137         }
 138         String deployedPdpGroups = String.join(",", pdpGroupNameVersionList);
 139         return "policy with ID " + policyId + ":" + policyVersion
 140                 + " cannot be deleted as it is deployed in pdp groups " + deployedPdpGroups;
 141     }
 142
 143     /**
 144      * Closes the connection to database.
 145      *
 146      * @throws PfModelException the PfModel parsing exception
 147      */
 148     @Override
 149     public void close() throws PfModelException {
 150
 151         modelsProvider.close();
 152     }
 153 }