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