/*- * ============LICENSE_START======================================================= * Copyright (C) 2019-2021 Nordix Foundation. * Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved. * Modifications Copyright (C) 2020 Bell Canada. 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. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * SPDX-License-Identifier: Apache-2.0 * ============LICENSE_END========================================================= */ package org.onap.policy.models.provider.impl; import java.time.Instant; import java.util.Collection; import java.util.List; import javax.ws.rs.core.Response; import lombok.NonNull; import org.onap.policy.models.base.PfModelException; import org.onap.policy.models.base.PfModelRuntimeException; import org.onap.policy.models.pdp.concepts.Pdp; import org.onap.policy.models.pdp.concepts.PdpGroup; import org.onap.policy.models.pdp.concepts.PdpGroupFilter; import org.onap.policy.models.pdp.concepts.PdpPolicyStatus; import org.onap.policy.models.pdp.concepts.PdpStatistics; import org.onap.policy.models.pdp.concepts.PdpSubGroup; import org.onap.policy.models.pdp.persistence.provider.PdpProvider; import org.onap.policy.models.pdp.persistence.provider.PdpStatisticsProvider; import org.onap.policy.models.provider.PolicyModelsProvider; import org.onap.policy.models.provider.PolicyModelsProviderParameters; import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier; import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifierOptVersion; import org.onap.policy.models.tosca.authorative.concepts.ToscaEntityFilter; import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy; import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType; import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate; import org.onap.policy.models.tosca.authorative.concepts.ToscaTypedEntityFilter; import org.onap.policy.models.tosca.authorative.provider.AuthorativeToscaProvider; /** * This class provides an implementation of the Policy Models Provider for the ONAP Policy Framework that works towards * a relational database. * * @author Liam Fallon (liam.fallon@est.tech) */ public class DatabasePolicyModelsProviderImpl extends AbstractModelsProvider implements PolicyModelsProvider { /** * Constructor that takes the parameters. * * @param parameters the parameters for the provider */ public DatabasePolicyModelsProviderImpl(@NonNull final PolicyModelsProviderParameters parameters) { super(parameters); } @Override public List getServiceTemplateList(final String name, final String version) throws PfModelException { assertInitialized(); return new AuthorativeToscaProvider().getServiceTemplateList(getPfDao(), name, version); } @Override public List getFilteredServiceTemplateList( @NonNull ToscaEntityFilter filter) throws PfModelException { assertInitialized(); return new AuthorativeToscaProvider().getFilteredServiceTemplateList(getPfDao(), filter); } @Override public ToscaServiceTemplate createServiceTemplate(@NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException { assertInitialized(); return new AuthorativeToscaProvider().createServiceTemplate(getPfDao(), serviceTemplate); } @Override public ToscaServiceTemplate updateServiceTemplate(@NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException { assertInitialized(); return new AuthorativeToscaProvider().updateServiceTemplate(getPfDao(), serviceTemplate); } @Override public ToscaServiceTemplate deleteServiceTemplate(@NonNull final String name, @NonNull final String version) throws PfModelException { assertInitialized(); return new AuthorativeToscaProvider().deleteServiceTemplate(getPfDao(), name, version); } @Override public ToscaServiceTemplate getPolicyTypes(final String name, final String version) throws PfModelException { assertInitialized(); return new AuthorativeToscaProvider().getPolicyTypes(getPfDao(), name, version); } @Override public List getPolicyTypeList(final String name, final String version) throws PfModelException { assertInitialized(); return new AuthorativeToscaProvider().getPolicyTypeList(getPfDao(), name, version); } @Override public ToscaServiceTemplate getFilteredPolicyTypes(@NonNull ToscaEntityFilter filter) throws PfModelException { assertInitialized(); return new AuthorativeToscaProvider().getFilteredPolicyTypes(getPfDao(), filter); } @Override public List getFilteredPolicyTypeList(@NonNull ToscaEntityFilter filter) throws PfModelException { assertInitialized(); return new AuthorativeToscaProvider().getFilteredPolicyTypeList(getPfDao(), filter); } @Override public ToscaServiceTemplate createPolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException { assertInitialized(); return new AuthorativeToscaProvider().createPolicyTypes(getPfDao(), serviceTemplate); } @Override public ToscaServiceTemplate updatePolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException { assertInitialized(); return new AuthorativeToscaProvider().updatePolicyTypes(getPfDao(), serviceTemplate); } @Override public ToscaServiceTemplate deletePolicyType(@NonNull final String name, @NonNull final String version) throws PfModelException { assertInitialized(); ToscaConceptIdentifier policyTypeIdentifier = new ToscaConceptIdentifier(name, version); assertPolicyTypeNotSupportedInPdpGroup(policyTypeIdentifier); return new AuthorativeToscaProvider().deletePolicyType(getPfDao(), name, version); } @Override public ToscaServiceTemplate getPolicies(final String name, final String version) throws PfModelException { assertInitialized(); return new AuthorativeToscaProvider().getPolicies(getPfDao(), name, version); } @Override public List getPolicyList(final String name, final String version) throws PfModelException { assertInitialized(); return new AuthorativeToscaProvider().getPolicyList(getPfDao(), name, version); } @Override public ToscaServiceTemplate getFilteredPolicies(@NonNull ToscaTypedEntityFilter filter) throws PfModelException { assertInitialized(); return new AuthorativeToscaProvider().getFilteredPolicies(getPfDao(), filter); } @Override public List getFilteredPolicyList(@NonNull ToscaTypedEntityFilter filter) throws PfModelException { assertInitialized(); return new AuthorativeToscaProvider().getFilteredPolicyList(getPfDao(), filter); } @Override public ToscaServiceTemplate createPolicies(@NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException { assertInitialized(); return new AuthorativeToscaProvider().createPolicies(getPfDao(), serviceTemplate); } @Override public ToscaServiceTemplate updatePolicies(@NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException { assertInitialized(); return new AuthorativeToscaProvider().updatePolicies(getPfDao(), serviceTemplate); } @Override public ToscaServiceTemplate deletePolicy(@NonNull final String name, @NonNull final String version) throws PfModelException { assertInitialized(); ToscaConceptIdentifier policyIdentifier = new ToscaConceptIdentifier(name, version); assertPolicyNotDeployedInPdpGroup(policyIdentifier); return new AuthorativeToscaProvider().deletePolicy(getPfDao(), name, version); } @Override public List getPdpGroups(final String name) throws PfModelException { assertInitialized(); return new PdpProvider().getPdpGroups(getPfDao(), name); } @Override public List getFilteredPdpGroups(@NonNull PdpGroupFilter filter) throws PfModelException { assertInitialized(); return new PdpProvider().getFilteredPdpGroups(getPfDao(), filter); } @Override public List createPdpGroups(@NonNull final List pdpGroups) throws PfModelException { assertInitialized(); return new PdpProvider().createPdpGroups(getPfDao(), pdpGroups); } @Override public List updatePdpGroups(@NonNull final List pdpGroups) throws PfModelException { assertInitialized(); return new PdpProvider().updatePdpGroups(getPfDao(), pdpGroups); } @Override public void updatePdpSubGroup(@NonNull final String pdpGroupName, @NonNull final PdpSubGroup pdpSubGroup) throws PfModelException { assertInitialized(); new PdpProvider().updatePdpSubGroup(getPfDao(), pdpGroupName, pdpSubGroup); } @Override public void updatePdp(@NonNull String pdpGroupName, @NonNull String pdpSubGroup, @NonNull Pdp pdp) throws PfModelException { new PdpProvider().updatePdp(getPfDao(), pdpGroupName, pdpSubGroup, pdp); } @Override public PdpGroup deletePdpGroup(@NonNull final String name) throws PfModelException { assertInitialized(); return new PdpProvider().deletePdpGroup(getPfDao(), name); } @Override public List getPdpStatistics(final String name, final Instant timestamp) throws PfModelException { assertInitialized(); return new PdpStatisticsProvider().getPdpStatistics(getPfDao(), name, timestamp); } @Override public List getFilteredPdpStatistics(final String name, @NonNull final String pdpGroupName, final String pdpSubGroup, final Instant startTimeStamp, final Instant endTimeStamp, final String sortOrder, final int getRecordNum) throws PfModelException { assertInitialized(); return new PdpStatisticsProvider().getFilteredPdpStatistics(getPfDao(), name, pdpGroupName, pdpSubGroup, startTimeStamp, endTimeStamp, sortOrder, getRecordNum); } @Override public List createPdpStatistics(@NonNull final List pdpStatisticsList) throws PfModelException { assertInitialized(); return new PdpStatisticsProvider().createPdpStatistics(getPfDao(), pdpStatisticsList); } @Override public List updatePdpStatistics(@NonNull final List pdpStatisticsList) throws PfModelException { assertInitialized(); return new PdpStatisticsProvider().updatePdpStatistics(getPfDao(), pdpStatisticsList); } @Override public List deletePdpStatistics(@NonNull final String name, final Instant timestamp) throws PfModelException { assertInitialized(); return new PdpStatisticsProvider().deletePdpStatistics(getPfDao(), name, timestamp); } @Override public List getAllPolicyStatus() throws PfModelException { assertInitialized(); return new PdpProvider().getAllPolicyStatus(getPfDao()); } @Override public List getAllPolicyStatus(@NonNull ToscaConceptIdentifierOptVersion policy) throws PfModelException { assertInitialized(); return new PdpProvider().getAllPolicyStatus(getPfDao(), policy); } @Override public List getGroupPolicyStatus(@NonNull String groupName) throws PfModelException { assertInitialized(); return new PdpProvider().getGroupPolicyStatus(getPfDao(), groupName); } @Override public void cudPolicyStatus(Collection createObjs, Collection updateObjs, Collection deleteObjs) { assertInitialized(); new PdpProvider().cudPolicyStatus(getPfDao(), createObjs, updateObjs, deleteObjs); } /** * Check if the model provider is initialized. */ private void assertInitialized() { if (getPfDao() == null) { String errorMessage = "policy models provider is not initilaized"; throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage); } } /** * Assert that the policy type is not supported in any PDP group. * * @param policyTypeIdentifier the policy type identifier * @throws PfModelException if the policy type is supported in a PDP group */ private void assertPolicyTypeNotSupportedInPdpGroup(ToscaConceptIdentifier policyTypeIdentifier) throws PfModelException { for (PdpGroup pdpGroup : getPdpGroups(null)) { for (PdpSubGroup pdpSubGroup : pdpGroup.getPdpSubgroups()) { if (pdpSubGroup.getSupportedPolicyTypes().contains(policyTypeIdentifier)) { throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE, "policy type is in use, it is referenced in PDP group " + pdpGroup.getName() + " subgroup " + pdpSubGroup.getPdpType()); } } } } /** * Assert that the policy is not deployed in a PDP group. * * @param policyIdentifier the identifier of the policy * @throws PfModelException thrown if the policy is deployed in a PDP group */ private void assertPolicyNotDeployedInPdpGroup(final ToscaConceptIdentifier policyIdentifier) throws PfModelException { for (PdpGroup pdpGroup : getPdpGroups(null)) { for (PdpSubGroup pdpSubGroup : pdpGroup.getPdpSubgroups()) { if (pdpSubGroup.getPolicies().contains(policyIdentifier)) { throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE, "policy is in use, it is deployed in PDP group " + pdpGroup.getName() + " subgroup " + pdpSubGroup.getPdpType()); } } } } }