models-provider/src/main/java/org/onap/policy/models/provider/impl/DatabasePolicyModelsProviderImpl.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-2021 Nordix Foundation.
   4  *  Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
   5  *  Modifications Copyright (C) 2020 Bell Canada. 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.models.provider.impl;
  24
  25 import java.util.Collection;
  26 import java.util.Date;
  27 import java.util.List;
  28 import javax.ws.rs.core.Response;
  29 import lombok.NonNull;
  30 import org.onap.policy.models.base.PfModelException;
  31 import org.onap.policy.models.base.PfModelRuntimeException;
  32 import org.onap.policy.models.pdp.concepts.Pdp;
  33 import org.onap.policy.models.pdp.concepts.PdpGroup;
  34 import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
  35 import org.onap.policy.models.pdp.concepts.PdpPolicyStatus;
  36 import org.onap.policy.models.pdp.concepts.PdpStatistics;
  37 import org.onap.policy.models.pdp.concepts.PdpSubGroup;
  38 import org.onap.policy.models.pdp.persistence.provider.PdpProvider;
  39 import org.onap.policy.models.pdp.persistence.provider.PdpStatisticsProvider;
  40 import org.onap.policy.models.provider.PolicyModelsProvider;
  41 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
  42 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  43 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifierOptVersion;
  44 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  45 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyFilter;
  46 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
  47 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;
  48 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  49 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplateFilter;
  50 import org.onap.policy.models.tosca.authorative.provider.AuthorativeToscaProvider;
  51
  52 /**
  53  * This class provides an implementation of the Policy Models Provider for the ONAP Policy Framework that works towards
  54  * a relational database.
  55  *
  56  * @author Liam Fallon (liam.fallon@est.tech)
  57  */
  58 public class DatabasePolicyModelsProviderImpl extends AbstractModelsProvider implements PolicyModelsProvider {
  59     /**
  60      * Constructor that takes the parameters.
  61      *
  62      * @param parameters the parameters for the provider
  63      */
  64     public DatabasePolicyModelsProviderImpl(@NonNull final PolicyModelsProviderParameters parameters) {
  65         super(parameters);
  66     }
  67
  68     @Override
  69     public List<ToscaServiceTemplate> getServiceTemplateList(final String name, final String version)
  70             throws PfModelException {
  71         assertInitialized();
  72         return new AuthorativeToscaProvider().getServiceTemplateList(getPfDao(), name, version);
  73     }
  74
  75
  76     @Override
  77     public List<ToscaServiceTemplate> getFilteredServiceTemplateList(@NonNull ToscaServiceTemplateFilter filter)
  78             throws PfModelException {
  79         assertInitialized();
  80         return new AuthorativeToscaProvider().getFilteredServiceTemplateList(getPfDao(), filter);
  81     }
  82
  83     @Override
  84     public ToscaServiceTemplate createServiceTemplate(@NonNull final ToscaServiceTemplate serviceTemplate)
  85             throws PfModelException {
  86         assertInitialized();
  87         return new AuthorativeToscaProvider().createServiceTemplate(getPfDao(), serviceTemplate);
  88     }
  89
  90     @Override
  91     public ToscaServiceTemplate updateServiceTemplate(@NonNull final ToscaServiceTemplate serviceTemplate)
  92             throws PfModelException {
  93         assertInitialized();
  94         return new AuthorativeToscaProvider().updateServiceTemplate(getPfDao(), serviceTemplate);
  95     }
  96
  97     @Override
  98     public ToscaServiceTemplate deleteServiceTemplate(@NonNull final String name, @NonNull final String version)
  99             throws PfModelException {
 100         assertInitialized();
 101
 102         return new AuthorativeToscaProvider().deleteServiceTemplate(getPfDao(), name, version);
 103     }
 104
 105     @Override
 106     public ToscaServiceTemplate getPolicyTypes(final String name, final String version) throws PfModelException {
 107         assertInitialized();
 108         return new AuthorativeToscaProvider().getPolicyTypes(getPfDao(), name, version);
 109     }
 110
 111     @Override
 112     public List<ToscaPolicyType> getPolicyTypeList(final String name, final String version) throws PfModelException {
 113         assertInitialized();
 114         return new AuthorativeToscaProvider().getPolicyTypeList(getPfDao(), name, version);
 115     }
 116
 117     @Override
 118     public ToscaServiceTemplate getFilteredPolicyTypes(@NonNull ToscaPolicyTypeFilter filter) throws PfModelException {
 119         assertInitialized();
 120         return new AuthorativeToscaProvider().getFilteredPolicyTypes(getPfDao(), filter);
 121     }
 122
 123     @Override
 124     public List<ToscaPolicyType> getFilteredPolicyTypeList(@NonNull ToscaPolicyTypeFilter filter)
 125             throws PfModelException {
 126         assertInitialized();
 127         return new AuthorativeToscaProvider().getFilteredPolicyTypeList(getPfDao(), filter);
 128     }
 129
 130     @Override
 131     public ToscaServiceTemplate createPolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
 132             throws PfModelException {
 133         assertInitialized();
 134         return new AuthorativeToscaProvider().createPolicyTypes(getPfDao(), serviceTemplate);
 135     }
 136
 137     @Override
 138     public ToscaServiceTemplate updatePolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
 139             throws PfModelException {
 140         assertInitialized();
 141         return new AuthorativeToscaProvider().updatePolicyTypes(getPfDao(), serviceTemplate);
 142     }
 143
 144     @Override
 145     public ToscaServiceTemplate deletePolicyType(@NonNull final String name, @NonNull final String version)
 146             throws PfModelException {
 147         assertInitialized();
 148
 149         ToscaConceptIdentifier policyTypeIdentifier = new ToscaConceptIdentifier(name, version);
 150         assertPolicyTypeNotSupportedInPdpGroup(policyTypeIdentifier);
 151
 152         return new AuthorativeToscaProvider().deletePolicyType(getPfDao(), name, version);
 153     }
 154
 155     @Override
 156     public ToscaServiceTemplate getPolicies(final String name, final String version) throws PfModelException {
 157         assertInitialized();
 158         return new AuthorativeToscaProvider().getPolicies(getPfDao(), name, version);
 159     }
 160
 161     @Override
 162     public List<ToscaPolicy> getPolicyList(final String name, final String version) throws PfModelException {
 163         assertInitialized();
 164         return new AuthorativeToscaProvider().getPolicyList(getPfDao(), name, version);
 165     }
 166
 167     @Override
 168     public ToscaServiceTemplate getFilteredPolicies(@NonNull ToscaPolicyFilter filter) throws PfModelException {
 169         assertInitialized();
 170         return new AuthorativeToscaProvider().getFilteredPolicies(getPfDao(), filter);
 171     }
 172
 173     @Override
 174     public List<ToscaPolicy> getFilteredPolicyList(@NonNull ToscaPolicyFilter filter) throws PfModelException {
 175         assertInitialized();
 176         return new AuthorativeToscaProvider().getFilteredPolicyList(getPfDao(), filter);
 177     }
 178
 179     @Override
 180     public ToscaServiceTemplate createPolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
 181             throws PfModelException {
 182         assertInitialized();
 183         return new AuthorativeToscaProvider().createPolicies(getPfDao(), serviceTemplate);
 184     }
 185
 186     @Override
 187     public ToscaServiceTemplate updatePolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
 188             throws PfModelException {
 189         assertInitialized();
 190         return new AuthorativeToscaProvider().updatePolicies(getPfDao(), serviceTemplate);
 191     }
 192
 193     @Override
 194     public ToscaServiceTemplate deletePolicy(@NonNull final String name, @NonNull final String version)
 195             throws PfModelException {
 196         assertInitialized();
 197
 198         ToscaConceptIdentifier policyIdentifier = new ToscaConceptIdentifier(name, version);
 199         assertPolicyNotDeployedInPdpGroup(policyIdentifier);
 200
 201         return new AuthorativeToscaProvider().deletePolicy(getPfDao(), name, version);
 202     }
 203
 204     @Override
 205     public List<PdpGroup> getPdpGroups(final String name) throws PfModelException {
 206         assertInitialized();
 207         return new PdpProvider().getPdpGroups(getPfDao(), name);
 208     }
 209
 210     @Override
 211     public List<PdpGroup> getFilteredPdpGroups(@NonNull PdpGroupFilter filter) throws PfModelException {
 212         assertInitialized();
 213         return new PdpProvider().getFilteredPdpGroups(getPfDao(), filter);
 214     }
 215
 216     @Override
 217     public List<PdpGroup> createPdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
 218         assertInitialized();
 219         return new PdpProvider().createPdpGroups(getPfDao(), pdpGroups);
 220     }
 221
 222     @Override
 223     public List<PdpGroup> updatePdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
 224         assertInitialized();
 225         return new PdpProvider().updatePdpGroups(getPfDao(), pdpGroups);
 226     }
 227
 228     @Override
 229     public void updatePdpSubGroup(@NonNull final String pdpGroupName, @NonNull final PdpSubGroup pdpSubGroup)
 230             throws PfModelException {
 231         assertInitialized();
 232         new PdpProvider().updatePdpSubGroup(getPfDao(), pdpGroupName, pdpSubGroup);
 233     }
 234
 235     @Override
 236     public void updatePdp(@NonNull String pdpGroupName, @NonNull String pdpSubGroup, @NonNull Pdp pdp)
 237             throws PfModelException {
 238         new PdpProvider().updatePdp(getPfDao(), pdpGroupName, pdpSubGroup, pdp);
 239     }
 240
 241     @Override
 242     public PdpGroup deletePdpGroup(@NonNull final String name) throws PfModelException {
 243         assertInitialized();
 244         return new PdpProvider().deletePdpGroup(getPfDao(), name);
 245     }
 246
 247     @Override
 248     public List<PdpStatistics> getPdpStatistics(final String name, final Date timestamp) throws PfModelException {
 249         assertInitialized();
 250         return new PdpStatisticsProvider().getPdpStatistics(getPfDao(), name, timestamp);
 251     }
 252
 253     @Override
 254     public List<PdpStatistics> getFilteredPdpStatistics(final String name, @NonNull final String pdpGroupName,
 255             final String pdpSubGroup, final Date startTimeStamp, final Date endTimeStamp, final String sortOrder,
 256             final int getRecordNum) throws PfModelException {
 257         assertInitialized();
 258         return new PdpStatisticsProvider().getFilteredPdpStatistics(getPfDao(), name, pdpGroupName, pdpSubGroup,
 259                 startTimeStamp, endTimeStamp, sortOrder, getRecordNum);
 260     }
 261
 262     @Override
 263     public List<PdpStatistics> createPdpStatistics(@NonNull final List<PdpStatistics> pdpStatisticsList)
 264             throws PfModelException {
 265         assertInitialized();
 266         return new PdpStatisticsProvider().createPdpStatistics(getPfDao(), pdpStatisticsList);
 267     }
 268
 269     @Override
 270     public List<PdpStatistics> updatePdpStatistics(@NonNull final List<PdpStatistics> pdpStatisticsList)
 271             throws PfModelException {
 272         assertInitialized();
 273         return new PdpStatisticsProvider().updatePdpStatistics(getPfDao(), pdpStatisticsList);
 274     }
 275
 276     @Override
 277     public List<PdpStatistics> deletePdpStatistics(@NonNull final String name, final Date timestamp)
 278             throws PfModelException {
 279         assertInitialized();
 280         return new PdpStatisticsProvider().deletePdpStatistics(getPfDao(), name, timestamp);
 281     }
 282
 283     @Override
 284     public List<PdpPolicyStatus> getAllPolicyStatus() throws PfModelException {
 285         assertInitialized();
 286         return new PdpProvider().getAllPolicyStatus(getPfDao());
 287     }
 288
 289     @Override
 290     public List<PdpPolicyStatus> getAllPolicyStatus(@NonNull ToscaConceptIdentifierOptVersion policy)
 291                     throws PfModelException {
 292         assertInitialized();
 293         return new PdpProvider().getAllPolicyStatus(getPfDao(), policy);
 294     }
 295
 296     @Override
 297     public List<PdpPolicyStatus> getGroupPolicyStatus(@NonNull String groupName)
 298                     throws PfModelException {
 299         assertInitialized();
 300         return new PdpProvider().getGroupPolicyStatus(getPfDao(), groupName);
 301     }
 302
 303     @Override
 304     public void cudPolicyStatus(Collection<PdpPolicyStatus> createObjs,
 305                     Collection<PdpPolicyStatus> updateObjs, Collection<PdpPolicyStatus> deleteObjs) {
 306         assertInitialized();
 307         new PdpProvider().cudPolicyStatus(getPfDao(), createObjs, updateObjs, deleteObjs);
 308     }
 309
 310     /**
 311      * Check if the model provider is initialized.
 312      */
 313     private void assertInitialized() {
 314         if (getPfDao() == null) {
 315             String errorMessage = "policy models provider is not initilaized";
 316             throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage);
 317         }
 318     }
 319
 320     /**
 321      * Assert that the policy type is not supported in any PDP group.
 322      *
 323      * @param policyTypeIdentifier the policy type identifier
 324      * @throws PfModelException if the policy type is supported in a PDP group
 325      */
 326     private void assertPolicyTypeNotSupportedInPdpGroup(ToscaConceptIdentifier policyTypeIdentifier)
 327             throws PfModelException {
 328         for (PdpGroup pdpGroup : getPdpGroups(null)) {
 329             for (PdpSubGroup pdpSubGroup : pdpGroup.getPdpSubgroups()) {
 330                 if (pdpSubGroup.getSupportedPolicyTypes().contains(policyTypeIdentifier)) {
 331                     throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE,
 332                             "policy type is in use, it is referenced in PDP group " + pdpGroup.getName() + " subgroup "
 333                                     + pdpSubGroup.getPdpType());
 334                 }
 335             }
 336         }
 337     }
 338
 339     /**
 340      * Assert that the policy is not deployed in a PDP group.
 341      *
 342      * @param policyIdentifier the identifier of the policy
 343      * @throws PfModelException thrown if the policy is deployed in a PDP group
 344      */
 345     private void assertPolicyNotDeployedInPdpGroup(final ToscaConceptIdentifier policyIdentifier)
 346             throws PfModelException {
 347         for (PdpGroup pdpGroup : getPdpGroups(null)) {
 348             for (PdpSubGroup pdpSubGroup : pdpGroup.getPdpSubgroups()) {
 349                 if (pdpSubGroup.getPolicies().contains(policyIdentifier)) {
 350                     throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE,
 351                             "policy is in use, it is deployed in PDP group " + pdpGroup.getName() + " subgroup "
 352                                     + pdpSubGroup.getPdpType());
 353                 }
 354             }
 355         }
 356     }
 357 }