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.ToscaPolicyIdentifier;
53 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
54 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;
55 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
56 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
57 import org.onap.policy.models.tosca.authorative.provider.AuthorativeToscaProvider;
58 import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyInput;
59 import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyOutput;
60 import org.onap.policy.models.tosca.legacy.concepts.LegacyOperationalPolicy;
61 import org.onap.policy.models.tosca.legacy.provider.LegacyProvider;
62 import org.slf4j.Logger;
63 import org.slf4j.LoggerFactory;
66 * This class provides an implementation of the Policy Models Provider for the ONAP Policy Framework that works towards
67 * a relational database.
69 * @author Liam Fallon (liam.fallon@est.tech)
71 public class DatabasePolicyModelsProviderImpl implements PolicyModelsProvider {
73 private static final Logger LOGGER = LoggerFactory.getLogger(DatabasePolicyModelsProviderImpl.class);
75 private final PolicyModelsProviderParameters parameters;
77 // Database connection and the DAO for reading and writing Policy Framework concepts
81 * Constructor that takes the parameters.
83 * @param parameters the parameters for the provider
85 public DatabasePolicyModelsProviderImpl(@NonNull final PolicyModelsProviderParameters parameters) {
86 this.parameters = parameters;
90 public void init() throws PfModelException {
91 LOGGER.debug("opening the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
92 parameters.getPersistenceUnit());
95 String errorMessage = "provider is already initialized";
96 LOGGER.warn(errorMessage);
97 throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errorMessage);
100 // Parameters for the DAO
101 final DaoParameters daoParameters = new DaoParameters();
102 daoParameters.setPluginClass(DefaultPfDao.class.getName());
103 daoParameters.setPersistenceUnit(parameters.getPersistenceUnit());
105 // Decode the password using Base64
106 String decodedPassword = new String(Base64.getDecoder().decode(getValue(parameters.getDatabasePassword())));
109 Properties jdbcProperties = new Properties();
110 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_DRIVER, parameters.getDatabaseDriver());
111 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_URL, parameters.getDatabaseUrl());
112 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_USER, parameters.getDatabaseUser());
113 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_PASSWORD, decodedPassword);
116 daoParameters.setJdbcProperties(jdbcProperties);
119 pfDao = new PfDaoFactory().createPfDao(daoParameters);
120 pfDao.init(daoParameters);
121 } catch (Exception exc) {
122 String errorMessage = "could not create Data Access Object (DAO) using url \"" + parameters.getDatabaseUrl()
123 + "\" and persistence unit \"" + parameters.getPersistenceUnit() + "\"";
126 throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errorMessage, exc);
130 private String getValue(final String value) {
131 if (value != null && value.matches("[$][{].*[}]$")) {
132 return System.getenv(value.substring(2, value.length() - 1));
138 public void close() throws PfModelException {
139 LOGGER.debug("closing the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
140 parameters.getPersistenceUnit());
147 LOGGER.debug("closed the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
148 parameters.getPersistenceUnit());
152 public ToscaServiceTemplate getPolicyTypes(final String name, final String version) throws PfModelException {
154 return new AuthorativeToscaProvider().getPolicyTypes(pfDao, name, version);
158 public List<ToscaPolicyType> getPolicyTypeList(final String name, final String version) throws PfModelException {
160 return new AuthorativeToscaProvider().getPolicyTypeList(pfDao, name, version);
164 public ToscaServiceTemplate getFilteredPolicyTypes(@NonNull ToscaPolicyTypeFilter filter) throws PfModelException {
166 return new AuthorativeToscaProvider().getFilteredPolicyTypes(pfDao, filter);
170 public List<ToscaPolicyType> getFilteredPolicyTypeList(@NonNull ToscaPolicyTypeFilter filter)
171 throws PfModelException {
173 return new AuthorativeToscaProvider().getFilteredPolicyTypeList(pfDao, filter);
177 public ToscaServiceTemplate createPolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
178 throws PfModelException {
180 return new AuthorativeToscaProvider().createPolicyTypes(pfDao, serviceTemplate);
184 public ToscaServiceTemplate updatePolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
185 throws PfModelException {
187 return new AuthorativeToscaProvider().updatePolicyTypes(pfDao, serviceTemplate);
191 public ToscaServiceTemplate deletePolicyType(@NonNull final String name, @NonNull final String version)
192 throws PfModelException {
195 ToscaPolicyTypeIdentifier policyTypeIdentifier = new ToscaPolicyTypeIdentifier(name, version);
196 assertPolicyTypeNotSupportedInPdpGroup(policyTypeIdentifier);
198 return new AuthorativeToscaProvider().deletePolicyType(pfDao, name, version);
202 public ToscaServiceTemplate getPolicies(final String name, final String version) throws PfModelException {
204 return new AuthorativeToscaProvider().getPolicies(pfDao, name, version);
208 public List<ToscaPolicy> getPolicyList(final String name, final String version) throws PfModelException {
210 return new AuthorativeToscaProvider().getPolicyList(pfDao, name, version);
214 public ToscaServiceTemplate getFilteredPolicies(@NonNull ToscaPolicyFilter filter) throws PfModelException {
216 return new AuthorativeToscaProvider().getFilteredPolicies(pfDao, filter);
220 public List<ToscaPolicy> getFilteredPolicyList(@NonNull ToscaPolicyFilter filter) throws PfModelException {
222 return new AuthorativeToscaProvider().getFilteredPolicyList(pfDao, filter);
226 public ToscaServiceTemplate createPolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
227 throws PfModelException {
229 return new AuthorativeToscaProvider().createPolicies(pfDao, serviceTemplate);
233 public ToscaServiceTemplate updatePolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
234 throws PfModelException {
236 return new AuthorativeToscaProvider().updatePolicies(pfDao, serviceTemplate);
240 public ToscaServiceTemplate deletePolicy(@NonNull final String name, @NonNull final String version)
241 throws PfModelException {
244 ToscaPolicyIdentifier policyIdentifier = new ToscaPolicyIdentifier(name, version);
245 assertPolicyNotDeployedInPdpGroup(policyIdentifier);
247 return new AuthorativeToscaProvider().deletePolicy(pfDao, name, version);
251 public LegacyOperationalPolicy getOperationalPolicy(@NonNull final String policyId, final String policyVersion)
252 throws PfModelException {
254 return new LegacyProvider().getOperationalPolicy(pfDao, policyId, policyVersion);
258 public LegacyOperationalPolicy createOperationalPolicy(
259 @NonNull final LegacyOperationalPolicy legacyOperationalPolicy) throws PfModelException {
261 return new LegacyProvider().createOperationalPolicy(pfDao, legacyOperationalPolicy);
265 public LegacyOperationalPolicy updateOperationalPolicy(
266 @NonNull final LegacyOperationalPolicy legacyOperationalPolicy) throws PfModelException {
268 return new LegacyProvider().updateOperationalPolicy(pfDao, legacyOperationalPolicy);
272 public LegacyOperationalPolicy deleteOperationalPolicy(@NonNull final String policyId,
273 @NonNull final String policyVersion) throws PfModelException {
276 assertPolicyNotDeployedInPdpGroup(
277 new ToscaPolicyIdentifier(policyId, policyVersion + LegacyProvider.LEGACY_MINOR_PATCH_SUFFIX));
279 return new LegacyProvider().deleteOperationalPolicy(pfDao, policyId, policyVersion);
283 public Map<String, LegacyGuardPolicyOutput> getGuardPolicy(@NonNull final String policyId,
284 final String policyVersion) throws PfModelException {
286 return new LegacyProvider().getGuardPolicy(pfDao, policyId, policyVersion);
290 public Map<String, LegacyGuardPolicyOutput>
291 createGuardPolicy(@NonNull final LegacyGuardPolicyInput legacyGuardPolicy) throws PfModelException {
293 return new LegacyProvider().createGuardPolicy(pfDao, legacyGuardPolicy);
297 public Map<String, LegacyGuardPolicyOutput>
298 updateGuardPolicy(@NonNull final LegacyGuardPolicyInput legacyGuardPolicy) throws PfModelException {
300 return new LegacyProvider().updateGuardPolicy(pfDao, legacyGuardPolicy);
304 public Map<String, LegacyGuardPolicyOutput> deleteGuardPolicy(@NonNull final String policyId,
305 @NonNull final String policyVersion) throws PfModelException {
308 assertPolicyNotDeployedInPdpGroup(
309 new ToscaPolicyIdentifier(policyId, policyVersion + LegacyProvider.LEGACY_MINOR_PATCH_SUFFIX));
311 return new LegacyProvider().deleteGuardPolicy(pfDao, policyId, policyVersion);
315 public List<PdpGroup> getPdpGroups(final String name) throws PfModelException {
317 return new PdpProvider().getPdpGroups(pfDao, name);
321 public List<PdpGroup> getFilteredPdpGroups(@NonNull PdpGroupFilter filter) throws PfModelException {
323 return new PdpProvider().getFilteredPdpGroups(pfDao, filter);
327 public List<PdpGroup> createPdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
329 return new PdpProvider().createPdpGroups(pfDao, pdpGroups);
333 public List<PdpGroup> updatePdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
335 return new PdpProvider().updatePdpGroups(pfDao, pdpGroups);
339 public void updatePdpSubGroup(@NonNull final String pdpGroupName, @NonNull final PdpSubGroup pdpSubGroup)
340 throws PfModelException {
342 new PdpProvider().updatePdpSubGroup(pfDao, pdpGroupName, pdpSubGroup);
346 public void updatePdp(@NonNull String pdpGroupName, @NonNull String pdpSubGroup, @NonNull Pdp pdp)
347 throws PfModelException {
348 new PdpProvider().updatePdp(pfDao, pdpGroupName, pdpSubGroup, pdp);
352 public PdpGroup deletePdpGroup(@NonNull final String name) throws PfModelException {
354 return new PdpProvider().deletePdpGroup(pfDao, name);
358 public List<PdpStatistics> getPdpStatistics(final String name, final Date timestamp) throws PfModelException {
360 return new PdpStatisticsProvider().getPdpStatistics(pfDao, name, timestamp);
364 public List<PdpStatistics> getFilteredPdpStatistics(final String name, @NonNull final String pdpGroupName,
365 final String pdpSubGroup, final Date startTimeStamp, final Date endTimeStamp, final String sortOrder,
366 final int getRecordNum) throws PfModelException {
368 return new PdpStatisticsProvider().getFilteredPdpStatistics(pfDao, name, pdpGroupName, pdpSubGroup,
369 startTimeStamp, endTimeStamp, sortOrder, getRecordNum);
373 public List<PdpStatistics> createPdpStatistics(@NonNull final List<PdpStatistics> pdpStatisticsList)
374 throws PfModelException {
376 return new PdpStatisticsProvider().createPdpStatistics(pfDao, pdpStatisticsList);
380 public List<PdpStatistics> updatePdpStatistics(@NonNull final List<PdpStatistics> pdpStatisticsList)
381 throws PfModelException {
383 return new PdpStatisticsProvider().updatePdpStatistics(pfDao, pdpStatisticsList);
387 public List<PdpStatistics> deletePdpStatistics(@NonNull final String name, final Date timestamp)
388 throws PfModelException {
390 return new PdpStatisticsProvider().deletePdpStatistics(pfDao, name, timestamp);
394 * Check if the model provider is initialized.
396 private void assertInitialized() {
398 String errorMessage = "policy models provider is not initilaized";
399 LOGGER.warn(errorMessage);
400 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage);
405 * Assert that the policy type is not supported in any PDP group.
407 * @param policyTypeIdentifier the policy type identifier
408 * @throws PfModelException if the policy type is supported in a PDP group
410 private void assertPolicyTypeNotSupportedInPdpGroup(ToscaPolicyTypeIdentifier policyTypeIdentifier)
411 throws PfModelException {
412 for (PdpGroup pdpGroup : getPdpGroups(null)) {
413 for (PdpSubGroup pdpSubGroup : pdpGroup.getPdpSubgroups()) {
414 if (pdpSubGroup.getSupportedPolicyTypes().contains(policyTypeIdentifier)) {
415 throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE,
416 "policy type is in use, it is referenced in PDP group " + pdpGroup.getName() + " subgroup "
417 + pdpSubGroup.getPdpType());
424 * Assert that the policy is not deployed in a PDP group.
426 * @param policyIdentifier the identifier of the policy
427 * @throws PfModelException thrown if the policy is deployed in a PDP group
429 private void assertPolicyNotDeployedInPdpGroup(final ToscaPolicyIdentifier policyIdentifier)
430 throws PfModelException {
431 for (PdpGroup pdpGroup : getPdpGroups(null)) {
432 for (PdpSubGroup pdpSubGroup : pdpGroup.getPdpSubgroups()) {
433 if (pdpSubGroup.getPolicies().contains(policyIdentifier)) {
434 throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE,
435 "policy is in use, it is deployed in PDP group " + pdpGroup.getName() + " subgroup "
436 + pdpSubGroup.getPdpType());