2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019 Nordix Foundation.
4 * ================================================================================
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.models.dao.impl;
23 import java.util.Collection;
24 import java.util.Collections;
25 import java.util.List;
27 import javax.persistence.EntityManager;
28 import javax.persistence.EntityManagerFactory;
29 import javax.persistence.Persistence;
30 import javax.ws.rs.core.Response;
32 import org.onap.policy.models.base.PfConcept;
33 import org.onap.policy.models.base.PfConceptKey;
34 import org.onap.policy.models.base.PfModelException;
35 import org.onap.policy.models.base.PfModelRuntimeException;
36 import org.onap.policy.models.base.PfReferenceKey;
37 import org.onap.policy.models.dao.DaoParameters;
38 import org.onap.policy.models.dao.PfDao;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
43 * The Class DefaultPfDao is an JPA implementation of the {@link PfDao} class for Policy Framework concepts
44 * ({@link PfConcept}). It uses the default JPA implementation in the javax {@link Persistence} class.
46 public class DefaultPfDao implements PfDao {
47 private static final Logger LOGGER = LoggerFactory.getLogger(DefaultPfDao.class);
50 private static final String NAME = "name";
51 private static final String VERSION = "version";
52 private static final String PARENT_NAME = "parentname";
53 private static final String PARENT_VERSION = "parentversion";
54 private static final String LOCAL_NAME = "localname";
56 private static final String TABLE_TOKEN = "__TABLE__";
58 private static final String DELETE_FROM_TABLE = "DELETE FROM __TABLE__ c";
60 private static final String SELECT_FROM_TABLE = "SELECT c FROM __TABLE__ c";
62 private static final String WHERE = " WHERE ";
63 private static final String AND = " AND ";
65 private static final String NAME_FILTER = "c.key.name = :name";
66 private static final String VERSION_FILTER = "c.key.version = :version";
67 private static final String PARENT_NAME_FILTER = "c.key.parentKeyName = :parentname";
68 private static final String PARENT_VERSION_FILTER = "c.key.parentKeyVersion = :parentversion";
69 private static final String LOCAL_NAME_FILTER = "c.key.localName = :localname";
70 private static final String MAX_VERISON_FILTER = "c.key.version = (SELECT MAX(c.key.version) FROM __TABLE__ c)";
72 private static final String DELETE_BY_CONCEPT_KEY =
73 DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER;
75 private static final String DELETE_BY_REFERENCE_KEY =
76 DELETE_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER + AND + LOCAL_NAME_FILTER;
78 private static final String SELECT_ALL_FOR_PARENT =
79 SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER;
81 private static final String SELECT_ALL_VERSIONS = SELECT_FROM_TABLE + WHERE + NAME_FILTER;
83 private static final String SELECT_LATEST_VERSION =
84 SELECT_FROM_TABLE + WHERE + NAME_FILTER + AND + MAX_VERISON_FILTER;
86 private static final String SELECT_LATEST_VERSIONS =
87 "SELECT c FROM __TABLE__ c WHERE c.key.version = (SELECT MAX(c.key.version) FROM __TABLE__ c)";
89 private static final String SELECT_BY_CONCEPT_KEY =
90 SELECT_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER;
92 private static final String SELECT_BY_REFERENCE_KEY =
93 SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER + AND + LOCAL_NAME_FILTER;
96 // Entity manager for JPA
97 private EntityManagerFactory emf = null;
100 public void init(final DaoParameters daoParameters) throws PfModelException {
101 if (daoParameters == null || daoParameters.getPersistenceUnit() == null) {
102 LOGGER.error("Policy Framework persistence unit parameter not set");
103 throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR,
104 "Policy Framework persistence unit parameter not set");
107 LOGGER.debug("Creating Policy Framework persistence unit \"{}\" . . .", daoParameters.getPersistenceUnit());
109 emf = Persistence.createEntityManagerFactory(daoParameters.getPersistenceUnit(),
110 daoParameters.getJdbcProperties());
111 } catch (final Exception ex) {
112 String errorMessage = "Creation of Policy Framework persistence unit \""
113 + daoParameters.getPersistenceUnit() + "\" failed";
114 LOGGER.warn(errorMessage, ex);
115 throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ex);
117 LOGGER.debug("Created Policy Framework persistence unit \"{}\"", daoParameters.getPersistenceUnit());
121 * Gets the entity manager for this DAO.
123 * @return the entity manager
125 protected final synchronized EntityManager getEntityManager() {
127 LOGGER.warn("Policy Framework DAO has not been initialized");
128 throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR,
129 "Policy Framework DAO has not been initialized");
132 return emf.createEntityManager();
136 public final void close() {
143 public <T extends PfConcept> void create(final T obj) {
147 final EntityManager mg = getEntityManager();
149 mg.getTransaction().begin();
151 mg.getTransaction().commit();
158 public <T extends PfConcept> void delete(final T obj) {
162 final EntityManager mg = getEntityManager();
164 mg.getTransaction().begin();
165 mg.remove(mg.contains(obj) ? obj : mg.merge(obj));
166 mg.getTransaction().commit();
173 public <T extends PfConcept> void delete(final Class<T> someClass, final PfConceptKey key) {
177 final EntityManager mg = getEntityManager();
180 mg.getTransaction().begin();
181 mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass), someClass)
182 .setParameter(NAME, key.getName())
183 .setParameter("version", key.getVersion())
185 mg.getTransaction().commit();
193 public <T extends PfConcept> void delete(final Class<T> someClass, final PfReferenceKey key) {
197 final EntityManager mg = getEntityManager();
200 mg.getTransaction().begin();
201 mg.createQuery(setQueryTable(DELETE_BY_REFERENCE_KEY, someClass), someClass)
202 .setParameter(PARENT_NAME, key.getParentKeyName())
203 .setParameter(PARENT_VERSION, key.getParentKeyVersion())
204 .setParameter(LOCAL_NAME, key.getLocalName())
206 mg.getTransaction().commit();
214 public <T extends PfConcept> void createCollection(final Collection<T> objs) {
215 if (objs == null || objs.isEmpty()) {
218 final EntityManager mg = getEntityManager();
220 mg.getTransaction().begin();
221 for (final T t : objs) {
224 mg.getTransaction().commit();
231 public <T extends PfConcept> void deleteCollection(final Collection<T> objs) {
232 if (objs == null || objs.isEmpty()) {
235 final EntityManager mg = getEntityManager();
237 mg.getTransaction().begin();
238 for (final T t : objs) {
239 mg.remove(mg.contains(t) ? t : mg.merge(t));
241 mg.getTransaction().commit();
248 public <T extends PfConcept> int deleteByConceptKey(final Class<T> someClass, final Collection<PfConceptKey> keys) {
249 if (keys == null || keys.isEmpty()) {
252 int deletedCount = 0;
253 final EntityManager mg = getEntityManager();
256 mg.getTransaction().begin();
257 for (final PfConceptKey key : keys) {
258 deletedCount += mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass), someClass)
259 .setParameter(NAME, key.getName())
260 .setParameter("version", key.getVersion())
263 mg.getTransaction().commit();
272 public <T extends PfConcept> int deleteByReferenceKey(final Class<T> someClass,
273 final Collection<PfReferenceKey> keys) {
274 if (keys == null || keys.isEmpty()) {
277 int deletedCount = 0;
278 final EntityManager mg = getEntityManager();
281 mg.getTransaction().begin();
282 for (final PfReferenceKey key : keys) {
283 deletedCount += mg.createQuery(setQueryTable(DELETE_BY_REFERENCE_KEY, someClass), someClass)
284 .setParameter(PARENT_NAME, key.getParentKeyName())
285 .setParameter(PARENT_VERSION, key.getParentKeyVersion())
286 .setParameter(LOCAL_NAME, key.getLocalName())
289 mg.getTransaction().commit();
298 public <T extends PfConcept> void deleteAll(final Class<T> someClass) {
299 final EntityManager mg = getEntityManager();
301 mg.getTransaction().begin();
302 mg.createQuery(setQueryTable(DELETE_FROM_TABLE, someClass), someClass).executeUpdate();
303 mg.getTransaction().commit();
310 public <T extends PfConcept> List<T> getFiltered(Class<T> someClass, PfConceptKey key) {
311 if (key.getName() == null) {
312 return getAll(someClass);
315 if (key.getVersion() == null) {
316 return getAllVersions(someClass, key.getName());
319 T foundConcept = get(someClass, key);
321 return (foundConcept == null ? Collections.emptyList() : Collections.singletonList(foundConcept));
325 public <T extends PfConcept> T get(final Class<T> someClass, final PfConceptKey key) {
326 if (someClass == null) {
329 final EntityManager mg = getEntityManager();
331 final T t = mg.find(someClass, key);
333 // This clone is created to force the JPA DAO to recurse down through the object
335 final T clonedT = someClass.newInstance();
338 } catch (final Exception e) {
339 LOGGER.warn("Could not clone object of class \"" + someClass.getCanonicalName() + "\"", e);
351 public <T extends PfConcept> T get(final Class<T> someClass, final PfReferenceKey key) {
352 if (someClass == null) {
355 final EntityManager mg = getEntityManager();
357 final T t = mg.find(someClass, key);
360 final T clonedT = someClass.newInstance();
363 } catch (final Exception e) {
364 LOGGER.warn("Could not clone object of class \"" + someClass.getCanonicalName() + "\"", e);
376 public <T extends PfConcept> List<T> getAll(final Class<T> someClass) {
377 if (someClass == null) {
378 return Collections.emptyList();
380 final EntityManager mg = getEntityManager();
382 return mg.createQuery(setQueryTable(SELECT_FROM_TABLE, someClass), someClass).getResultList();
389 public <T extends PfConcept> List<T> getAll(final Class<T> someClass, final PfConceptKey parentKey) {
390 if (someClass == null) {
391 return Collections.emptyList();
393 final EntityManager mg = getEntityManager();
396 return mg.createQuery(setQueryTable(SELECT_ALL_FOR_PARENT, someClass), someClass)
397 .setParameter(PARENT_NAME, parentKey.getName())
398 .setParameter(PARENT_VERSION, parentKey.getVersion())
407 public <T extends PfConcept> List<T> getAllVersions(final Class<T> someClass, final String conceptName) {
408 if (someClass == null || conceptName == null) {
409 return Collections.emptyList();
411 final EntityManager mg = getEntityManager();
414 return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS, someClass), someClass)
415 .setParameter(NAME, conceptName)
424 public <T extends PfConcept> List<T> getLatestVersions(final Class<T> someClass) {
425 if (someClass == null) {
426 return Collections.emptyList();
428 final EntityManager mg = getEntityManager();
432 return mg.createQuery(setQueryTable(SELECT_LATEST_VERSIONS, someClass), someClass)
441 public <T extends PfConcept> T getLatestVersion(final Class<T> someClass, final String conceptName) {
442 if (someClass == null || conceptName == null) {
445 final EntityManager mg = getEntityManager();
449 ret = mg.createQuery(setQueryTable(SELECT_LATEST_VERSION, someClass), someClass)
450 .setParameter(NAME, conceptName)
457 return getSingleResult(someClass, conceptName, ret);
461 public <T extends PfConcept> T getConcept(final Class<T> someClass, final PfConceptKey key) {
462 if (someClass == null || key == null) {
465 final EntityManager mg = getEntityManager();
469 ret = mg.createQuery(setQueryTable(SELECT_BY_CONCEPT_KEY, someClass), someClass)
470 .setParameter(NAME, key.getName())
471 .setParameter(VERSION, key.getVersion())
478 return getSingleResult(someClass, key.getId(), ret);
482 public <T extends PfConcept> T getConcept(final Class<T> someClass, final PfReferenceKey key) {
483 if (someClass == null || key == null) {
486 final EntityManager mg = getEntityManager();
490 ret = mg.createQuery(setQueryTable(SELECT_BY_REFERENCE_KEY, someClass), someClass)
491 .setParameter(PARENT_NAME, key.getParentKeyName())
492 .setParameter(PARENT_VERSION, key.getParentKeyVersion())
493 .setParameter(LOCAL_NAME, key.getLocalName())
500 return getSingleResult(someClass, key.getId(), ret);
504 public <T extends PfConcept> T update(final T obj) {
505 final EntityManager mg = getEntityManager();
508 mg.getTransaction().begin();
511 mg.getTransaction().commit();
519 public <T extends PfConcept> long size(final Class<T> someClass) {
520 if (someClass == null) {
523 final EntityManager mg = getEntityManager();
526 size = mg.createQuery("SELECT COUNT(c) FROM " + someClass.getSimpleName() + " c", Long.class)
535 * Add the table to a query string.
537 * @param queryString the query string
538 * @param tableClass the class name of the table
539 * @return the updated query string
541 private <T extends PfConcept> String setQueryTable(final String queryString, final Class<T> tableClass) {
542 return queryString.replaceAll(TABLE_TOKEN, tableClass.getSimpleName());
546 * Check that a query returned one and only one entry and return that entry.
548 * @param someClass the class being searched for
549 * @param conceptName the concept name being searched for
550 * @param resultList the result list returned by the query
551 * @return the single unique result
553 private <T extends PfConcept> T getSingleResult(final Class<T> someClass, final String searchFilter, List<T> ret) {
554 if (ret == null || ret.isEmpty()) {
557 if (ret.size() > 1) {
558 throw new IllegalArgumentException("More than one result was returned query on " + someClass
559 + " with filter " + searchFilter + ": " + ret);