summaryrefslogtreecommitdiffstats
path: root/base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java
diff options
context:
space:
mode:
authorEndi Sukma Dewata <edewata@redhat.com>2012-03-24 02:27:47 -0500
committerEndi Sukma Dewata <edewata@redhat.com>2012-03-26 11:43:54 -0500
commit621d9e5c413e561293d7484b93882d985b3fe15f (patch)
tree638f3d75761c121d9a8fb50b52a12a6686c5ac5c /base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java
parent40d3643b8d91886bf210aa27f711731c81a11e49 (diff)
downloadpki-621d9e5c413e561293d7484b93882d985b3fe15f.tar.gz
pki-621d9e5c413e561293d7484b93882d985b3fe15f.tar.xz
pki-621d9e5c413e561293d7484b93882d985b3fe15f.zip
Removed unnecessary pki folder.
Previously the source code was located inside a pki folder. This folder was created during svn migration and is no longer needed. This folder has now been removed and the contents have been moved up one level. Ticket #131
Diffstat (limited to 'base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java')
-rw-r--r--base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java97
1 files changed, 97 insertions, 0 deletions
diff --git a/base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java b/base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java
new file mode 100644
index 000000000..738f5832d
--- /dev/null
+++ b/base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java
@@ -0,0 +1,97 @@
+// --- 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;
+
+}