blob: f706c2ecf08d6260030f1bf9c7004d0136a4f022 (
plain)
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
// --- BEGIN COPYRIGHT BLOCK ---
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.ldap;
import netscape.ldap.LDAPConnection;
import com.netscape.certsrv.base.EBaseException;
import com.netscape.certsrv.base.IConfigStore;
/**
* Maintains a pool of connections to the LDAP server.
* Multiple threads use this interface to utilize and release
* the Ldap connection resources.
*
* @version $Revision$, $Date$
*/
public interface ILdapConnFactory {
/**
* Initialize the poll from the config store.
* @param config The configuration substore.
* @exception EBaseException On configuration error.
* @exception ELdapException On all other errors.
*/
public void init(IConfigStore config)
throws EBaseException, ELdapException;
/**
*
* Used for disconnecting all connections.
* Used just before a subsystem
* shutdown or process exit.
* @exception EldapException on Ldap failure when closing connections.
*/
public void reset()
throws ELdapException;
/**
* Returns the number of free connections available from this pool.
* @return Integer number of free connections.
*/
public int freeConn();
/**
* Returns the number of total connections available from this pool.
* Includes sum of free and in use connections.
* @return Integer number of total connections.
*/
public int totalConn();
/**
* Returns the maximum number of connections available from this pool.
* @return Integer maximum number of connections.
*/
public int maxConn();
/**
* Request access to a Ldap connection from the pool.
* @exception ELdapException if any error occurs, such as a
* @return Ldap connection object.
* connection is not available
*/
public LDAPConnection getConn()
throws ELdapException;
/**
* Return connection to the factory. mandatory after a getConn().
* @param conn Ldap connection object to be returned to the free list of the pool.
* @exception ELdapException On any failure to return the connection.
*/
public void returnConn(LDAPConnection conn)
throws ELdapException;
}
|
