/*-
* ============LICENSE_START=======================================================
- * Copyright (C) 2019 Nordix Foundation.
+ * 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.
package org.onap.policy.models.provider.impl;
-import java.sql.Connection;
-import java.sql.DriverManager;
-import java.util.Base64;
-import java.util.Map;
-
+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.dao.DaoParameters;
-import org.onap.policy.models.dao.PfDao;
-import org.onap.policy.models.dao.PfDaoFactory;
-import org.onap.policy.models.dao.impl.DefaultPfDao;
-import org.onap.policy.models.pdp.concepts.PdpGroups;
+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;
-import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyInput;
-import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyOutput;
-import org.onap.policy.models.tosca.legacy.concepts.LegacyOperationalPolicy;
-import org.onap.policy.models.tosca.legacy.provider.LegacyProvider;
-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 implements PolicyModelsProvider {
- private static final Logger LOGGER = LoggerFactory.getLogger(DefaultPfDao.class);
-
- private final PolicyModelsProviderParameters parameters;
-
- // Database connection and the DAO for reading and writing Policy Framework concepts
- private Connection connection;
- private PfDao pfDao;
-
+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) {
- this.parameters = parameters;
+ super(parameters);
}
@Override
- public void init() throws PfModelException {
- LOGGER.debug("opening the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
- parameters.getPersistenceUnit());
+ public List<ToscaServiceTemplate> getServiceTemplateList(final String name, final String version)
+ throws PfModelException {
+ assertInitialized();
+ return new AuthorativeToscaProvider().getServiceTemplateList(getPfDao(), name, version);
+ }
- // Decode the password using Base64
- String decodedPassword = new String(Base64.getDecoder().decode(parameters.getDatabasePassword()));
- // Connect to the database, call does not implement AutoCloseable for try-with-resources
- try {
- connection = DriverManager.getConnection(parameters.getDatabaseUrl(), parameters.getDatabaseUser(),
- decodedPassword);
- } catch (Exception exc) {
- String errorMessage = "could not connect to database with URL \"" + parameters.getDatabaseUrl() + "\"";
- LOGGER.warn(errorMessage, exc);
- throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errorMessage, exc);
- }
+ @Override
+ public List<ToscaServiceTemplate> getFilteredServiceTemplateList(
+ @NonNull ToscaEntityFilter<ToscaServiceTemplate> filter) throws PfModelException {
+ assertInitialized();
+ return new AuthorativeToscaProvider().getFilteredServiceTemplateList(getPfDao(), filter);
+ }
- // Parameters for the DAO
- final DaoParameters daoParameters = new DaoParameters();
- daoParameters.setPluginClass(DefaultPfDao.class.getCanonicalName());
- daoParameters.setPersistenceUnit(parameters.getPersistenceUnit());
-
- try {
- pfDao = new PfDaoFactory().createPfDao(daoParameters);
- pfDao.init(daoParameters);
- } catch (Exception exc) {
- String errorMessage = "could not create Data Access Object (DAO) using url \"" + parameters.getDatabaseUrl()
- + "\" and persistence unit \"" + parameters.getPersistenceUnit() + "\"";
- LOGGER.warn(errorMessage, exc);
-
- this.close();
- throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errorMessage, exc);
- }
+ @Override
+ public ToscaServiceTemplate createServiceTemplate(@NonNull final ToscaServiceTemplate serviceTemplate)
+ throws PfModelException {
+ assertInitialized();
+ return new AuthorativeToscaProvider().createServiceTemplate(getPfDao(), serviceTemplate);
}
@Override
- public void close() throws PfModelException {
- LOGGER.debug("closing the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
- parameters.getPersistenceUnit());
+ public ToscaServiceTemplate updateServiceTemplate(@NonNull final ToscaServiceTemplate serviceTemplate)
+ throws PfModelException {
+ assertInitialized();
+ return new AuthorativeToscaProvider().updateServiceTemplate(getPfDao(), serviceTemplate);
+ }
- if (pfDao != null) {
- pfDao.close();
- pfDao = null;
- }
+ @Override
+ public ToscaServiceTemplate deleteServiceTemplate(@NonNull final String name, @NonNull final String version)
+ throws PfModelException {
+ assertInitialized();
- if (connection != null) {
- try {
- connection.close();
- } catch (Exception exc) {
-
- String errorMessage =
- "could not close connection to database with URL \"" + parameters.getDatabaseUrl() + "\"";
- LOGGER.warn(errorMessage, exc);
- throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, exc);
- } finally {
- connection = null;
- }
- }
+ 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);
+ }
- LOGGER.debug("closed the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
- parameters.getPersistenceUnit());
+ @Override
+ public ToscaServiceTemplate getFilteredPolicyTypes(@NonNull ToscaEntityFilter<ToscaPolicyType> filter)
+ throws PfModelException {
+ assertInitialized();
+ return new AuthorativeToscaProvider().getFilteredPolicyTypes(getPfDao(), filter);
}
@Override
- public ToscaServiceTemplate getPolicyTypes(@NonNull final String name, @NonNull final String version)
+ public List<ToscaPolicyType> getFilteredPolicyTypeList(@NonNull ToscaEntityFilter<ToscaPolicyType> filter)
throws PfModelException {
- assertInitilized();
- return new AuthorativeToscaProvider().getPolicyTypes(pfDao, name, version);
+ assertInitialized();
+ return new AuthorativeToscaProvider().getFilteredPolicyTypeList(getPfDao(), filter);
}
@Override
public ToscaServiceTemplate createPolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
throws PfModelException {
- assertInitilized();
- return new AuthorativeToscaProvider().createPolicyTypes(pfDao, serviceTemplate);
+ assertInitialized();
+ return new AuthorativeToscaProvider().createPolicyTypes(getPfDao(), serviceTemplate);
}
@Override
public ToscaServiceTemplate updatePolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
throws PfModelException {
- assertInitilized();
- return new AuthorativeToscaProvider().updatePolicyTypes(pfDao, serviceTemplate);
+ 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 deletePolicyTypes(@NonNull final String name, @NonNull final String version)
+ 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 {
- assertInitilized();
- return new AuthorativeToscaProvider().deletePolicyTypes(pfDao, name, version);
+ assertInitialized();
+ return new AuthorativeToscaProvider().getFilteredPolicies(getPfDao(), filter);
}
@Override
- public ToscaServiceTemplate getPolicies(@NonNull final String name, @NonNull final String version)
+ public List<ToscaPolicy> getFilteredPolicyList(@NonNull ToscaTypedEntityFilter<ToscaPolicy> filter)
throws PfModelException {
- assertInitilized();
- return new AuthorativeToscaProvider().getPolicies(pfDao, name, version);
+ assertInitialized();
+ return new AuthorativeToscaProvider().getFilteredPolicyList(getPfDao(), filter);
}
@Override
public ToscaServiceTemplate createPolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
throws PfModelException {
- assertInitilized();
- return new AuthorativeToscaProvider().createPolicies(pfDao, serviceTemplate);
+ assertInitialized();
+ return new AuthorativeToscaProvider().createPolicies(getPfDao(), serviceTemplate);
}
@Override
public ToscaServiceTemplate updatePolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
throws PfModelException {
- assertInitilized();
- return new AuthorativeToscaProvider().updatePolicies(pfDao, serviceTemplate);
+ assertInitialized();
+ return new AuthorativeToscaProvider().updatePolicies(getPfDao(), serviceTemplate);
}
@Override
- public ToscaServiceTemplate deletePolicies(@NonNull final String name, @NonNull final String version)
+ public ToscaServiceTemplate deletePolicy(@NonNull final String name, @NonNull final String version)
throws PfModelException {
- assertInitilized();
- return new AuthorativeToscaProvider().deletePolicies(pfDao, name, version);
+ assertInitialized();
+
+ ToscaConceptIdentifier 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 LegacyOperationalPolicy getOperationalPolicy(@NonNull final String policyId) throws PfModelException {
- assertInitilized();
- return new LegacyProvider().getOperationalPolicy(pfDao, policyId);
+ public void updatePdpSubGroup(@NonNull final String pdpGroupName, @NonNull final PdpSubGroup pdpSubGroup)
+ throws PfModelException {
+ assertInitialized();
+ new PdpProvider().updatePdpSubGroup(getPfDao(), pdpGroupName, pdpSubGroup);
}
@Override
- public LegacyOperationalPolicy createOperationalPolicy(
- @NonNull final LegacyOperationalPolicy legacyOperationalPolicy) throws PfModelException {
- assertInitilized();
- return new LegacyProvider().createOperationalPolicy(pfDao, legacyOperationalPolicy);
+ public void updatePdp(@NonNull String pdpGroupName, @NonNull String pdpSubGroup, @NonNull Pdp pdp)
+ throws PfModelException {
+ new PdpProvider().updatePdp(getPfDao(), pdpGroupName, pdpSubGroup, pdp);
}
@Override
- public LegacyOperationalPolicy updateOperationalPolicy(
- @NonNull final LegacyOperationalPolicy legacyOperationalPolicy) throws PfModelException {
- assertInitilized();
- return new LegacyProvider().updateOperationalPolicy(pfDao, legacyOperationalPolicy);
+ public PdpGroup deletePdpGroup(@NonNull final String name) throws PfModelException {
+ assertInitialized();
+ return new PdpProvider().deletePdpGroup(getPfDao(), name);
}
@Override
- public LegacyOperationalPolicy deleteOperationalPolicy(@NonNull final String policyId) throws PfModelException {
- assertInitilized();
- return new LegacyProvider().deleteOperationalPolicy(pfDao, policyId);
+ public List<PdpStatistics> getPdpStatistics(final String name, final Instant timestamp) throws PfModelException {
+ assertInitialized();
+ return new PdpStatisticsProvider().getPdpStatistics(getPfDao(), name, timestamp);
}
@Override
- public Map<String, LegacyGuardPolicyOutput> getGuardPolicy(@NonNull final String policyId) throws PfModelException {
- assertInitilized();
- return new LegacyProvider().getGuardPolicy(pfDao, policyId);
+ public List<PdpStatistics> 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 Map<String, LegacyGuardPolicyOutput> createGuardPolicy(
- @NonNull final LegacyGuardPolicyInput legacyGuardPolicy) throws PfModelException {
- assertInitilized();
- return new LegacyProvider().createGuardPolicy(pfDao, legacyGuardPolicy);
+ public List<PdpStatistics> createPdpStatistics(@NonNull final List<PdpStatistics> pdpStatisticsList)
+ throws PfModelException {
+ assertInitialized();
+ return new PdpStatisticsProvider().createPdpStatistics(getPfDao(), pdpStatisticsList);
}
@Override
- public Map<String, LegacyGuardPolicyOutput> updateGuardPolicy(
- @NonNull final LegacyGuardPolicyInput legacyGuardPolicy) throws PfModelException {
- assertInitilized();
- return new LegacyProvider().updateGuardPolicy(pfDao, legacyGuardPolicy);
+ public List<PdpStatistics> updatePdpStatistics(@NonNull final List<PdpStatistics> pdpStatisticsList)
+ throws PfModelException {
+ assertInitialized();
+ return new PdpStatisticsProvider().updatePdpStatistics(getPfDao(), pdpStatisticsList);
}
@Override
- public Map<String, LegacyGuardPolicyOutput> deleteGuardPolicy(@NonNull final String policyId)
+ public List<PdpStatistics> deletePdpStatistics(@NonNull final String name, final Instant timestamp)
throws PfModelException {
- assertInitilized();
- return new LegacyProvider().deleteGuardPolicy(pfDao, policyId);
+ assertInitialized();
+ return new PdpStatisticsProvider().deletePdpStatistics(getPfDao(), name, timestamp);
}
@Override
- public PdpGroups getPdpGroups(@NonNull String pdpGroupFilter) throws PfModelException {
- assertInitilized();
- return new PdpProvider().getPdpGroups(pfDao, pdpGroupFilter);
+ public List<PdpPolicyStatus> getAllPolicyStatus() throws PfModelException {
+ assertInitialized();
+ return new PdpProvider().getAllPolicyStatus(getPfDao());
}
@Override
- public PdpGroups createPdpGroups(@NonNull PdpGroups pdpGroups) throws PfModelException {
- assertInitilized();
- return new PdpProvider().createPdpGroups(pfDao, pdpGroups);
+ public List<PdpPolicyStatus> getAllPolicyStatus(@NonNull ToscaConceptIdentifierOptVersion policy)
+ throws PfModelException {
+ assertInitialized();
+ return new PdpProvider().getAllPolicyStatus(getPfDao(), policy);
}
@Override
- public PdpGroups updatePdpGroups(@NonNull PdpGroups pdpGroups) throws PfModelException {
- assertInitilized();
- return new PdpProvider().updatePdpGroups(pfDao, pdpGroups);
+ public List<PdpPolicyStatus> getGroupPolicyStatus(@NonNull String groupName) throws PfModelException {
+ assertInitialized();
+ return new PdpProvider().getGroupPolicyStatus(getPfDao(), groupName);
}
@Override
- public PdpGroups deletePdpGroups(@NonNull String pdpGroupFilter) throws PfModelException {
- assertInitilized();
- return new PdpProvider().deletePdpGroups(pfDao, pdpGroupFilter);
+ public void cudPolicyStatus(Collection<PdpPolicyStatus> createObjs, Collection<PdpPolicyStatus> updateObjs,
+ Collection<PdpPolicyStatus> deleteObjs) {
+ assertInitialized();
+ new PdpProvider().cudPolicyStatus(getPfDao(), createObjs, updateObjs, deleteObjs);
}
/**
* Check if the model provider is initialized.
*/
- private void assertInitilized() {
- if (pfDao == null) {
+ private void assertInitialized() {
+ if (getPfDao() == null) {
String errorMessage = "policy models provider is not initilaized";
- LOGGER.warn(errorMessage);
throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage);
}
}
/**
- * Hook for unit test mocking of database connection.
+ * 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 client the mocked client
+ * @param policyIdentifier the identifier of the policy
+ * @throws PfModelException thrown if the policy is deployed in a PDP group
*/
- protected void setConnection(final Connection connection) {
- this.connection = connection;
+ 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());
+ }
+ }
+ }
}
}