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
  28 import javax.ws.rs.core.Response;
  29
  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.tosca.authorative.concepts.ToscaPolicyIdentifier;
  34 import org.onap.policy.models.tosca.legacy.concepts.LegacyOperationalPolicy;
  35
  36 /**
  37  * Class to provide all kinds of legacy operational policy operations.
  38  *
  39  * @author Chenfei Gao (cgao@research.att.com)
  40  */
  41 public class LegacyOperationalPolicyProvider extends CommonModelProvider {
  42
  43     private static final String INVALID_POLICY_VERSION = "legacy policy version is not an integer";
  44     private static final String LEGACY_MINOR_PATCH_SUFFIX = ".0.0";
  45
  46
  47     /**
  48      * Default constructor.
  49      */
  50     public LegacyOperationalPolicyProvider() throws PfModelException {
  51         super();
  52     }
  53
  54     /**
  55      * Retrieves a list of operational policies matching specified ID and version.
  56      *
  57      * @param policyId the ID of policy
  58      * @param policyVersion the version of policy
  59      *
  60      * @return the LegacyOperationalPolicy object
  61      */
  62     public LegacyOperationalPolicy fetchOperationalPolicy(String policyId, String policyVersion)
  63             throws PfModelException {
  64
  65         if (policyVersion != null) {
  66             validNumber(policyVersion, INVALID_POLICY_VERSION);
  67         }
  68         return modelsProvider.getOperationalPolicy(policyId, policyVersion);
  69     }
  70
  71     /**
  72      * Creates a new operational policy.
  73      *
  74      * @param body the entity body of policy
  75      *
  76      * @return the LegacyOperationalPolicy object
  77      */
  78     public LegacyOperationalPolicy createOperationalPolicy(LegacyOperationalPolicy body) throws PfModelException {
  79
  80         return modelsProvider.createOperationalPolicy(body);
  81     }
  82
  83     /**
  84      * Deletes the operational policies matching specified ID and version.
  85      *
  86      * @param policyId the ID of policy
  87      * @param policyVersion the version of policy
  88      *
  89      * @return the LegacyOperationalPolicy object
  90      */
  91     public LegacyOperationalPolicy deleteOperationalPolicy(String policyId, String policyVersion)
  92             throws PfModelException {
  93
  94         validNumber(policyVersion, INVALID_POLICY_VERSION);
  95         validateDeleteEligibility(policyId, policyVersion);
  96
  97         return modelsProvider.deleteOperationalPolicy(policyId, policyVersion);
  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 + LEGACY_MINOR_PATCH_SUFFIX));
 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                     constructDeletePolicyViolationMessage(policyId, policyVersion, pdpGroups));
 119         }
 120     }
 121 }