/*-
* ============LICENSE_START=======================================================
- * Copyright (C) 2019 Nordix Foundation.
+ * Copyright (C) 2019-2021 Nordix Foundation.
+ * Modifications Copyright (C) 2019-2020 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.Date;
import java.util.List;
-import java.util.Map;
-
+import java.util.Properties;
import javax.ws.rs.core.Response;
-
import lombok.NonNull;
-
-import org.apache.commons.lang3.tuple.Pair;
+import org.eclipse.persistence.config.PersistenceUnitProperties;
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.Pdp;
import org.onap.policy.models.pdp.concepts.PdpGroup;
+import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
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.ToscaPolicy;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyFilter;
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;
import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplateFilter;
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;
* @author Liam Fallon (liam.fallon@est.tech)
*/
public class DatabasePolicyModelsProviderImpl implements PolicyModelsProvider {
- private static final Logger LOGGER = LoggerFactory.getLogger(DefaultPfDao.class);
+
+ 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
- private Connection connection;
private PfDao pfDao;
/**
LOGGER.debug("opening the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
parameters.getPersistenceUnit());
- if (connection != null || pfDao != null) {
+ if (pfDao != null) {
String errorMessage = "provider is already initialized";
LOGGER.warn(errorMessage);
throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errorMessage);
}
- // 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);
- }
-
// Parameters for the DAO
final DaoParameters daoParameters = new DaoParameters();
- daoParameters.setPluginClass(DefaultPfDao.class.getCanonicalName());
+ daoParameters.setPluginClass(DefaultPfDao.class.getName());
daoParameters.setPersistenceUnit(parameters.getPersistenceUnit());
+ // @formatter:off
+ Properties jdbcProperties = new Properties();
+ jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_DRIVER, parameters.getDatabaseDriver());
+ jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_URL, parameters.getDatabaseUrl());
+ jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_USER, parameters.getDatabaseUser());
+ jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_PASSWORD, parameters.getDatabasePassword());
+ // @formatter:on
+
+ daoParameters.setJdbcProperties(jdbcProperties);
+
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);
pfDao = null;
}
- 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;
- }
- }
-
LOGGER.debug("closed the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
parameters.getPersistenceUnit());
}
+ @Override
+ public List<ToscaServiceTemplate> getServiceTemplateList(final String name, final String version)
+ throws PfModelException {
+ assertInitialized();
+ return new AuthorativeToscaProvider().getServiceTemplateList(pfDao, name, version);
+ }
+
+
+ @Override
+ public List<ToscaServiceTemplate> getFilteredServiceTemplateList(@NonNull ToscaServiceTemplateFilter filter)
+ throws PfModelException {
+ assertInitialized();
+ return new AuthorativeToscaProvider().getFilteredServiceTemplateList(pfDao, filter);
+ }
+
+ @Override
+ public ToscaServiceTemplate createServiceTemplate(@NonNull final ToscaServiceTemplate serviceTemplate)
+ throws PfModelException {
+ assertInitialized();
+ return new AuthorativeToscaProvider().createServiceTemplate(pfDao, serviceTemplate);
+ }
+
+ @Override
+ public ToscaServiceTemplate updateServiceTemplate(@NonNull final ToscaServiceTemplate serviceTemplate)
+ throws PfModelException {
+ assertInitialized();
+ return new AuthorativeToscaProvider().updateServiceTemplate(pfDao, serviceTemplate);
+ }
+
+ @Override
+ public ToscaServiceTemplate deleteServiceTemplate(@NonNull final String name, @NonNull final String version)
+ throws PfModelException {
+ assertInitialized();
+
+ return new AuthorativeToscaProvider().deleteServiceTemplate(pfDao, name, version);
+ }
+
@Override
public ToscaServiceTemplate getPolicyTypes(final String name, final String version) throws PfModelException {
- assertInitilized();
+ assertInitialized();
return new AuthorativeToscaProvider().getPolicyTypes(pfDao, name, version);
}
@Override
public List<ToscaPolicyType> getPolicyTypeList(final String name, final String version) throws PfModelException {
- assertInitilized();
+ assertInitialized();
return new AuthorativeToscaProvider().getPolicyTypeList(pfDao, name, version);
}
@Override
- public ToscaServiceTemplate getLatestPolicyTypes(final String name) throws PfModelException {
- assertInitilized();
- return new AuthorativeToscaProvider().getLatestPolicyTypes(pfDao, name);
+ public ToscaServiceTemplate getFilteredPolicyTypes(@NonNull ToscaPolicyTypeFilter filter) throws PfModelException {
+ assertInitialized();
+ return new AuthorativeToscaProvider().getFilteredPolicyTypes(pfDao, filter);
}
@Override
- public List<ToscaPolicyType> getLatestPolicyTypeList(final String name) throws PfModelException {
- assertInitilized();
- return new AuthorativeToscaProvider().getLatestPolicyTypeList(pfDao, name);
+ public List<ToscaPolicyType> getFilteredPolicyTypeList(@NonNull ToscaPolicyTypeFilter filter)
+ throws PfModelException {
+ assertInitialized();
+ return new AuthorativeToscaProvider().getFilteredPolicyTypeList(pfDao, filter);
}
@Override
public ToscaServiceTemplate createPolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
throws PfModelException {
- assertInitilized();
+ assertInitialized();
return new AuthorativeToscaProvider().createPolicyTypes(pfDao, serviceTemplate);
}
@Override
public ToscaServiceTemplate updatePolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
throws PfModelException {
- assertInitilized();
+ assertInitialized();
return new AuthorativeToscaProvider().updatePolicyTypes(pfDao, serviceTemplate);
}
@Override
public ToscaServiceTemplate deletePolicyType(@NonNull final String name, @NonNull final String version)
throws PfModelException {
- assertInitilized();
+ assertInitialized();
+
+ ToscaConceptIdentifier policyTypeIdentifier = new ToscaConceptIdentifier(name, version);
+ assertPolicyTypeNotSupportedInPdpGroup(policyTypeIdentifier);
+
return new AuthorativeToscaProvider().deletePolicyType(pfDao, name, version);
}
@Override
public ToscaServiceTemplate getPolicies(final String name, final String version) throws PfModelException {
- assertInitilized();
+ assertInitialized();
return new AuthorativeToscaProvider().getPolicies(pfDao, name, version);
}
@Override
public List<ToscaPolicy> getPolicyList(final String name, final String version) throws PfModelException {
- assertInitilized();
+ assertInitialized();
return new AuthorativeToscaProvider().getPolicyList(pfDao, name, version);
}
@Override
- public List<ToscaPolicy> getPolicyList4PolicyType(@NonNull final String policyTypeName,
- final String policyTypeVersion) throws PfModelException {
- assertInitilized();
- return new AuthorativeToscaProvider().getPolicyList4PolicyType(pfDao, policyTypeName, policyTypeVersion);
- }
-
- @Override
- public ToscaServiceTemplate getLatestPolicies(final String name) throws PfModelException {
- assertInitilized();
- return new AuthorativeToscaProvider().getLatestPolicies(pfDao, name);
+ public ToscaServiceTemplate getFilteredPolicies(@NonNull ToscaPolicyFilter filter) throws PfModelException {
+ assertInitialized();
+ return new AuthorativeToscaProvider().getFilteredPolicies(pfDao, filter);
}
@Override
- public List<ToscaPolicy> getLatestPolicyList(final String name) throws PfModelException {
- assertInitilized();
- return new AuthorativeToscaProvider().getLatestPolicyList(pfDao, name);
+ public List<ToscaPolicy> getFilteredPolicyList(@NonNull ToscaPolicyFilter filter) throws PfModelException {
+ assertInitialized();
+ return new AuthorativeToscaProvider().getFilteredPolicyList(pfDao, filter);
}
@Override
public ToscaServiceTemplate createPolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
throws PfModelException {
- assertInitilized();
+ assertInitialized();
return new AuthorativeToscaProvider().createPolicies(pfDao, serviceTemplate);
}
@Override
public ToscaServiceTemplate updatePolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
throws PfModelException {
- assertInitilized();
+ assertInitialized();
return new AuthorativeToscaProvider().updatePolicies(pfDao, serviceTemplate);
}
@Override
public ToscaServiceTemplate deletePolicy(@NonNull final String name, @NonNull final String version)
throws PfModelException {
- assertInitilized();
- return new AuthorativeToscaProvider().deletePolicy(pfDao, name, version);
- }
+ assertInitialized();
- @Override
- public LegacyOperationalPolicy getOperationalPolicy(@NonNull final String policyId) throws PfModelException {
- assertInitilized();
- return new LegacyProvider().getOperationalPolicy(pfDao, policyId);
- }
+ ToscaConceptIdentifier policyIdentifier = new ToscaConceptIdentifier(name, version);
+ assertPolicyNotDeployedInPdpGroup(policyIdentifier);
- @Override
- public LegacyOperationalPolicy createOperationalPolicy(
- @NonNull final LegacyOperationalPolicy legacyOperationalPolicy) throws PfModelException {
- assertInitilized();
- return new LegacyProvider().createOperationalPolicy(pfDao, legacyOperationalPolicy);
- }
-
- @Override
- public LegacyOperationalPolicy updateOperationalPolicy(
- @NonNull final LegacyOperationalPolicy legacyOperationalPolicy) throws PfModelException {
- assertInitilized();
- return new LegacyProvider().updateOperationalPolicy(pfDao, legacyOperationalPolicy);
+ return new AuthorativeToscaProvider().deletePolicy(pfDao, name, version);
}
@Override
- public LegacyOperationalPolicy deleteOperationalPolicy(@NonNull final String policyId) throws PfModelException {
- assertInitilized();
- return new LegacyProvider().deleteOperationalPolicy(pfDao, policyId);
+ public List<PdpGroup> getPdpGroups(final String name) throws PfModelException {
+ assertInitialized();
+ return new PdpProvider().getPdpGroups(pfDao, name);
}
@Override
- public Map<String, LegacyGuardPolicyOutput> getGuardPolicy(@NonNull final String policyId) throws PfModelException {
- assertInitilized();
- return new LegacyProvider().getGuardPolicy(pfDao, policyId);
+ public List<PdpGroup> getFilteredPdpGroups(@NonNull PdpGroupFilter filter) throws PfModelException {
+ assertInitialized();
+ return new PdpProvider().getFilteredPdpGroups(pfDao, filter);
}
@Override
- public Map<String, LegacyGuardPolicyOutput> createGuardPolicy(
- @NonNull final LegacyGuardPolicyInput legacyGuardPolicy) throws PfModelException {
- assertInitilized();
- return new LegacyProvider().createGuardPolicy(pfDao, legacyGuardPolicy);
+ public List<PdpGroup> createPdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
+ assertInitialized();
+ return new PdpProvider().createPdpGroups(pfDao, pdpGroups);
}
@Override
- public Map<String, LegacyGuardPolicyOutput> updateGuardPolicy(
- @NonNull final LegacyGuardPolicyInput legacyGuardPolicy) throws PfModelException {
- assertInitilized();
- return new LegacyProvider().updateGuardPolicy(pfDao, legacyGuardPolicy);
+ public List<PdpGroup> updatePdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
+ assertInitialized();
+ return new PdpProvider().updatePdpGroups(pfDao, pdpGroups);
}
@Override
- public Map<String, LegacyGuardPolicyOutput> deleteGuardPolicy(@NonNull final String policyId)
+ public void updatePdpSubGroup(@NonNull final String pdpGroupName, @NonNull final PdpSubGroup pdpSubGroup)
throws PfModelException {
- assertInitilized();
- return new LegacyProvider().deleteGuardPolicy(pfDao, policyId);
- }
-
- @Override
- public List<PdpGroup> getPdpGroups(final String name, final String version) throws PfModelException {
- assertInitilized();
- return new PdpProvider().getPdpGroups(pfDao, name, version);
- }
-
- @Override
- public List<PdpGroup> getLatestPdpGroups(final String name) throws PfModelException {
- assertInitilized();
- return new PdpProvider().getLatestPdpGroups(pfDao, name);
+ assertInitialized();
+ new PdpProvider().updatePdpSubGroup(pfDao, pdpGroupName, pdpSubGroup);
}
@Override
- public List<PdpGroup> getFilteredPdpGroups(final String pdpType,
- @NonNull final List<Pair<String, String>> supportedPolicyTypes) {
- assertInitilized();
- return new PdpProvider().getFilteredPdpGroups(pfDao, pdpType, supportedPolicyTypes);
+ public void updatePdp(@NonNull String pdpGroupName, @NonNull String pdpSubGroup, @NonNull Pdp pdp)
+ throws PfModelException {
+ new PdpProvider().updatePdp(pfDao, pdpGroupName, pdpSubGroup, pdp);
}
@Override
- public List<PdpGroup> createPdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
- assertInitilized();
- return new PdpProvider().createPdpGroups(pfDao, pdpGroups);
+ public PdpGroup deletePdpGroup(@NonNull final String name) throws PfModelException {
+ assertInitialized();
+ return new PdpProvider().deletePdpGroup(pfDao, name);
}
@Override
- public List<PdpGroup> updatePdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
- assertInitilized();
- return new PdpProvider().updatePdpGroups(pfDao, pdpGroups);
+ public List<PdpStatistics> getPdpStatistics(final String name, final Date timestamp) throws PfModelException {
+ assertInitialized();
+ return new PdpStatisticsProvider().getPdpStatistics(pfDao, name, timestamp);
}
@Override
- public void updatePdpSubGroup(@NonNull final String pdpGroupName, @NonNull final String pdpGroupVersion,
- @NonNull final PdpSubGroup pdpSubGroup) throws PfModelException {
- assertInitilized();
- new PdpProvider().updatePdpSubGroup(pfDao, pdpGroupName, pdpGroupVersion, pdpSubGroup);
+ public List<PdpStatistics> getFilteredPdpStatistics(final String name, @NonNull final String pdpGroupName,
+ final String pdpSubGroup, final Date startTimeStamp, final Date endTimeStamp, final String sortOrder,
+ final int getRecordNum) throws PfModelException {
+ assertInitialized();
+ return new PdpStatisticsProvider().getFilteredPdpStatistics(pfDao, name, pdpGroupName, pdpSubGroup,
+ startTimeStamp, endTimeStamp, sortOrder, getRecordNum);
}
@Override
- public PdpGroup deletePdpGroup(@NonNull final String name, @NonNull final String version) throws PfModelException {
- assertInitilized();
- return new PdpProvider().deletePdpGroup(pfDao, name, version);
- }
-
- @Override
- public List<PdpStatistics> getPdpStatistics(final String name, final String version) throws PfModelException {
- assertInitilized();
- return new PdpProvider().getPdpStatistics(pfDao, name, version);
+ public List<PdpStatistics> createPdpStatistics(@NonNull final List<PdpStatistics> pdpStatisticsList)
+ throws PfModelException {
+ assertInitialized();
+ return new PdpStatisticsProvider().createPdpStatistics(pfDao, pdpStatisticsList);
}
@Override
- public void updatePdpStatistics(@NonNull final String pdpGroupName, @NonNull final String pdpGroupVersion,
- @NonNull final String pdpType, @NonNull final String pdpInstanceId,
- @NonNull final PdpStatistics pdppStatistics) throws PfModelException {
- assertInitilized();
- new PdpProvider().updatePdpStatistics(pfDao, pdpGroupName, pdpGroupVersion, pdpType, pdpInstanceId,
- pdppStatistics);
+ public List<PdpStatistics> updatePdpStatistics(@NonNull final List<PdpStatistics> pdpStatisticsList)
+ throws PfModelException {
+ assertInitialized();
+ return new PdpStatisticsProvider().updatePdpStatistics(pfDao, pdpStatisticsList);
}
@Override
- public Map<Pair<String, String>, List<ToscaPolicy>> getDeployedPolicyList(final String name)
+ public List<PdpStatistics> deletePdpStatistics(@NonNull final String name, final Date timestamp)
throws PfModelException {
- assertInitilized();
- return new PdpProvider().getDeployedPolicyList(pfDao, name);
+ assertInitialized();
+ return new PdpStatisticsProvider().deletePdpStatistics(pfDao, name, timestamp);
}
/**
* Check if the model provider is initialized.
*/
- private void assertInitilized() {
+ private void assertInitialized() {
if (pfDao == null) {
String errorMessage = "policy models provider is not initilaized";
LOGGER.warn(errorMessage);
}
/**
- * Hook for unit test mocking of database connection.
+ * Assert that the policy type is not supported in any PDP group.
*
- * @param client the mocked client
+ * @param policyTypeIdentifier the policy type identifier
+ * @throws PfModelException if the policy type is supported in a PDP group
*/
- protected void setConnection(final Connection connection) {
- this.connection = connection;
+ 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());
+ }
+ }
+ }
}
}