2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019-2020 Nordix Foundation.
4 * Modifications Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.models.provider.impl;
24 import java.util.Base64;
25 import java.util.Date;
26 import java.util.List;
28 import java.util.Properties;
30 import javax.ws.rs.core.Response;
32 import lombok.NonNull;
34 import org.eclipse.persistence.config.PersistenceUnitProperties;
35 import org.onap.policy.models.base.PfModelException;
36 import org.onap.policy.models.base.PfModelRuntimeException;
37 import org.onap.policy.models.dao.DaoParameters;
38 import org.onap.policy.models.dao.PfDao;
39 import org.onap.policy.models.dao.PfDaoFactory;
40 import org.onap.policy.models.dao.impl.DefaultPfDao;
41 import org.onap.policy.models.pdp.concepts.Pdp;
42 import org.onap.policy.models.pdp.concepts.PdpGroup;
43 import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
44 import org.onap.policy.models.pdp.concepts.PdpStatistics;
45 import org.onap.policy.models.pdp.concepts.PdpSubGroup;
46 import org.onap.policy.models.pdp.persistence.provider.PdpProvider;
47 import org.onap.policy.models.pdp.persistence.provider.PdpStatisticsProvider;
48 import org.onap.policy.models.provider.PolicyModelsProvider;
49 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
50 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
51 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyFilter;
52 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
53 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;
54 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
55 import org.onap.policy.models.tosca.authorative.provider.AuthorativeToscaProvider;
56 import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyInput;
57 import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyOutput;
58 import org.onap.policy.models.tosca.legacy.concepts.LegacyOperationalPolicy;
59 import org.onap.policy.models.tosca.legacy.provider.LegacyProvider;
60 import org.slf4j.Logger;
61 import org.slf4j.LoggerFactory;
64 * This class provides an implementation of the Policy Models Provider for the ONAP Policy Framework that works towards
65 * a relational database.
67 * @author Liam Fallon (liam.fallon@est.tech)
69 public class DatabasePolicyModelsProviderImpl implements PolicyModelsProvider {
71 private static final Logger LOGGER = LoggerFactory.getLogger(DatabasePolicyModelsProviderImpl.class);
73 private final PolicyModelsProviderParameters parameters;
75 // Database connection and the DAO for reading and writing Policy Framework concepts
79 * Constructor that takes the parameters.
81 * @param parameters the parameters for the provider
83 public DatabasePolicyModelsProviderImpl(@NonNull final PolicyModelsProviderParameters parameters) {
84 this.parameters = parameters;
88 public void init() throws PfModelException {
89 LOGGER.debug("opening the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
90 parameters.getPersistenceUnit());
93 String errorMessage = "provider is already initialized";
94 LOGGER.warn(errorMessage);
95 throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errorMessage);
98 // Parameters for the DAO
99 final DaoParameters daoParameters = new DaoParameters();
100 daoParameters.setPluginClass(DefaultPfDao.class.getName());
101 daoParameters.setPersistenceUnit(parameters.getPersistenceUnit());
103 // Decode the password using Base64
104 String decodedPassword = new String(Base64.getDecoder().decode(parameters.getDatabasePassword()));
107 Properties jdbcProperties = new Properties();
108 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_DRIVER, parameters.getDatabaseDriver());
109 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_URL, parameters.getDatabaseUrl());
110 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_USER, parameters.getDatabaseUser());
111 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_PASSWORD, decodedPassword);
114 daoParameters.setJdbcProperties(jdbcProperties);
117 pfDao = new PfDaoFactory().createPfDao(daoParameters);
118 pfDao.init(daoParameters);
119 } catch (Exception exc) {
120 String errorMessage = "could not create Data Access Object (DAO) using url \"" + parameters.getDatabaseUrl()
121 + "\" and persistence unit \"" + parameters.getPersistenceUnit() + "\"";
124 throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errorMessage, exc);
129 public void close() throws PfModelException {
130 LOGGER.debug("closing the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
131 parameters.getPersistenceUnit());
138 LOGGER.debug("closed the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
139 parameters.getPersistenceUnit());
143 public ToscaServiceTemplate getPolicyTypes(final String name, final String version) throws PfModelException {
145 return new AuthorativeToscaProvider().getPolicyTypes(pfDao, name, version);
149 public List<ToscaPolicyType> getPolicyTypeList(final String name, final String version) throws PfModelException {
151 return new AuthorativeToscaProvider().getPolicyTypeList(pfDao, name, version);
155 public ToscaServiceTemplate getFilteredPolicyTypes(@NonNull ToscaPolicyTypeFilter filter) throws PfModelException {
157 return new AuthorativeToscaProvider().getFilteredPolicyTypes(pfDao, filter);
161 public List<ToscaPolicyType> getFilteredPolicyTypeList(@NonNull ToscaPolicyTypeFilter filter)
162 throws PfModelException {
164 return new AuthorativeToscaProvider().getFilteredPolicyTypeList(pfDao, filter);
168 public ToscaServiceTemplate createPolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
169 throws PfModelException {
171 return new AuthorativeToscaProvider().createPolicyTypes(pfDao, serviceTemplate);
175 public ToscaServiceTemplate updatePolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
176 throws PfModelException {
178 return new AuthorativeToscaProvider().updatePolicyTypes(pfDao, serviceTemplate);
182 public ToscaServiceTemplate deletePolicyType(@NonNull final String name, @NonNull final String version)
183 throws PfModelException {
185 return new AuthorativeToscaProvider().deletePolicyType(pfDao, name, version);
189 public ToscaServiceTemplate getPolicies(final String name, final String version) throws PfModelException {
191 return new AuthorativeToscaProvider().getPolicies(pfDao, name, version);
195 public List<ToscaPolicy> getPolicyList(final String name, final String version) throws PfModelException {
197 return new AuthorativeToscaProvider().getPolicyList(pfDao, name, version);
201 public ToscaServiceTemplate getFilteredPolicies(@NonNull ToscaPolicyFilter filter) throws PfModelException {
203 return new AuthorativeToscaProvider().getFilteredPolicies(pfDao, filter);
207 public List<ToscaPolicy> getFilteredPolicyList(@NonNull ToscaPolicyFilter filter) throws PfModelException {
209 return new AuthorativeToscaProvider().getFilteredPolicyList(pfDao, filter);
213 public ToscaServiceTemplate createPolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
214 throws PfModelException {
216 return new AuthorativeToscaProvider().createPolicies(pfDao, serviceTemplate);
220 public ToscaServiceTemplate updatePolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
221 throws PfModelException {
223 return new AuthorativeToscaProvider().updatePolicies(pfDao, serviceTemplate);
227 public ToscaServiceTemplate deletePolicy(@NonNull final String name, @NonNull final String version)
228 throws PfModelException {
230 return new AuthorativeToscaProvider().deletePolicy(pfDao, name, version);
234 public LegacyOperationalPolicy getOperationalPolicy(@NonNull final String policyId, final String policyVersion)
235 throws PfModelException {
237 return new LegacyProvider().getOperationalPolicy(pfDao, policyId, policyVersion);
241 public LegacyOperationalPolicy createOperationalPolicy(
242 @NonNull final LegacyOperationalPolicy legacyOperationalPolicy) throws PfModelException {
244 return new LegacyProvider().createOperationalPolicy(pfDao, legacyOperationalPolicy);
248 public LegacyOperationalPolicy updateOperationalPolicy(
249 @NonNull final LegacyOperationalPolicy legacyOperationalPolicy) throws PfModelException {
251 return new LegacyProvider().updateOperationalPolicy(pfDao, legacyOperationalPolicy);
255 public LegacyOperationalPolicy deleteOperationalPolicy(@NonNull final String policyId,
256 @NonNull final String policyVersion) throws PfModelException {
258 return new LegacyProvider().deleteOperationalPolicy(pfDao, policyId, policyVersion);
262 public Map<String, LegacyGuardPolicyOutput> getGuardPolicy(@NonNull final String policyId,
263 final String policyVersion) throws PfModelException {
265 return new LegacyProvider().getGuardPolicy(pfDao, policyId, policyVersion);
269 public Map<String, LegacyGuardPolicyOutput>
270 createGuardPolicy(@NonNull final LegacyGuardPolicyInput legacyGuardPolicy) throws PfModelException {
272 return new LegacyProvider().createGuardPolicy(pfDao, legacyGuardPolicy);
276 public Map<String, LegacyGuardPolicyOutput>
277 updateGuardPolicy(@NonNull final LegacyGuardPolicyInput legacyGuardPolicy) throws PfModelException {
279 return new LegacyProvider().updateGuardPolicy(pfDao, legacyGuardPolicy);
283 public Map<String, LegacyGuardPolicyOutput> deleteGuardPolicy(@NonNull final String policyId,
284 @NonNull final String policyVersion) throws PfModelException {
286 return new LegacyProvider().deleteGuardPolicy(pfDao, policyId, policyVersion);
290 public List<PdpGroup> getPdpGroups(final String name) throws PfModelException {
292 return new PdpProvider().getPdpGroups(pfDao, name);
296 public List<PdpGroup> getFilteredPdpGroups(@NonNull PdpGroupFilter filter) throws PfModelException {
298 return new PdpProvider().getFilteredPdpGroups(pfDao, filter);
302 public List<PdpGroup> createPdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
304 return new PdpProvider().createPdpGroups(pfDao, pdpGroups);
308 public List<PdpGroup> updatePdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
310 return new PdpProvider().updatePdpGroups(pfDao, pdpGroups);
314 public void updatePdpSubGroup(@NonNull final String pdpGroupName, @NonNull final PdpSubGroup pdpSubGroup)
315 throws PfModelException {
317 new PdpProvider().updatePdpSubGroup(pfDao, pdpGroupName, pdpSubGroup);
321 public void updatePdp(@NonNull String pdpGroupName, @NonNull String pdpSubGroup, @NonNull Pdp pdp)
322 throws PfModelException {
323 new PdpProvider().updatePdp(pfDao, pdpGroupName, pdpSubGroup, pdp);
327 public PdpGroup deletePdpGroup(@NonNull final String name) throws PfModelException {
329 return new PdpProvider().deletePdpGroup(pfDao, name);
333 public List<PdpStatistics> getPdpStatistics(final String name, final Date timestamp) throws PfModelException {
335 return new PdpStatisticsProvider().getPdpStatistics(pfDao, name, timestamp);
339 public List<PdpStatistics> getFilteredPdpStatistics(final String name, @NonNull final String pdpGroupName,
340 final String pdpSubGroup, final Date startTimeStamp, final Date endTimeStamp, final String sortOrder,
341 final int getRecordNum) throws PfModelException {
343 return new PdpStatisticsProvider().getFilteredPdpStatistics(pfDao, name, pdpGroupName, pdpSubGroup,
344 startTimeStamp, endTimeStamp, sortOrder, getRecordNum);
348 public List<PdpStatistics> createPdpStatistics(@NonNull final List<PdpStatistics> pdpStatisticsList)
349 throws PfModelException {
351 return new PdpStatisticsProvider().createPdpStatistics(pfDao, pdpStatisticsList);
355 public List<PdpStatistics> updatePdpStatistics(@NonNull final List<PdpStatistics> pdpStatisticsList)
356 throws PfModelException {
358 return new PdpStatisticsProvider().updatePdpStatistics(pfDao, pdpStatisticsList);
362 public List<PdpStatistics> deletePdpStatistics(@NonNull final String name, final Date timestamp)
363 throws PfModelException {
365 return new PdpStatisticsProvider().deletePdpStatistics(pfDao, name, timestamp);
369 * Check if the model provider is initialized.
371 private void assertInitialized() {
373 String errorMessage = "policy models provider is not initilaized";
374 LOGGER.warn(errorMessage);
375 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage);