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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 * SPDX-License-Identifier: Apache-2.0
20 * ============LICENSE_END=========================================================
23 package org.onap.policy.models.provider.impl;
25 import java.util.Collection;
26 import java.util.Date;
27 import java.util.List;
28 import java.util.Properties;
29 import javax.ws.rs.core.Response;
30 import lombok.NonNull;
31 import org.eclipse.persistence.config.PersistenceUnitProperties;
32 import org.onap.policy.models.base.PfModelException;
33 import org.onap.policy.models.base.PfModelRuntimeException;
34 import org.onap.policy.models.dao.DaoParameters;
35 import org.onap.policy.models.dao.PfDao;
36 import org.onap.policy.models.dao.PfDaoFactory;
37 import org.onap.policy.models.dao.impl.DefaultPfDao;
38 import org.onap.policy.models.pdp.concepts.Pdp;
39 import org.onap.policy.models.pdp.concepts.PdpGroup;
40 import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
41 import org.onap.policy.models.pdp.concepts.PdpPolicyStatus;
42 import org.onap.policy.models.pdp.concepts.PdpStatistics;
43 import org.onap.policy.models.pdp.concepts.PdpSubGroup;
44 import org.onap.policy.models.pdp.persistence.provider.PdpProvider;
45 import org.onap.policy.models.pdp.persistence.provider.PdpStatisticsProvider;
46 import org.onap.policy.models.provider.PolicyModelsProvider;
47 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
48 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
49 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
50 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyFilter;
51 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
52 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;
53 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
54 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplateFilter;
55 import org.onap.policy.models.tosca.authorative.provider.AuthorativeToscaProvider;
56 import org.slf4j.Logger;
57 import org.slf4j.LoggerFactory;
60 * This class provides an implementation of the Policy Models Provider for the ONAP Policy Framework that works towards
61 * a relational database.
63 * @author Liam Fallon (liam.fallon@est.tech)
65 public class DatabasePolicyModelsProviderImpl implements PolicyModelsProvider {
67 private static final Logger LOGGER = LoggerFactory.getLogger(DatabasePolicyModelsProviderImpl.class);
69 private final PolicyModelsProviderParameters parameters;
71 // Database connection and the DAO for reading and writing Policy Framework concepts
75 * Constructor that takes the parameters.
77 * @param parameters the parameters for the provider
79 public DatabasePolicyModelsProviderImpl(@NonNull final PolicyModelsProviderParameters parameters) {
80 this.parameters = parameters;
84 public void init() throws PfModelException {
85 LOGGER.debug("opening the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
86 parameters.getPersistenceUnit());
89 String errorMessage = "provider is already initialized";
90 LOGGER.warn(errorMessage);
91 throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errorMessage);
94 // Parameters for the DAO
95 final DaoParameters daoParameters = new DaoParameters();
96 daoParameters.setPluginClass(DefaultPfDao.class.getName());
97 daoParameters.setPersistenceUnit(parameters.getPersistenceUnit());
100 Properties jdbcProperties = new Properties();
101 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_DRIVER, parameters.getDatabaseDriver());
102 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_URL, parameters.getDatabaseUrl());
103 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_USER, parameters.getDatabaseUser());
104 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_PASSWORD, parameters.getDatabasePassword());
107 daoParameters.setJdbcProperties(jdbcProperties);
110 pfDao = new PfDaoFactory().createPfDao(daoParameters);
111 pfDao.init(daoParameters);
112 } catch (Exception exc) {
113 String errorMessage = "could not create Data Access Object (DAO) using url \"" + parameters.getDatabaseUrl()
114 + "\" and persistence unit \"" + parameters.getPersistenceUnit() + "\"";
117 throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errorMessage, exc);
122 public void close() throws PfModelException {
123 LOGGER.debug("closing the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
124 parameters.getPersistenceUnit());
131 LOGGER.debug("closed the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
132 parameters.getPersistenceUnit());
136 public List<ToscaServiceTemplate> getServiceTemplateList(final String name, final String version)
137 throws PfModelException {
139 return new AuthorativeToscaProvider().getServiceTemplateList(pfDao, name, version);
144 public List<ToscaServiceTemplate> getFilteredServiceTemplateList(@NonNull ToscaServiceTemplateFilter filter)
145 throws PfModelException {
147 return new AuthorativeToscaProvider().getFilteredServiceTemplateList(pfDao, filter);
151 public ToscaServiceTemplate createServiceTemplate(@NonNull final ToscaServiceTemplate serviceTemplate)
152 throws PfModelException {
154 return new AuthorativeToscaProvider().createServiceTemplate(pfDao, serviceTemplate);
158 public ToscaServiceTemplate updateServiceTemplate(@NonNull final ToscaServiceTemplate serviceTemplate)
159 throws PfModelException {
161 return new AuthorativeToscaProvider().updateServiceTemplate(pfDao, serviceTemplate);
165 public ToscaServiceTemplate deleteServiceTemplate(@NonNull final String name, @NonNull final String version)
166 throws PfModelException {
169 return new AuthorativeToscaProvider().deleteServiceTemplate(pfDao, name, version);
173 public ToscaServiceTemplate getPolicyTypes(final String name, final String version) throws PfModelException {
175 return new AuthorativeToscaProvider().getPolicyTypes(pfDao, name, version);
179 public List<ToscaPolicyType> getPolicyTypeList(final String name, final String version) throws PfModelException {
181 return new AuthorativeToscaProvider().getPolicyTypeList(pfDao, name, version);
185 public ToscaServiceTemplate getFilteredPolicyTypes(@NonNull ToscaPolicyTypeFilter filter) throws PfModelException {
187 return new AuthorativeToscaProvider().getFilteredPolicyTypes(pfDao, filter);
191 public List<ToscaPolicyType> getFilteredPolicyTypeList(@NonNull ToscaPolicyTypeFilter filter)
192 throws PfModelException {
194 return new AuthorativeToscaProvider().getFilteredPolicyTypeList(pfDao, filter);
198 public ToscaServiceTemplate createPolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
199 throws PfModelException {
201 return new AuthorativeToscaProvider().createPolicyTypes(pfDao, serviceTemplate);
205 public ToscaServiceTemplate updatePolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
206 throws PfModelException {
208 return new AuthorativeToscaProvider().updatePolicyTypes(pfDao, serviceTemplate);
212 public ToscaServiceTemplate deletePolicyType(@NonNull final String name, @NonNull final String version)
213 throws PfModelException {
216 ToscaConceptIdentifier policyTypeIdentifier = new ToscaConceptIdentifier(name, version);
217 assertPolicyTypeNotSupportedInPdpGroup(policyTypeIdentifier);
219 return new AuthorativeToscaProvider().deletePolicyType(pfDao, name, version);
223 public ToscaServiceTemplate getPolicies(final String name, final String version) throws PfModelException {
225 return new AuthorativeToscaProvider().getPolicies(pfDao, name, version);
229 public List<ToscaPolicy> getPolicyList(final String name, final String version) throws PfModelException {
231 return new AuthorativeToscaProvider().getPolicyList(pfDao, name, version);
235 public ToscaServiceTemplate getFilteredPolicies(@NonNull ToscaPolicyFilter filter) throws PfModelException {
237 return new AuthorativeToscaProvider().getFilteredPolicies(pfDao, filter);
241 public List<ToscaPolicy> getFilteredPolicyList(@NonNull ToscaPolicyFilter filter) throws PfModelException {
243 return new AuthorativeToscaProvider().getFilteredPolicyList(pfDao, filter);
247 public ToscaServiceTemplate createPolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
248 throws PfModelException {
250 return new AuthorativeToscaProvider().createPolicies(pfDao, serviceTemplate);
254 public ToscaServiceTemplate updatePolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
255 throws PfModelException {
257 return new AuthorativeToscaProvider().updatePolicies(pfDao, serviceTemplate);
261 public ToscaServiceTemplate deletePolicy(@NonNull final String name, @NonNull final String version)
262 throws PfModelException {
265 ToscaConceptIdentifier policyIdentifier = new ToscaConceptIdentifier(name, version);
266 assertPolicyNotDeployedInPdpGroup(policyIdentifier);
268 return new AuthorativeToscaProvider().deletePolicy(pfDao, name, version);
272 public List<PdpGroup> getPdpGroups(final String name) throws PfModelException {
274 return new PdpProvider().getPdpGroups(pfDao, name);
278 public List<PdpGroup> getFilteredPdpGroups(@NonNull PdpGroupFilter filter) throws PfModelException {
280 return new PdpProvider().getFilteredPdpGroups(pfDao, filter);
284 public List<PdpGroup> createPdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
286 return new PdpProvider().createPdpGroups(pfDao, pdpGroups);
290 public List<PdpGroup> updatePdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
292 return new PdpProvider().updatePdpGroups(pfDao, pdpGroups);
296 public void updatePdpSubGroup(@NonNull final String pdpGroupName, @NonNull final PdpSubGroup pdpSubGroup)
297 throws PfModelException {
299 new PdpProvider().updatePdpSubGroup(pfDao, pdpGroupName, pdpSubGroup);
303 public void updatePdp(@NonNull String pdpGroupName, @NonNull String pdpSubGroup, @NonNull Pdp pdp)
304 throws PfModelException {
305 new PdpProvider().updatePdp(pfDao, pdpGroupName, pdpSubGroup, pdp);
309 public PdpGroup deletePdpGroup(@NonNull final String name) throws PfModelException {
311 return new PdpProvider().deletePdpGroup(pfDao, name);
315 public List<PdpStatistics> getPdpStatistics(final String name, final Date timestamp) throws PfModelException {
317 return new PdpStatisticsProvider().getPdpStatistics(pfDao, name, timestamp);
321 public List<PdpStatistics> getFilteredPdpStatistics(final String name, @NonNull final String pdpGroupName,
322 final String pdpSubGroup, final Date startTimeStamp, final Date endTimeStamp, final String sortOrder,
323 final int getRecordNum) throws PfModelException {
325 return new PdpStatisticsProvider().getFilteredPdpStatistics(pfDao, name, pdpGroupName, pdpSubGroup,
326 startTimeStamp, endTimeStamp, sortOrder, getRecordNum);
330 public List<PdpStatistics> createPdpStatistics(@NonNull final List<PdpStatistics> pdpStatisticsList)
331 throws PfModelException {
333 return new PdpStatisticsProvider().createPdpStatistics(pfDao, pdpStatisticsList);
337 public List<PdpStatistics> updatePdpStatistics(@NonNull final List<PdpStatistics> pdpStatisticsList)
338 throws PfModelException {
340 return new PdpStatisticsProvider().updatePdpStatistics(pfDao, pdpStatisticsList);
344 public List<PdpStatistics> deletePdpStatistics(@NonNull final String name, final Date timestamp)
345 throws PfModelException {
347 return new PdpStatisticsProvider().deletePdpStatistics(pfDao, name, timestamp);
351 public List<PdpPolicyStatus> getGroupPolicyStatus(@NonNull String groupName)
352 throws PfModelException {
354 return new PdpProvider().getGroupPolicyStatus(pfDao, groupName);
358 public void cudPolicyStatus(Collection<PdpPolicyStatus> createObjs,
359 Collection<PdpPolicyStatus> updateObjs, Collection<PdpPolicyStatus> deleteObjs) {
361 new PdpProvider().cudPolicyStatus(pfDao, createObjs, updateObjs, deleteObjs);
365 * Check if the model provider is initialized.
367 private void assertInitialized() {
369 String errorMessage = "policy models provider is not initilaized";
370 LOGGER.warn(errorMessage);
371 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage);
376 * Assert that the policy type is not supported in any PDP group.
378 * @param policyTypeIdentifier the policy type identifier
379 * @throws PfModelException if the policy type is supported in a PDP group
381 private void assertPolicyTypeNotSupportedInPdpGroup(ToscaConceptIdentifier policyTypeIdentifier)
382 throws PfModelException {
383 for (PdpGroup pdpGroup : getPdpGroups(null)) {
384 for (PdpSubGroup pdpSubGroup : pdpGroup.getPdpSubgroups()) {
385 if (pdpSubGroup.getSupportedPolicyTypes().contains(policyTypeIdentifier)) {
386 throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE,
387 "policy type is in use, it is referenced in PDP group " + pdpGroup.getName() + " subgroup "
388 + pdpSubGroup.getPdpType());
395 * Assert that the policy is not deployed in a PDP group.
397 * @param policyIdentifier the identifier of the policy
398 * @throws PfModelException thrown if the policy is deployed in a PDP group
400 private void assertPolicyNotDeployedInPdpGroup(final ToscaConceptIdentifier policyIdentifier)
401 throws PfModelException {
402 for (PdpGroup pdpGroup : getPdpGroups(null)) {
403 for (PdpSubGroup pdpSubGroup : pdpGroup.getPdpSubgroups()) {
404 if (pdpSubGroup.getPolicies().contains(policyIdentifier)) {
405 throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE,
406 "policy is in use, it is deployed in PDP group " + pdpGroup.getName() + " subgroup "
407 + pdpSubGroup.getPdpType());