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.onap.policy.models.base.PfConcept;
36 import org.onap.policy.models.base.PfConceptKey;
37 import org.onap.policy.models.base.PfGeneratedIdKey;
38 import org.onap.policy.models.base.PfModelException;
39 import org.onap.policy.models.base.PfModelRuntimeException;
40 import org.onap.policy.models.base.PfReferenceKey;
41 import org.onap.policy.models.base.PfReferenceTimestampKey;
42 import org.onap.policy.models.base.PfTimestampKey;
43 import org.onap.policy.models.base.PfUtils;
44 import org.onap.policy.models.dao.DaoParameters;
45 import org.onap.policy.models.dao.PfDao;
46 import org.onap.policy.models.dao.PfFilter;
47 import org.onap.policy.models.dao.PfFilterFactory;
48 import org.slf4j.Logger;
49 import org.slf4j.LoggerFactory;
52 * The Class DefaultPfDao is an JPA implementation of the {@link PfDao} class for Policy Framework concepts
53 * ({@link PfConcept}). It uses the default JPA implementation in the javax {@link Persistence} class.
55 public class DefaultPfDao implements PfDao {
56 private static final Logger LOGGER = LoggerFactory.getLogger(DefaultPfDao.class);
59 private static final String NAME = "name";
60 private static final String VERSION = "version";
61 private static final String TIMESTAMP = "timeStamp";
62 private static final String GENERATEDID = "Id";
63 private static final String PARENT_NAME = "parentname";
64 private static final String PARENT_VERSION = "parentversion";
65 private static final String LOCAL_NAME = "localname";
67 private static final String TABLE_TOKEN = "__TABLE__";
69 private static final String DELETE_FROM_TABLE = "DELETE FROM __TABLE__ c";
71 private static final String SELECT_FROM_TABLE = "SELECT c FROM __TABLE__ c";
73 private static final String WHERE = " WHERE ";
74 private static final String AND = " AND ";
76 private static final String NAME_FILTER = "c.key.name = :name";
77 private static final String VERSION_FILTER = "c.key.version = :version";
78 private static final String TIMESTAMP_FILTER = "c.key.timeStamp = :timeStamp";
79 private static final String TIMESTAMP_FILTER_NOKEY = "c.timeStamp = :timeStamp";
80 private static final String GENERATED_ID_FILTER = "c.key.generatedId = :Id";
81 private static final String PARENT_NAME_FILTER = "c.key.parentKeyName = :parentname";
82 private static final String PARENT_VERSION_FILTER = "c.key.parentKeyVersion = :parentversion";
83 private static final String LOCAL_NAME_FILTER = "c.key.localName = :localname";
85 private static final String CLONE_ERR_MSG = "Could not clone object of class \"{}\"";
87 private static final String DELETE_BY_CONCEPT_KEY =
88 DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER;
90 private static final String DELETE_BY_TIMESTAMP_KEY =
91 DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER + AND + TIMESTAMP_FILTER;
93 private static final String DELETE_BY_GENERATED_ID_KEY =
94 DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER + AND + GENERATED_ID_FILTER;
96 private static final String DELETE_BY_REFERENCE_KEY =
97 DELETE_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER + AND + LOCAL_NAME_FILTER;
99 private static final String SELECT_ALL_FOR_PARENT =
100 SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER;
102 private static final String SELECT_ALL_VERSIONS_FOR_PARENT =
103 SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER;
105 private static final String SELECT_ALL_VERSIONS = SELECT_FROM_TABLE + WHERE + NAME_FILTER;
107 private static final String SELECT_BY_CONCEPT_KEY =
108 SELECT_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER;
110 private static final String SELECT_BY_TIMESTAMP_NOKEY =
111 SELECT_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER + AND + TIMESTAMP_FILTER_NOKEY;
113 private static final String SELECT_BY_REFERENCE_KEY =
114 SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER + AND + LOCAL_NAME_FILTER;
117 // Entity manager for JPA
118 private EntityManagerFactory emf = null;
121 public void init(final DaoParameters daoParameters) throws PfModelException {
122 if (daoParameters == null || daoParameters.getPersistenceUnit() == null) {
123 LOGGER.error("Policy Framework persistence unit parameter not set");
124 throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR,
125 "Policy Framework persistence unit parameter not set");
128 LOGGER.debug("Creating Policy Framework persistence unit \"{}\" . . .", daoParameters.getPersistenceUnit());
130 emf = Persistence.createEntityManagerFactory(daoParameters.getPersistenceUnit(),
131 daoParameters.getJdbcProperties());
132 } catch (final Exception ex) {
133 String errorMessage = "Creation of Policy Framework persistence unit \""
134 + daoParameters.getPersistenceUnit() + "\" failed";
135 LOGGER.warn(errorMessage);
136 throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ex);
138 LOGGER.debug("Created Policy Framework persistence unit \"{}\"", daoParameters.getPersistenceUnit());
142 * Gets the entity manager for this DAO.
144 * @return the entity manager
146 protected final synchronized EntityManager getEntityManager() {
148 LOGGER.warn("Policy Framework DAO has not been initialized");
149 throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR,
150 "Policy Framework DAO has not been initialized");
153 return emf.createEntityManager();
157 public final void close() {
164 public <T extends PfConcept> void create(final T obj) {
168 final var mg = getEntityManager();
170 mg.getTransaction().begin();
172 mg.getTransaction().commit();
179 public <T extends PfConcept> void delete(final T obj) {
183 final var mg = getEntityManager();
185 mg.getTransaction().begin();
186 mg.remove(mg.contains(obj) ? obj : mg.merge(obj));
187 mg.getTransaction().commit();
194 public <T extends PfConcept> void delete(final Class<T> someClass, final PfConceptKey key) {
198 final var mg = getEntityManager();
201 mg.getTransaction().begin();
202 mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass), someClass)
203 .setParameter(NAME, key.getName())
204 .setParameter(VERSION, key.getVersion())
206 mg.getTransaction().commit();
214 public <T extends PfConcept> void delete(final Class<T> someClass, final PfReferenceKey key) {
218 final var mg = getEntityManager();
221 mg.getTransaction().begin();
222 mg.createQuery(setQueryTable(DELETE_BY_REFERENCE_KEY, someClass), someClass)
223 .setParameter(PARENT_NAME, key.getParentKeyName())
224 .setParameter(PARENT_VERSION, key.getParentKeyVersion())
225 .setParameter(LOCAL_NAME, key.getLocalName())
227 mg.getTransaction().commit();
235 public <T extends PfConcept> void delete(final Class<T> someClass, final PfTimestampKey key) {
239 final var mg = getEntityManager();
242 mg.getTransaction().begin();
243 mg.createQuery(setQueryTable(DELETE_BY_TIMESTAMP_KEY, someClass), someClass)
244 .setParameter(NAME, key.getName())
245 .setParameter(VERSION, key.getVersion())
246 .setParameter(TIMESTAMP, key.getTimeStamp())
248 mg.getTransaction().commit();
256 public <T extends PfConcept> void delete(final Class<T> someClass, final PfGeneratedIdKey key) {
260 final var mg = getEntityManager();
263 mg.getTransaction().begin();
264 mg.createQuery(setQueryTable(DELETE_BY_GENERATED_ID_KEY, someClass), someClass)
265 .setParameter(NAME, key.getName())
266 .setParameter(VERSION, key.getVersion())
267 .setParameter(GENERATEDID, key.getGeneratedId())
269 mg.getTransaction().commit();
277 public <T extends PfConcept> void createCollection(final Collection<T> objs) {
278 if (objs == null || objs.isEmpty()) {
281 final var mg = getEntityManager();
283 mg.getTransaction().begin();
284 for (final T t : objs) {
287 mg.getTransaction().commit();
294 public <T extends PfConcept> void deleteCollection(final Collection<T> objs) {
295 if (objs == null || objs.isEmpty()) {
298 final var mg = getEntityManager();
300 mg.getTransaction().begin();
301 for (final T t : objs) {
302 mg.remove(mg.contains(t) ? t : mg.merge(t));
304 mg.getTransaction().commit();
311 public <T extends PfConcept> int deleteByConceptKey(final Class<T> someClass, final Collection<PfConceptKey> keys) {
312 if (keys == null || keys.isEmpty()) {
315 var deletedCount = 0;
316 final var mg = getEntityManager();
319 mg.getTransaction().begin();
320 for (final PfConceptKey key : keys) {
321 deletedCount += mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass), someClass)
322 .setParameter(NAME, key.getName())
323 .setParameter(VERSION, key.getVersion())
326 mg.getTransaction().commit();
335 public <T extends PfConcept> int deleteByReferenceKey(final Class<T> someClass,
336 final Collection<PfReferenceKey> keys) {
337 if (keys == null || keys.isEmpty()) {
340 var deletedCount = 0;
341 final var mg = getEntityManager();
344 mg.getTransaction().begin();
345 for (final PfReferenceKey key : keys) {
346 deletedCount += mg.createQuery(setQueryTable(DELETE_BY_REFERENCE_KEY, someClass), someClass)
347 .setParameter(PARENT_NAME, key.getParentKeyName())
348 .setParameter(PARENT_VERSION, key.getParentKeyVersion())
349 .setParameter(LOCAL_NAME, key.getLocalName())
352 mg.getTransaction().commit();
361 public <T extends PfConcept> void deleteAll(final Class<T> someClass) {
362 final var mg = getEntityManager();
364 mg.getTransaction().begin();
365 mg.createQuery(setQueryTable(DELETE_FROM_TABLE, someClass), someClass).executeUpdate();
366 mg.getTransaction().commit();
373 public <T extends PfConcept> List<T> getFiltered(final Class<T> someClass, final String name,
374 final String version) {
376 return getAll(someClass);
379 if (version == null) {
380 return getAllVersions(someClass, name);
383 var foundConcept = get(someClass, new PfConceptKey(name, version));
385 return (foundConcept == null ? Collections.emptyList() : Collections.singletonList(foundConcept));
389 public <T extends PfConcept> List<T> getFiltered(final Class<T> someClass, final String name, final String version,
390 final Instant startTime, final Instant endTime, final Map<String, Object> filterMap, final String sortOrder,
391 final int getRecordNum) {
392 final var mg = getEntityManager();
394 var filterQueryString = SELECT_FROM_TABLE + WHERE;
397 PfFilter timeStampFilter = new PfFilterFactory().createFilter(someClass);
398 filterQueryString = timeStampFilter.addFilter(filterQueryString,
399 name, startTime, endTime, filterMap, sortOrder, getRecordNum);
402 TypedQuery<T> query = mg.createQuery(setQueryTable(filterQueryString, someClass), someClass);
404 if (filterMap != null) {
405 for (Map.Entry<String, Object> entry : filterMap.entrySet()) {
406 query.setParameter(entry.getKey(), entry.getValue());
410 query.setParameter(timeStampFilter.getNameParameter(), name);
412 if (startTime != null) {
413 if (endTime != null) {
414 query.setParameter("startTime", Timestamp.from(startTime));
415 query.setParameter("endTime", Timestamp.from(endTime));
417 query.setParameter("startTime", Timestamp.from(startTime));
420 if (endTime != null) {
421 query.setParameter("endTime", Timestamp.from(endTime));
424 if (getRecordNum > 0) {
425 query.setMaxResults(getRecordNum);
428 LOGGER.debug("filterQueryString is \"{}\"", filterQueryString);
429 return query.getResultList();
436 public <T extends PfConcept> T get(final Class<T> someClass, final PfConceptKey key) {
437 return genericGet(someClass, key);
441 public <T extends PfConcept> T get(final Class<T> someClass, final PfReferenceKey key) {
442 return genericGet(someClass, key);
446 public <T extends PfConcept> T get(final Class<T> someClass, final PfGeneratedIdKey key) {
447 return genericGet(someClass, key);
451 public <T extends PfConcept> T get(final Class<T> someClass, final PfTimestampKey key) {
452 return genericGet(someClass, key);
456 public <T extends PfConcept> T get(final Class<T> someClass, final PfReferenceTimestampKey key) {
457 return genericGet(someClass, key);
460 private <T extends PfConcept> T genericGet(final Class<T> someClass, final Object key) {
461 if (someClass == null) {
464 final var mg = getEntityManager();
466 final var t = mg.find(someClass, key);
470 return checkAndReturn(someClass, t);
477 public <T extends PfConcept> List<T> getAll(final Class<T> someClass) {
478 if (someClass == null) {
479 return Collections.emptyList();
481 final var mg = getEntityManager();
483 return mg.createQuery(setQueryTable(SELECT_FROM_TABLE, someClass), someClass).getResultList();
490 public <T extends PfConcept> List<T> getAll(final Class<T> someClass, final PfConceptKey parentKey) {
491 if (someClass == null) {
492 return Collections.emptyList();
494 final var mg = getEntityManager();
497 return mg.createQuery(setQueryTable(SELECT_ALL_FOR_PARENT, someClass), someClass)
498 .setParameter(PARENT_NAME, parentKey.getName())
499 .setParameter(PARENT_VERSION, parentKey.getVersion())
508 public <T extends PfConcept> List<T> getAllVersionsByParent(final Class<T> someClass, final String parentKeyName) {
509 if (someClass == null || parentKeyName == null) {
510 return Collections.emptyList();
512 final var mg = getEntityManager();
515 return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS_FOR_PARENT, someClass), someClass)
516 .setParameter(PARENT_NAME, parentKeyName)
525 public <T extends PfConcept> List<T> getAllVersions(final Class<T> someClass, final String conceptName) {
526 if (someClass == null || conceptName == null) {
527 return Collections.emptyList();
529 final var mg = getEntityManager();
532 return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS, someClass), someClass)
533 .setParameter(NAME, conceptName)
542 public <T extends PfConcept> List<T> getByTimestamp(final Class<T> someClass,
543 final PfGeneratedIdKey key,
544 final Instant timeStamp) {
545 if (someClass == null || key == null || timeStamp == null) {
546 return Collections.emptyList();
549 final var mg = getEntityManager();
552 return mg.createQuery(setQueryTable(SELECT_BY_TIMESTAMP_NOKEY, someClass), someClass)
553 .setParameter(NAME, key.getName())
554 .setParameter(VERSION, key.getVersion())
555 .setParameter(TIMESTAMP, Timestamp.from(timeStamp))
564 public <T extends PfConcept> T getConcept(final Class<T> someClass, final PfConceptKey key) {
565 if (someClass == null || key == null) {
568 final var mg = getEntityManager();
572 ret = mg.createQuery(setQueryTable(SELECT_BY_CONCEPT_KEY, someClass), someClass)
573 .setParameter(NAME, key.getName())
574 .setParameter(VERSION, key.getVersion())
581 return getSingleResult(someClass, key.getId(), ret);
585 public <T extends PfConcept> T getConcept(final Class<T> someClass, final PfReferenceKey key) {
586 if (someClass == null || key == null) {
589 final var mg = getEntityManager();
593 ret = mg.createQuery(setQueryTable(SELECT_BY_REFERENCE_KEY, someClass), someClass)
594 .setParameter(PARENT_NAME, key.getParentKeyName())
595 .setParameter(PARENT_VERSION, key.getParentKeyVersion())
596 .setParameter(LOCAL_NAME, key.getLocalName())
603 return getSingleResult(someClass, key.getId(), ret);
607 public <T extends PfConcept> T update(final T obj) {
608 final var mg = getEntityManager();
611 mg.getTransaction().begin();
614 mg.getTransaction().commit();
622 public <T extends PfConcept> long size(final Class<T> someClass) {
623 if (someClass == null) {
626 final var mg = getEntityManager();
630 * The invoking code only passes well-known classes into this method, thus
631 * disabling the sonar about SQL injection.
633 size = mg.createQuery("SELECT COUNT(c) FROM " + someClass.getSimpleName() + " c", Long.class) // NOSONAR
642 * Add the table to a query string.
644 * @param queryString the query string
645 * @param tableClass the class name of the table
646 * @return the updated query string
648 private <T extends PfConcept> String setQueryTable(final String queryString, final Class<T> tableClass) {
649 return queryString.replace(TABLE_TOKEN, tableClass.getSimpleName());
653 * Check that a query returned one and only one entry and return that entry.
655 * @param someClass the class being searched for
656 * @param conceptName the concept name being searched for
657 * @param resultList the result list returned by the query
658 * @return the single unique result
660 private <T extends PfConcept> T getSingleResult(final Class<T> someClass, final String searchFilter, List<T> ret) {
661 if (ret == null || ret.isEmpty()) {
664 if (ret.size() > 1) {
665 throw new IllegalArgumentException("More than one result was returned query on " + someClass
666 + " with filter " + searchFilter + ": " + ret);
672 * check the result get from database and return the object.
674 * @param <T> the type of the object to get, a subclass of {@link PfConcept}
675 * @param someClass the class of the object to get, a subclass of {@link PfConcept}
676 * @param t the object that was retrieved from the database
677 * @return the checked object or null
679 private <T extends PfConcept> T checkAndReturn(final Class<T> someClass, final T objToCheck) {
680 if (objToCheck != null) {
682 return PfUtils.makeCopy(objToCheck);
683 } catch (final Exception e) {
684 LOGGER.warn(CLONE_ERR_MSG, someClass.getName(), e);