/*-
* ============LICENSE_START=======================================================
- * Copyright (C) 2019-2021 Nordix Foundation.
+ * Copyright (C) 2019-2021, 2023 Nordix Foundation.
* Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
- * Modifications Copyright (C) 2020 Bell Canada. All rights reserved.
+ * Modifications Copyright (C) 2020, 2022 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.
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 jakarta.ws.rs.core.Response;
+import lombok.Getter;
import lombok.NonNull;
import org.onap.policy.models.base.PfModelException;
-import org.onap.policy.models.base.PfModelRuntimeException;
-import org.onap.policy.models.pap.concepts.PolicyAudit;
-import org.onap.policy.models.pap.persistence.provider.PolicyAuditProvider;
-import org.onap.policy.models.pap.persistence.provider.PolicyAuditProvider.AuditFilter;
-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.PdpFilterParameters;
-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.dao.PfDao;
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;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
/**
* This class provides an implementation of the Policy Models Provider for the ONAP Policy Framework that works towards
*
* @author Liam Fallon (liam.fallon@est.tech)
*/
-public class DatabasePolicyModelsProviderImpl extends AbstractModelsProvider implements PolicyModelsProvider {
+public class DatabasePolicyModelsProviderImpl extends AbstractPolicyModelsProvider {
+
+ private static final Logger LOGGER = LoggerFactory.getLogger(DatabasePolicyModelsProviderImpl.class);
+
+ private final PolicyModelsProviderParameters parameters;
+
+ // Database connection and the DAO for reading and writing Policy Framework concepts
+ @Getter
+ private PfDao pfDao;
+
/**
* Constructor that takes the parameters.
*
* @param parameters the parameters for the provider
*/
public DatabasePolicyModelsProviderImpl(@NonNull final PolicyModelsProviderParameters parameters) {
- super(parameters);
- }
-
- @Override
- public List<ToscaServiceTemplate> getServiceTemplateList(final String name, final String version)
- throws PfModelException {
- assertInitialized();
- return new AuthorativeToscaProvider().getServiceTemplateList(getPfDao(), name, version);
- }
-
-
- @Override
- public List<ToscaServiceTemplate> getFilteredServiceTemplateList(
- @NonNull ToscaEntityFilter<ToscaServiceTemplate> 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<ToscaPolicyType> getPolicyTypeList(final String name, final String version) throws PfModelException {
- assertInitialized();
- return new AuthorativeToscaProvider().getPolicyTypeList(getPfDao(), name, version);
- }
-
- @Override
- public ToscaServiceTemplate getFilteredPolicyTypes(@NonNull ToscaEntityFilter<ToscaPolicyType> filter)
- throws PfModelException {
- assertInitialized();
- return new AuthorativeToscaProvider().getFilteredPolicyTypes(getPfDao(), filter);
- }
-
- @Override
- public List<ToscaPolicyType> getFilteredPolicyTypeList(@NonNull ToscaEntityFilter<ToscaPolicyType> 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();
-
- var 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<ToscaPolicy> getPolicyList(final String name, final String version) throws PfModelException {
- assertInitialized();
- return new AuthorativeToscaProvider().getPolicyList(getPfDao(), name, version);
- }
-
- @Override
- public ToscaServiceTemplate getFilteredPolicies(@NonNull ToscaTypedEntityFilter<ToscaPolicy> filter)
- throws PfModelException {
- assertInitialized();
- return new AuthorativeToscaProvider().getFilteredPolicies(getPfDao(), filter);
- }
-
- @Override
- public List<ToscaPolicy> getFilteredPolicyList(@NonNull ToscaTypedEntityFilter<ToscaPolicy> filter)
- throws PfModelException {
- assertInitialized();
- return new AuthorativeToscaProvider().getFilteredPolicyList(getPfDao(), filter);
+ this.parameters = parameters;
}
@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);
- }
+ public synchronized void init() throws PfModelException {
+ LOGGER.debug("opening the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
+ parameters.getPersistenceUnit());
- @Override
- public ToscaServiceTemplate deletePolicy(@NonNull final String name, @NonNull final String version)
- throws PfModelException {
- assertInitialized();
-
- var policyIdentifier = new ToscaConceptIdentifier(name, version);
- assertPolicyNotDeployedInPdpGroup(policyIdentifier);
-
- return new AuthorativeToscaProvider().deletePolicy(getPfDao(), name, version);
- }
-
- @Override
- public List<PdpGroup> getPdpGroups(final String name) throws PfModelException {
- assertInitialized();
- return new PdpProvider().getPdpGroups(getPfDao(), name);
- }
-
- @Override
- public List<PdpGroup> getFilteredPdpGroups(@NonNull PdpGroupFilter filter) throws PfModelException {
- assertInitialized();
- return new PdpProvider().getFilteredPdpGroups(getPfDao(), filter);
- }
-
- @Override
- public List<PdpGroup> createPdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
- assertInitialized();
- return new PdpProvider().createPdpGroups(getPfDao(), pdpGroups);
- }
-
- @Override
- public List<PdpGroup> updatePdpGroups(@NonNull final List<PdpGroup> 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<PdpStatistics> getPdpStatistics(final String name, final Instant timestamp) throws PfModelException {
- assertInitialized();
- return new PdpStatisticsProvider().getPdpStatistics(getPfDao(), name, timestamp);
- }
-
- @Override
- public List<PdpStatistics> getFilteredPdpStatistics(PdpFilterParameters filterParams) throws PfModelException {
- assertInitialized();
- return new PdpStatisticsProvider().getFilteredPdpStatistics(getPfDao(), filterParams);
- }
-
- @Override
- public List<PdpStatistics> createPdpStatistics(@NonNull final List<PdpStatistics> pdpStatisticsList)
- throws PfModelException {
- assertInitialized();
- return new PdpStatisticsProvider().createPdpStatistics(getPfDao(), pdpStatisticsList);
- }
-
- @Override
- public List<PdpStatistics> updatePdpStatistics(@NonNull final List<PdpStatistics> pdpStatisticsList)
- throws PfModelException {
- assertInitialized();
- return new PdpStatisticsProvider().updatePdpStatistics(getPfDao(), pdpStatisticsList);
- }
-
- @Override
- public List<PdpStatistics> deletePdpStatistics(@NonNull final String name, final Instant timestamp)
- throws PfModelException {
- assertInitialized();
- return new PdpStatisticsProvider().deletePdpStatistics(getPfDao(), name, timestamp);
- }
-
- @Override
- public List<PdpPolicyStatus> getAllPolicyStatus() throws PfModelException {
- assertInitialized();
- return new PdpProvider().getAllPolicyStatus(getPfDao());
- }
-
- @Override
- public List<PdpPolicyStatus> getAllPolicyStatus(@NonNull ToscaConceptIdentifierOptVersion policy)
- throws PfModelException {
- assertInitialized();
- return new PdpProvider().getAllPolicyStatus(getPfDao(), policy);
- }
-
- @Override
- public List<PdpPolicyStatus> getGroupPolicyStatus(@NonNull String groupName) throws PfModelException {
- assertInitialized();
- return new PdpProvider().getGroupPolicyStatus(getPfDao(), groupName);
- }
-
- @Override
- public void cudPolicyStatus(Collection<PdpPolicyStatus> createObjs, Collection<PdpPolicyStatus> updateObjs,
- Collection<PdpPolicyStatus> deleteObjs) {
- assertInitialized();
- new PdpProvider().cudPolicyStatus(getPfDao(), createObjs, updateObjs, deleteObjs);
- }
+ if (pfDao != null) {
+ var errorMessage = "provider is already initialized";
+ throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errorMessage);
+ }
- @Override
- public void createAuditRecords(List<PolicyAudit> auditRecords) {
- assertInitialized();
- new PolicyAuditProvider().createAuditRecords(getPfDao(), auditRecords);
+ pfDao = ModelsProvider.init(parameters);
}
@Override
- public List<PolicyAudit> getAuditRecords(AuditFilter auditFilter) {
- assertInitialized();
- return new PolicyAuditProvider().getAuditRecords(getPfDao(), auditFilter);
- }
+ public synchronized void close() throws PfModelException {
+ LOGGER.debug("closing the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
+ parameters.getPersistenceUnit());
- /**
- * Check if the model provider is initialized.
- */
- private void assertInitialized() {
- if (getPfDao() == null) {
- var errorMessage = "policy models provider is not initilaized";
- throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage);
+ if (pfDao != null) {
+ pfDao.close();
+ pfDao = null;
}
- }
- /**
- * 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());
- }
- }
- }
+ LOGGER.debug("closed the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
+ parameters.getPersistenceUnit());
}
- /**
- * 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());
- }
- }
- }
- }
}
Code Review / policy / models.git / blobdiff