1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright (C) 2004 Jive Software. All rights reserved.
*
* This software is published under the terms of the GNU Public License (GPL),
* a copy of which is included in this distribution.
*/
package org.jivesoftware.database;
import java.sql.Connection;
import java.sql.SQLException;
/**
* Abstract class that defines the connection provider framework. Other classes
* extend this abstract class to make connection to actual data sources.<p>
* <p/>
* It is expected that each subclass be a JavaBean, so that properties of
* the connection provider are exposed through bean introspection.
*
* @author Jive Software
*/
public interface ConnectionProvider {
/**
* Returns true if this connection provider provides connections out
* of a connection pool. Implementing and using connection providers that
* are pooled is strongly recommended, as they greatly increase the speed
* of Jive.
*
* @return true if the Connection objects returned by this provider are
* pooled.
*/
public boolean isPooled();
/**
* Returns a database connection. When a Jive component is done with a
* connection, it will call the close method of that connection. Therefore,
* connection pools with special release methods are not directly
* supported by the connection provider infrastructure. Instead, connections
* from those pools should be wrapped such that calling the close method
* on the wrapper class will release the connection from the pool.
*
* @return a Connection object.
*/
public Connection getConnection() throws SQLException;
/**
* Starts the connection provider. For some connection providers, this
* will be a no-op. However, connection provider users should always call
* this method to make sure the connection provider is started.
*/
public void start();
/**
* This method should be called whenever properties have been changed so
* that the changes will take effect.
*/
public void restart();
/**
* Tells the connection provider to destroy itself. For many connection
* providers, this will essentially result in a no-op. However,
* connection provider users should always call this method when changing
* from one connection provider to another to ensure that there are no
* dangling database connections.
*/
public void destroy();
}