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.util.pool.service;
35
36 import org.apache.log4j.Logger;
37
38 import java.sql.Connection;
39
40 import java.util.Hashtable;
41
42 import javax.sql.DataSource;
43
44
45 /**
46 * Database Connection Service Interface
47 */
48 public interface ConnectionService
49 {
50 int INFO_NOT_AVAILABLE = -1;
51
52 /**
53 * Get a connection
54 * @return A database connection
55 */
56 Connection getConnection( );
57
58 /**
59 * Release the connection
60 * @param conn The connection to release
61 */
62 void freeConnection( Connection conn );
63
64 /**
65 * Free all connections
66 */
67 void release( );
68
69 /**
70 * Initialize pool parameters
71 * @param htParamsConnectionPool Parameters
72 */
73 void init( Hashtable<String, String> htParamsConnectionPool );
74
75 /**
76 * Define the pool name
77 * @param strPoolName The pool name
78 */
79 void setPoolName( String strPoolName );
80
81 /**
82 * Gets the pool name
83 * @return The pool name
84 */
85 String getPoolName( );
86
87 /**
88 * Define the logger
89 * @param logger The logger
90 */
91 void setLogger( Logger logger );
92
93 /**Gets the logger
94 *
95 * @return The logger
96 */
97 Logger getLogger( );
98
99 /**
100 * Gets the number of opened connections
101 * @return The current connections count
102 */
103 int getCurrentConnections( );
104
105 /**
106 * Gets the max connections
107 * @return The max connections count
108 */
109 int getMaxConnections( );
110
111 /**
112 * Gets the pool manager provider
113 * @return The pool manager
114 */
115 String getPoolProvider( );
116
117 /**
118 * Get datasource
119 * @return A data source object
120 */
121 DataSource getDataSource( );
122 }