1 /*
2 * Copyright (c) 2002-2022, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.portal.service.jpa;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37 import fr.paris.lutece.portal.service.plugin.PluginService;
38 import fr.paris.lutece.portal.service.spring.SpringContextService;
39 import fr.paris.lutece.util.jpa.JPAGenericDAO;
40
41 import javax.persistence.EntityManagerFactory;
42 import javax.persistence.Query;
43
44 /**
45 * Generic JPA DAO for Lutece components
46 *
47 * @param <K>
48 * Type of the entity's key
49 * @param <E>
50 * Type of the entity
51 */
52 public abstract class JPALuteceDAO<K, E> extends JPAGenericDAO<K, E>
53 {
54 private static final String BEAN_ENTITY_MANAGER_SERVICE = "entityManagerService";
55 private static final String DEFAULT_PERSISTENCE_UNIT = "portal";
56
57 /**
58 * Gets the plugin name. Override this method to define the plugin associated to this DAO
59 *
60 * @return The plugin name
61 */
62 public abstract String getPluginName( );
63
64 /**
65 * Gets the entity manager to use with this DAO
66 *
67 * @return The appropriate entity manager delivered by the EntityManagerService
68 */
69 public EntityManagerFactory getEntityManagerFactory( )
70 {
71 String strPersistenceUnit = DEFAULT_PERSISTENCE_UNIT;
72 Plugin plugin = PluginService.getPlugin( getPluginName( ) );
73
74 if ( plugin != null )
75 {
76 strPersistenceUnit = plugin.getDbPoolName( );
77 }
78
79 EntityManagerService ems = SpringContextService.getBean( BEAN_ENTITY_MANAGER_SERVICE );
80
81 return ems.getEntityManagerFactory( strPersistenceUnit );
82 }
83
84 /**
85 *
86 * @param strSQL
87 * The SQL query
88 * @return query
89 */
90 protected Query createNativeQuery( String strSQL )
91 {
92 return getEM( ).createNativeQuery( strSQL );
93 }
94 }