2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019-2021,2023 Nordix Foundation.
4 * Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
5 * Modifications Copyright (C) 2022 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.dao.impl;
25 import java.util.Collection;
26 import java.util.Collections;
27 import java.util.List;
28 import javax.persistence.EntityManager;
29 import javax.persistence.EntityManagerFactory;
30 import javax.persistence.Persistence;
31 import javax.persistence.TypedQuery;
32 import javax.ws.rs.core.Response;
33 import org.apache.commons.lang3.StringUtils;
34 import org.onap.policy.models.base.PfConcept;
35 import org.onap.policy.models.base.PfConceptKey;
36 import org.onap.policy.models.base.PfModelException;
37 import org.onap.policy.models.base.PfModelRuntimeException;
38 import org.onap.policy.models.base.PfReferenceKey;
39 import org.onap.policy.models.base.PfReferenceTimestampKey;
40 import org.onap.policy.models.base.PfTimestampKey;
41 import org.onap.policy.models.base.PfUtils;
42 import org.onap.policy.models.dao.DaoParameters;
43 import org.onap.policy.models.dao.PfDao;
44 import org.onap.policy.models.dao.PfFilter;
45 import org.onap.policy.models.dao.PfFilterFactory;
46 import org.onap.policy.models.dao.PfFilterParametersIntfc;
47 import org.slf4j.Logger;
48 import org.slf4j.LoggerFactory;
51 * The Class DefaultPfDao is an JPA implementation of the {@link PfDao} class for Policy Framework concepts
52 * ({@link PfConcept}). It uses the default JPA implementation in the javax {@link Persistence} class.
54 public class DefaultPfDao implements PfDao {
55 private static final Logger LOGGER = LoggerFactory.getLogger(DefaultPfDao.class);
58 private static final String NAME = "name";
59 private static final String VERSION = "version";
60 private static final String TIMESTAMP = "timeStamp";
61 private static final String PARENT_NAME = "parentname";
62 private static final String PARENT_VERSION = "parentversion";
63 private static final String LOCAL_NAME = "localname";
65 private static final String TABLE_TOKEN = "__TABLE__";
67 private static final String DELETE_FROM_TABLE = "DELETE FROM __TABLE__ c";
69 private static final String SELECT_FROM_TABLE = "SELECT c FROM __TABLE__ c";
71 private static final String WHERE = " WHERE ";
72 private static final String AND = " AND ";
73 private static final String ORDER_BY = " ORDER BY c.";
75 private static final String NAME_FILTER = "c.key.name = :name";
76 private static final String VERSION_FILTER = "c.key.version = :version";
77 private static final String TIMESTAMP_FILTER = "c.key.timeStamp = :timeStamp";
78 private static final String PARENT_NAME_FILTER = "c.key.parentKeyName = :parentname";
79 private static final String PARENT_VERSION_FILTER = "c.key.parentKeyVersion = :parentversion";
80 private static final String LOCAL_NAME_FILTER = "c.key.localName = :localname";
82 private static final String CLONE_ERR_MSG = "Could not clone object of class \"{}\"";
84 private static final String DELETE_BY_CONCEPT_KEY =
85 DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER;
87 private static final String DELETE_BY_TIMESTAMP_KEY =
88 DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER + AND + TIMESTAMP_FILTER;
90 private static final String DELETE_BY_REFERENCE_KEY =
91 DELETE_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER + AND + LOCAL_NAME_FILTER;
93 private static final String SELECT_ALL_FOR_PARENT =
94 SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER;
96 private static final String SELECT_ALL_VERSIONS_FOR_PARENT =
97 SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER;
99 private static final String SELECT_ALL_VERSIONS = SELECT_FROM_TABLE + WHERE + NAME_FILTER;
101 private static final String SELECT_BY_CONCEPT_KEY =
102 SELECT_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER;
104 private static final String SELECT_BY_REFERENCE_KEY =
105 SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER + AND + LOCAL_NAME_FILTER;
108 // Entity manager for JPA
109 private EntityManagerFactory emf = null;
112 public void init(final DaoParameters daoParameters) throws PfModelException {
113 if (daoParameters == null || daoParameters.getPersistenceUnit() == null) {
114 LOGGER.error("Policy Framework persistence unit parameter not set");
115 throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR,
116 "Policy Framework persistence unit parameter not set");
119 LOGGER.debug("Creating Policy Framework persistence unit \"{}\" . . .", daoParameters.getPersistenceUnit());
121 emf = Persistence.createEntityManagerFactory(daoParameters.getPersistenceUnit(),
122 daoParameters.getJdbcProperties());
123 } catch (final Exception ex) {
124 String errorMessage = "Creation of Policy Framework persistence unit \""
125 + daoParameters.getPersistenceUnit() + "\" failed";
126 LOGGER.warn(errorMessage);
127 throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ex);
129 LOGGER.debug("Created Policy Framework persistence unit \"{}\"", daoParameters.getPersistenceUnit());
133 * Gets the entity manager for this DAO.
135 * @return the entity manager
137 protected final synchronized EntityManager getEntityManager() {
139 LOGGER.warn("Policy Framework DAO has not been initialized");
140 throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR,
141 "Policy Framework DAO has not been initialized");
144 return emf.createEntityManager();
148 public final void close() {
155 public <T extends PfConcept> void create(final T obj) {
159 final var mg = getEntityManager();
161 mg.getTransaction().begin();
163 mg.getTransaction().commit();
170 public <T extends PfConcept> void delete(final T obj) {
174 final var mg = getEntityManager();
176 mg.getTransaction().begin();
177 mg.remove(mg.contains(obj) ? obj : mg.merge(obj));
178 mg.getTransaction().commit();
185 public <T extends PfConcept> void delete(final Class<T> someClass, final PfConceptKey key) {
189 final var mg = getEntityManager();
192 mg.getTransaction().begin();
193 mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass))
194 .setParameter(NAME, key.getName())
195 .setParameter(VERSION, key.getVersion())
197 mg.getTransaction().commit();
205 public <T extends PfConcept> void delete(final Class<T> someClass, final PfReferenceKey key) {
209 final var mg = getEntityManager();
212 mg.getTransaction().begin();
213 mg.createQuery(setQueryTable(DELETE_BY_REFERENCE_KEY, someClass))
214 .setParameter(PARENT_NAME, key.getParentKeyName())
215 .setParameter(PARENT_VERSION, key.getParentKeyVersion())
216 .setParameter(LOCAL_NAME, key.getLocalName())
218 mg.getTransaction().commit();
226 public <T extends PfConcept> void delete(final Class<T> someClass, final PfTimestampKey key) {
230 final var mg = getEntityManager();
233 mg.getTransaction().begin();
234 mg.createQuery(setQueryTable(DELETE_BY_TIMESTAMP_KEY, someClass))
235 .setParameter(NAME, key.getName())
236 .setParameter(VERSION, key.getVersion())
237 .setParameter(TIMESTAMP, key.getTimeStamp())
239 mg.getTransaction().commit();
247 public <T extends PfConcept> void createCollection(final Collection<T> objs) {
248 if (objs == null || objs.isEmpty()) {
251 final var mg = getEntityManager();
253 mg.getTransaction().begin();
254 for (final T t : objs) {
257 mg.getTransaction().commit();
264 public <T extends PfConcept> void deleteCollection(final Collection<T> objs) {
265 if (objs == null || objs.isEmpty()) {
268 final var mg = getEntityManager();
270 mg.getTransaction().begin();
271 for (final T t : objs) {
272 mg.remove(mg.contains(t) ? t : mg.merge(t));
274 mg.getTransaction().commit();
281 public <T extends PfConcept> int deleteByConceptKey(final Class<T> someClass, final Collection<PfConceptKey> keys) {
282 if (keys == null || keys.isEmpty()) {
285 var deletedCount = 0;
286 final var mg = getEntityManager();
289 mg.getTransaction().begin();
290 for (final PfConceptKey key : keys) {
291 deletedCount += mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass))
292 .setParameter(NAME, key.getName())
293 .setParameter(VERSION, key.getVersion())
296 mg.getTransaction().commit();
305 public <T extends PfConcept> int deleteByReferenceKey(final Class<T> someClass,
306 final Collection<PfReferenceKey> keys) {
307 if (keys == null || keys.isEmpty()) {
310 var deletedCount = 0;
311 final var mg = getEntityManager();
314 mg.getTransaction().begin();
315 for (final PfReferenceKey key : keys) {
316 deletedCount += mg.createQuery(setQueryTable(DELETE_BY_REFERENCE_KEY, someClass))
317 .setParameter(PARENT_NAME, key.getParentKeyName())
318 .setParameter(PARENT_VERSION, key.getParentKeyVersion())
319 .setParameter(LOCAL_NAME, key.getLocalName())
322 mg.getTransaction().commit();
331 public <T extends PfConcept> void deleteAll(final Class<T> someClass) {
332 final var mg = getEntityManager();
334 mg.getTransaction().begin();
335 mg.createQuery(setQueryTable(DELETE_FROM_TABLE, someClass)).executeUpdate();
336 mg.getTransaction().commit();
343 public <T extends PfConcept> List<T> getFiltered(final Class<T> someClass, final String name,
344 final String version) {
346 return getAll(someClass);
349 if (version == null) {
350 return getAllVersions(someClass, name);
353 var foundConcept = get(someClass, new PfConceptKey(name, version));
355 return (foundConcept == null ? Collections.emptyList() : Collections.singletonList(foundConcept));
359 public <T extends PfConcept> List<T> getFiltered(final Class<T> someClass, PfFilterParametersIntfc filterParams) {
360 final var mg = getEntityManager();
363 PfFilter filter = new PfFilterFactory().createFilter(someClass);
364 var filterQueryString = SELECT_FROM_TABLE
365 + filter.genWhereClause(filterParams)
366 + filter.genOrderClause(filterParams);
368 TypedQuery<T> query = mg.createQuery(setQueryTable(filterQueryString, someClass), someClass);
369 filter.setParams(query, filterParams);
371 LOGGER.debug("filterQueryString is \"{}\"", filterQueryString);
372 return query.getResultList();
379 public <T extends PfConcept> T get(final Class<T> someClass, final PfConceptKey key) {
380 return genericGet(someClass, key);
384 public <T extends PfConcept> T get(final Class<T> someClass, final PfReferenceKey key) {
385 return genericGet(someClass, key);
389 public <T extends PfConcept> T get(final Class<T> someClass, final PfTimestampKey key) {
390 return genericGet(someClass, key);
394 public <T extends PfConcept> T get(final Class<T> someClass, final PfReferenceTimestampKey key) {
395 return genericGet(someClass, key);
398 private <T extends PfConcept> T genericGet(final Class<T> someClass, final Object key) {
399 if (someClass == null) {
402 final var mg = getEntityManager();
404 final var t = mg.find(someClass, key);
408 return checkAndReturn(someClass, t);
415 public <T extends PfConcept> List<T> getAll(final Class<T> someClass) {
416 if (someClass == null) {
417 return Collections.emptyList();
419 final var mg = getEntityManager();
421 return mg.createQuery(setQueryTable(SELECT_FROM_TABLE, someClass), someClass).getResultList();
428 public <T extends PfConcept> List<T> getAll(final Class<T> someClass, final PfConceptKey parentKey) {
429 if (someClass == null) {
430 return Collections.emptyList();
432 final var mg = getEntityManager();
435 return mg.createQuery(setQueryTable(SELECT_ALL_FOR_PARENT, someClass), someClass)
436 .setParameter(PARENT_NAME, parentKey.getName())
437 .setParameter(PARENT_VERSION, parentKey.getVersion())
446 public <T extends PfConcept> List<T> getAll(Class<T> someClass, String orderBy, Integer numRecords) {
448 if (someClass == null) {
449 return Collections.emptyList();
451 final var mg = getEntityManager();
453 String query = setQueryTable(SELECT_FROM_TABLE, someClass);
455 if (StringUtils.isNotBlank(orderBy)) {
456 query = query.concat(ORDER_BY).concat(orderBy);
459 return mg.createQuery(query, someClass).setMaxResults(numRecords)
467 public <T extends PfConcept> List<T> getAllVersionsByParent(final Class<T> someClass, final String parentKeyName) {
468 if (someClass == null || parentKeyName == null) {
469 return Collections.emptyList();
471 final var mg = getEntityManager();
474 return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS_FOR_PARENT, someClass), someClass)
475 .setParameter(PARENT_NAME, parentKeyName)
484 public <T extends PfConcept> List<T> getAllVersions(final Class<T> someClass, final String conceptName) {
485 if (someClass == null || conceptName == null) {
486 return Collections.emptyList();
488 final var mg = getEntityManager();
491 return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS, someClass), someClass)
492 .setParameter(NAME, conceptName)
501 public <T extends PfConcept> T getConcept(final Class<T> someClass, final PfConceptKey key) {
502 if (someClass == null || key == null) {
505 final var mg = getEntityManager();
509 ret = mg.createQuery(setQueryTable(SELECT_BY_CONCEPT_KEY, someClass), someClass)
510 .setParameter(NAME, key.getName())
511 .setParameter(VERSION, key.getVersion())
518 return getSingleResult(someClass, key.getId(), ret);
522 public <T extends PfConcept> T getConcept(final Class<T> someClass, final PfReferenceKey key) {
523 if (someClass == null || key == null) {
526 final var mg = getEntityManager();
530 ret = mg.createQuery(setQueryTable(SELECT_BY_REFERENCE_KEY, someClass), someClass)
531 .setParameter(PARENT_NAME, key.getParentKeyName())
532 .setParameter(PARENT_VERSION, key.getParentKeyVersion())
533 .setParameter(LOCAL_NAME, key.getLocalName())
540 return getSingleResult(someClass, key.getId(), ret);
544 public <T extends PfConcept> T update(final T obj) {
545 final var mg = getEntityManager();
548 mg.getTransaction().begin();
551 mg.getTransaction().commit();
559 public <T extends PfConcept> long size(final Class<T> someClass) {
560 if (someClass == null) {
563 final var mg = getEntityManager();
567 * The invoking code only passes well-known classes into this method, thus
568 * disabling the sonar about SQL injection.
570 size = mg.createQuery("SELECT COUNT(c) FROM " + someClass.getSimpleName() + " c", Long.class) // NOSONAR
579 * Add the table to a query string.
581 * @param queryString the query string
582 * @param tableClass the class name of the table
583 * @return the updated query string
585 private <T extends PfConcept> String setQueryTable(final String queryString, final Class<T> tableClass) {
586 return queryString.replace(TABLE_TOKEN, tableClass.getSimpleName());
590 * Check that a query returned one and only one entry and return that entry.
592 * @param someClass the class being searched for
593 * @param searchFilter the search filter
594 * @param resultList the result list returned by the query
595 * @return the single unique result
597 private <T extends PfConcept> T getSingleResult(final Class<T> someClass, final String searchFilter,
598 List<T> resultList) {
599 if (resultList == null || resultList.isEmpty()) {
602 if (resultList.size() > 1) {
603 throw new IllegalArgumentException("More than one result was returned query on " + someClass
604 + " with filter " + searchFilter + ": " + resultList);
606 return resultList.get(0);
610 * check the result get from database and return the object.
612 * @param <T> the type of the object to get, a subclass of {@link PfConcept}
613 * @param someClass the class of the object to get, a subclass of {@link PfConcept}
614 * @param objToCheck the object that was retrieved from the database
615 * @return the checked object or null
617 private <T extends PfConcept> T checkAndReturn(final Class<T> someClass, final T objToCheck) {
618 if (objToCheck != null) {
620 return PfUtils.makeCopy(objToCheck);
621 } catch (final Exception e) {
622 LOGGER.warn(CLONE_ERR_MSG, someClass.getName(), e);