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.database;
35
36 import fr.paris.lutece.portal.service.init.LuteceInitException;
37 import fr.paris.lutece.portal.service.util.AppException;
38 import fr.paris.lutece.portal.service.util.AppPathService;
39 import fr.paris.lutece.util.ReferenceList;
40 import fr.paris.lutece.util.pool.PoolManager;
41 import fr.paris.lutece.util.pool.service.ConnectionService;
42
43 import java.io.InputStream;
44
45 import java.sql.Connection;
46
47 /**
48 * This class provides a Database Connection Service based on pooled connections.
49 */
50 public final class AppConnectionService
51 {
52 // //////////////////////////////////////////////////////////////////////////
53 // Constants
54 public static final String NO_POOL_DEFINED = "none";
55 public static final String DEFAULT_POOL_NAME = "portal";
56 private static PoolManager _poolManager;
57 private static PluginConnectionService _connectionService;
58
59 /**
60 * Creates a new AppConnectionService object.
61 */
62 private AppConnectionService( )
63 {
64 }
65
66 /**
67 * Initializes the connection pool and sets the pool manager instance
68 *
69 * @param strConfigPath
70 * The relative Config path
71 * @param strConfigFilename
72 * The config file name
73 * @param strPoolName
74 * The pool name
75 * @throws LuteceInitException
76 * If an error occured
77 */
78 public static void init( String strConfigPath, String strConfigFilename, String strPoolName ) throws LuteceInitException
79 {
80 try
81 {
82 InputStream is = AppPathService.getResourceAsStream( strConfigPath, strConfigFilename );
83 _poolManager = PoolManager.getInstance( is );
84 _connectionService = new PluginConnectionService( strPoolName );
85 is.close( );
86 }
87 catch( Exception e )
88 {
89 throw new LuteceInitException( "Error initializing pool : " + e.getMessage( ), e );
90 }
91 }
92
93 /**
94 * Returns a connection to database from the pool name
95 *
96 * @return a connection to database from the pool
97 */
98 public static Connection getConnection( )
99 {
100 if ( _poolManager == null )
101 {
102 throw new AppException( "* Erreur * getConnection : Le pool de connexion n'est pas initialise !" );
103 }
104
105 return _connectionService.getConnection( );
106 }
107
108 /**
109 * Releases a connection and replaces it in the pool
110 *
111 * @param conn
112 * The connection to realease
113 */
114 public static void freeConnection( Connection conn )
115 {
116 _connectionService.freeConnection( conn );
117 }
118
119 /**
120 * Releases all the connections on all the pools
121 */
122 public static void releasePool( )
123 {
124 _poolManager.release( );
125 }
126
127 /**
128 * Gets a reference on the current Pool Manager
129 *
130 * @return The current Pool Manager
131 */
132 public static PoolManager getPoolManager( )
133 {
134 if ( _poolManager == null )
135 {
136 throw new AppException( "PoolManager was not initialized !" );
137 }
138
139 return _poolManager;
140 }
141
142 /**
143 * Gets the list of all pools defined in the db.properties file
144 *
145 * @param list
146 * The Reference List
147 */
148 public static void getPoolList( ReferenceList list )
149 {
150 for ( ConnectionService cs : _poolManager.getPools( ) )
151 {
152 list.addItem( cs.getPoolName( ), cs.getPoolName( ) );
153 }
154 }
155
156 /**
157 * Returns a default Plugin Connection Service
158 *
159 * @return The connection Service
160 */
161 public static PluginConnectionService getDefaultConnectionService( )
162 {
163 return _connectionService;
164 }
165 }