summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java
diff options
context:
space:
mode:
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java')
-rw-r--r--pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java53
1 files changed, 27 insertions, 26 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java b/pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java
index 35a074047..f706c2ecf 100644
--- a/pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java
+++ b/pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java
@@ -17,75 +17,76 @@
// --- 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.
- *
+ * 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.
+ * @exception ELdapException On all other errors.
*/
- public void init(IConfigStore config) throws EBaseException, ELdapException;
+ public void init(IConfigStore config)
+ throws EBaseException, ELdapException;
/**
- *
- * Used for disconnecting all connections. Used just before a subsystem
+ *
+ * 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;
+ public void reset()
+ throws ELdapException;
/**
* Returns the number of free connections available from this pool.
- *
- * @return Integer number of free connections.
- */
+ * @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
+ /**
+ * 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;
+ 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.
+ * @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;
+ public void returnConn(LDAPConnection conn)
+ throws ELdapException;
}