2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019-2021 Nordix Foundation.
4 * Modifications Copyright (C) 2019-2021 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.dao.impl;
24 import java.sql.Timestamp;
25 import java.time.Instant;
26 import java.util.Collection;
27 import java.util.Collections;
28 import java.util.List;
30 import javax.persistence.EntityManager;
31 import javax.persistence.EntityManagerFactory;
32 import javax.persistence.Persistence;
33 import javax.persistence.TypedQuery;
34 import javax.ws.rs.core.Response;
35 import org.apache.commons.lang3.StringUtils;
36 import org.onap.policy.models.base.PfConcept;
37 import org.onap.policy.models.base.PfConceptKey;
38 import org.onap.policy.models.base.PfGeneratedIdKey;
39 import org.onap.policy.models.base.PfModelException;
40 import org.onap.policy.models.base.PfModelRuntimeException;
41 import org.onap.policy.models.base.PfReferenceKey;
42 import org.onap.policy.models.base.PfReferenceTimestampKey;
43 import org.onap.policy.models.base.PfTimestampKey;
44 import org.onap.policy.models.base.PfUtils;
45 import org.onap.policy.models.dao.DaoParameters;
46 import org.onap.policy.models.dao.PfDao;
47 import org.onap.policy.models.dao.PfFilter;
48 import org.onap.policy.models.dao.PfFilterFactory;
49 import org.slf4j.Logger;
50 import org.slf4j.LoggerFactory;
53 * The Class DefaultPfDao is an JPA implementation of the {@link PfDao} class for Policy Framework concepts
54 * ({@link PfConcept}). It uses the default JPA implementation in the javax {@link Persistence} class.
56 public class DefaultPfDao implements PfDao {
57 private static final Logger LOGGER = LoggerFactory.getLogger(DefaultPfDao.class);
60 private static final String NAME = "name";
61 private static final String VERSION = "version";
62 private static final String TIMESTAMP = "timeStamp";
63 private static final String GENERATEDID = "Id";
64 private static final String PARENT_NAME = "parentname";
65 private static final String PARENT_VERSION = "parentversion";
66 private static final String LOCAL_NAME = "localname";
68 private static final String TABLE_TOKEN = "__TABLE__";
70 private static final String DELETE_FROM_TABLE = "DELETE FROM __TABLE__ c";
72 private static final String SELECT_FROM_TABLE = "SELECT c FROM __TABLE__ c";
74 private static final String WHERE = " WHERE ";
75 private static final String AND = " AND ";
76 private static final String ORDER_BY = " ORDER BY c.";
78 private static final String NAME_FILTER = "c.key.name = :name";
79 private static final String VERSION_FILTER = "c.key.version = :version";
80 private static final String TIMESTAMP_FILTER = "c.key.timeStamp = :timeStamp";
81 private static final String TIMESTAMP_FILTER_NOKEY = "c.timeStamp = :timeStamp";
82 private static final String GENERATED_ID_FILTER = "c.key.generatedId = :Id";
83 private static final String PARENT_NAME_FILTER = "c.key.parentKeyName = :parentname";
84 private static final String PARENT_VERSION_FILTER = "c.key.parentKeyVersion = :parentversion";
85 private static final String LOCAL_NAME_FILTER = "c.key.localName = :localname";
87 private static final String CLONE_ERR_MSG = "Could not clone object of class \"{}\"";
89 private static final String DELETE_BY_CONCEPT_KEY =
90 DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER;
92 private static final String DELETE_BY_TIMESTAMP_KEY =
93 DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER + AND + TIMESTAMP_FILTER;
95 private static final String DELETE_BY_GENERATED_ID_KEY =
96 DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER + AND + GENERATED_ID_FILTER;
98 private static final String DELETE_BY_REFERENCE_KEY =
99 DELETE_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER + AND + LOCAL_NAME_FILTER;
101 private static final String SELECT_ALL_FOR_PARENT =
102 SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER;
104 private static final String SELECT_ALL_VERSIONS_FOR_PARENT =
105 SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER;
107 private static final String SELECT_ALL_VERSIONS = SELECT_FROM_TABLE + WHERE + NAME_FILTER;
109 private static final String SELECT_BY_CONCEPT_KEY =
110 SELECT_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER;
112 private static final String SELECT_BY_TIMESTAMP_NOKEY =
113 SELECT_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER + AND + TIMESTAMP_FILTER_NOKEY;
115 private static final String SELECT_BY_REFERENCE_KEY =
116 SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER + AND + LOCAL_NAME_FILTER;
119 // Entity manager for JPA
120 private EntityManagerFactory emf = null;
123 public void init(final DaoParameters daoParameters) throws PfModelException {
124 if (daoParameters == null || daoParameters.getPersistenceUnit() == null) {
125 LOGGER.error("Policy Framework persistence unit parameter not set");
126 throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR,
127 "Policy Framework persistence unit parameter not set");
130 LOGGER.debug("Creating Policy Framework persistence unit \"{}\" . . .", daoParameters.getPersistenceUnit());
132 emf = Persistence.createEntityManagerFactory(daoParameters.getPersistenceUnit(),
133 daoParameters.getJdbcProperties());
134 } catch (final Exception ex) {
135 String errorMessage = "Creation of Policy Framework persistence unit \""
136 + daoParameters.getPersistenceUnit() + "\" failed";
137 LOGGER.warn(errorMessage);
138 throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ex);
140 LOGGER.debug("Created Policy Framework persistence unit \"{}\"", daoParameters.getPersistenceUnit());
144 * Gets the entity manager for this DAO.
146 * @return the entity manager
148 protected final synchronized EntityManager getEntityManager() {
150 LOGGER.warn("Policy Framework DAO has not been initialized");
151 throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR,
152 "Policy Framework DAO has not been initialized");
155 return emf.createEntityManager();
159 public final void close() {
166 public <T extends PfConcept> void create(final T obj) {
170 final var mg = getEntityManager();
172 mg.getTransaction().begin();
174 mg.getTransaction().commit();
181 public <T extends PfConcept> void delete(final T obj) {
185 final var mg = getEntityManager();
187 mg.getTransaction().begin();
188 mg.remove(mg.contains(obj) ? obj : mg.merge(obj));
189 mg.getTransaction().commit();
196 public <T extends PfConcept> void delete(final Class<T> someClass, final PfConceptKey key) {
200 final var mg = getEntityManager();
203 mg.getTransaction().begin();
204 mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass), someClass)
205 .setParameter(NAME, key.getName())
206 .setParameter(VERSION, key.getVersion())
208 mg.getTransaction().commit();
216 public <T extends PfConcept> void delete(final Class<T> someClass, final PfReferenceKey key) {
220 final var mg = getEntityManager();
223 mg.getTransaction().begin();
224 mg.createQuery(setQueryTable(DELETE_BY_REFERENCE_KEY, someClass), someClass)
225 .setParameter(PARENT_NAME, key.getParentKeyName())
226 .setParameter(PARENT_VERSION, key.getParentKeyVersion())
227 .setParameter(LOCAL_NAME, key.getLocalName())
229 mg.getTransaction().commit();
237 public <T extends PfConcept> void delete(final Class<T> someClass, final PfTimestampKey key) {
241 final var mg = getEntityManager();
244 mg.getTransaction().begin();
245 mg.createQuery(setQueryTable(DELETE_BY_TIMESTAMP_KEY, someClass), someClass)
246 .setParameter(NAME, key.getName())
247 .setParameter(VERSION, key.getVersion())
248 .setParameter(TIMESTAMP, key.getTimeStamp())
250 mg.getTransaction().commit();
258 public <T extends PfConcept> void delete(final Class<T> someClass, final PfGeneratedIdKey key) {
262 final var mg = getEntityManager();
265 mg.getTransaction().begin();
266 mg.createQuery(setQueryTable(DELETE_BY_GENERATED_ID_KEY, someClass), someClass)
267 .setParameter(NAME, key.getName())
268 .setParameter(VERSION, key.getVersion())
269 .setParameter(GENERATEDID, key.getGeneratedId())
271 mg.getTransaction().commit();
279 public <T extends PfConcept> void createCollection(final Collection<T> objs) {
280 if (objs == null || objs.isEmpty()) {
283 final var mg = getEntityManager();
285 mg.getTransaction().begin();
286 for (final T t : objs) {
289 mg.getTransaction().commit();
296 public <T extends PfConcept> void deleteCollection(final Collection<T> objs) {
297 if (objs == null || objs.isEmpty()) {
300 final var mg = getEntityManager();
302 mg.getTransaction().begin();
303 for (final T t : objs) {
304 mg.remove(mg.contains(t) ? t : mg.merge(t));
306 mg.getTransaction().commit();
313 public <T extends PfConcept> int deleteByConceptKey(final Class<T> someClass, final Collection<PfConceptKey> keys) {
314 if (keys == null || keys.isEmpty()) {
317 var deletedCount = 0;
318 final var mg = getEntityManager();
321 mg.getTransaction().begin();
322 for (final PfConceptKey key : keys) {
323 deletedCount += mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass), someClass)
324 .setParameter(NAME, key.getName())
325 .setParameter(VERSION, key.getVersion())
328 mg.getTransaction().commit();
337 public <T extends PfConcept> int deleteByReferenceKey(final Class<T> someClass,
338 final Collection<PfReferenceKey> keys) {
339 if (keys == null || keys.isEmpty()) {
342 var deletedCount = 0;
343 final var mg = getEntityManager();
346 mg.getTransaction().begin();
347 for (final PfReferenceKey key : keys) {
348 deletedCount += mg.createQuery(setQueryTable(DELETE_BY_REFERENCE_KEY, someClass), someClass)
349 .setParameter(PARENT_NAME, key.getParentKeyName())
350 .setParameter(PARENT_VERSION, key.getParentKeyVersion())
351 .setParameter(LOCAL_NAME, key.getLocalName())
354 mg.getTransaction().commit();
363 public <T extends PfConcept> void deleteAll(final Class<T> someClass) {
364 final var mg = getEntityManager();
366 mg.getTransaction().begin();
367 mg.createQuery(setQueryTable(DELETE_FROM_TABLE, someClass), someClass).executeUpdate();
368 mg.getTransaction().commit();
375 public <T extends PfConcept> List<T> getFiltered(final Class<T> someClass, final String name,
376 final String version) {
378 return getAll(someClass);
381 if (version == null) {
382 return getAllVersions(someClass, name);
385 var foundConcept = get(someClass, new PfConceptKey(name, version));
387 return (foundConcept == null ? Collections.emptyList() : Collections.singletonList(foundConcept));
391 public <T extends PfConcept> List<T> getFiltered(final Class<T> someClass, final String name, final String version,
392 final Instant startTime, final Instant endTime, final Map<String, Object> filterMap, final String sortOrder,
393 final int getRecordNum) {
394 final var mg = getEntityManager();
396 var filterQueryString = SELECT_FROM_TABLE + WHERE;
399 PfFilter timeStampFilter = new PfFilterFactory().createFilter(someClass);
400 filterQueryString = timeStampFilter.addFilter(filterQueryString, name, startTime, endTime, filterMap,
401 sortOrder, getRecordNum);
403 TypedQuery<T> query = mg.createQuery(setQueryTable(filterQueryString, someClass), someClass);
405 if (filterMap != null) {
406 for (Map.Entry<String, Object> entry : filterMap.entrySet()) {
407 query.setParameter(entry.getKey(), entry.getValue());
411 query.setParameter(timeStampFilter.getNameParameter(), name);
413 if (startTime != null) {
414 if (endTime != null) {
415 query.setParameter("startTime", Timestamp.from(startTime));
416 query.setParameter("endTime", Timestamp.from(endTime));
418 query.setParameter("startTime", Timestamp.from(startTime));
421 if (endTime != null) {
422 query.setParameter("endTime", Timestamp.from(endTime));
425 if (getRecordNum > 0) {
426 query.setMaxResults(getRecordNum);
429 LOGGER.debug("filterQueryString is \"{}\"", filterQueryString);
430 return query.getResultList();
437 public <T extends PfConcept> T get(final Class<T> someClass, final PfConceptKey key) {
438 return genericGet(someClass, key);
442 public <T extends PfConcept> T get(final Class<T> someClass, final PfReferenceKey key) {
443 return genericGet(someClass, key);
447 public <T extends PfConcept> T get(final Class<T> someClass, final PfGeneratedIdKey key) {
448 return genericGet(someClass, key);
452 public <T extends PfConcept> T get(final Class<T> someClass, final PfTimestampKey key) {
453 return genericGet(someClass, key);
457 public <T extends PfConcept> T get(final Class<T> someClass, final PfReferenceTimestampKey key) {
458 return genericGet(someClass, key);
461 private <T extends PfConcept> T genericGet(final Class<T> someClass, final Object key) {
462 if (someClass == null) {
465 final var mg = getEntityManager();
467 final var t = mg.find(someClass, key);
471 return checkAndReturn(someClass, t);
478 public <T extends PfConcept> List<T> getAll(final Class<T> someClass) {
479 if (someClass == null) {
480 return Collections.emptyList();
482 final var mg = getEntityManager();
484 return mg.createQuery(setQueryTable(SELECT_FROM_TABLE, someClass), someClass).getResultList();
491 public <T extends PfConcept> List<T> getAll(final Class<T> someClass, final PfConceptKey parentKey) {
492 if (someClass == null) {
493 return Collections.emptyList();
495 final var mg = getEntityManager();
498 return mg.createQuery(setQueryTable(SELECT_ALL_FOR_PARENT, someClass), someClass)
499 .setParameter(PARENT_NAME, parentKey.getName())
500 .setParameter(PARENT_VERSION, parentKey.getVersion())
509 public <T extends PfConcept> List<T> getAll(Class<T> someClass, String orderBy, Integer numRecords) {
511 if (someClass == null) {
512 return Collections.emptyList();
514 final var mg = getEntityManager();
516 String query = setQueryTable(SELECT_FROM_TABLE, someClass);
518 if (StringUtils.isNotBlank(orderBy)) {
519 query = query.concat(ORDER_BY).concat(orderBy);
522 return mg.createQuery(query, someClass).setMaxResults(numRecords)
530 public <T extends PfConcept> List<T> getAllVersionsByParent(final Class<T> someClass, final String parentKeyName) {
531 if (someClass == null || parentKeyName == null) {
532 return Collections.emptyList();
534 final var mg = getEntityManager();
537 return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS_FOR_PARENT, someClass), someClass)
538 .setParameter(PARENT_NAME, parentKeyName)
547 public <T extends PfConcept> List<T> getAllVersions(final Class<T> someClass, final String conceptName) {
548 if (someClass == null || conceptName == null) {
549 return Collections.emptyList();
551 final var mg = getEntityManager();
554 return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS, someClass), someClass)
555 .setParameter(NAME, conceptName)
564 public <T extends PfConcept> List<T> getByTimestamp(final Class<T> someClass, final PfGeneratedIdKey key,
565 final Instant timeStamp) {
566 if (someClass == null || key == null || timeStamp == null) {
567 return Collections.emptyList();
570 final var mg = getEntityManager();
573 return mg.createQuery(setQueryTable(SELECT_BY_TIMESTAMP_NOKEY, someClass), someClass)
574 .setParameter(NAME, key.getName())
575 .setParameter(VERSION, key.getVersion())
576 .setParameter(TIMESTAMP, Timestamp.from(timeStamp))
585 public <T extends PfConcept> T getConcept(final Class<T> someClass, final PfConceptKey key) {
586 if (someClass == null || key == null) {
589 final var mg = getEntityManager();
593 ret = mg.createQuery(setQueryTable(SELECT_BY_CONCEPT_KEY, someClass), someClass)
594 .setParameter(NAME, key.getName())
595 .setParameter(VERSION, key.getVersion())
602 return getSingleResult(someClass, key.getId(), ret);
606 public <T extends PfConcept> T getConcept(final Class<T> someClass, final PfReferenceKey key) {
607 if (someClass == null || key == null) {
610 final var mg = getEntityManager();
614 ret = mg.createQuery(setQueryTable(SELECT_BY_REFERENCE_KEY, someClass), someClass)
615 .setParameter(PARENT_NAME, key.getParentKeyName())
616 .setParameter(PARENT_VERSION, key.getParentKeyVersion())
617 .setParameter(LOCAL_NAME, key.getLocalName())
624 return getSingleResult(someClass, key.getId(), ret);
628 public <T extends PfConcept> T update(final T obj) {
629 final var mg = getEntityManager();
632 mg.getTransaction().begin();
635 mg.getTransaction().commit();
643 public <T extends PfConcept> long size(final Class<T> someClass) {
644 if (someClass == null) {
647 final var mg = getEntityManager();
651 * The invoking code only passes well-known classes into this method, thus
652 * disabling the sonar about SQL injection.
654 size = mg.createQuery("SELECT COUNT(c) FROM " + someClass.getSimpleName() + " c", Long.class) // NOSONAR
663 * Add the table to a query string.
665 * @param queryString the query string
666 * @param tableClass the class name of the table
667 * @return the updated query string
669 private <T extends PfConcept> String setQueryTable(final String queryString, final Class<T> tableClass) {
670 return queryString.replace(TABLE_TOKEN, tableClass.getSimpleName());
674 * Check that a query returned one and only one entry and return that entry.
676 * @param someClass the class being searched for
677 * @param conceptName the concept name being searched for
678 * @param resultList the result list returned by the query
679 * @return the single unique result
681 private <T extends PfConcept> T getSingleResult(final Class<T> someClass, final String searchFilter, List<T> ret) {
682 if (ret == null || ret.isEmpty()) {
685 if (ret.size() > 1) {
686 throw new IllegalArgumentException("More than one result was returned query on " + someClass
687 + " with filter " + searchFilter + ": " + ret);
693 * check the result get from database and return the object.
695 * @param <T> the type of the object to get, a subclass of {@link PfConcept}
696 * @param someClass the class of the object to get, a subclass of {@link PfConcept}
697 * @param t the object that was retrieved from the database
698 * @return the checked object or null
700 private <T extends PfConcept> T checkAndReturn(final Class<T> someClass, final T objToCheck) {
701 if (objToCheck != null) {
703 return PfUtils.makeCopy(objToCheck);
704 } catch (final Exception e) {
705 LOGGER.warn(CLONE_ERR_MSG, someClass.getName(), e);