* LDAPConnection c = null;
* try {
* c = factory.getConn();
* myclass.do_something_with_c(c);
* }
* catch (ELdapException e) {
* handle_error_here();
* }
* finally {
* factory.returnConn(c);
* }
*
*/
public LDAPConnection getConn()
throws ELdapException {
return getConn(true);
}
/**
* Returns a LDAP connection - a clone of the master connection.
* All connections should be returned to the factory using returnConn()
* to recycle connection objects.
* If not returned the limited max number is affected but if that
* number is large not much harm is done.
* Returns null if maximum number of connections reached.
* * The best thing to put returnConn in a finally clause so it * always gets called. For example, *
* LDAPConnection c = null;
* try {
* c = factory.getConn();
* myclass.do_something_with_c(c);
* }
* catch (ELdapException e) {
* handle_error_here();
* }
* finally {
* factory.returnConn(c);
* }
*
*/
public synchronized LDAPConnection getConn(boolean waitForConn)
throws ELdapException {
boolean waited = false;
CMS.debug("LdapAnonConnFactory::getConn");
if (mNumConns == 0)
makeMinimum(true);
if (mNumConns == 0) {
if (!waitForConn)
return null;
try {
CMS.debug("getConn(): out of ldap connections");
log(ILogger.LL_WARN,
"Ran out of ldap connections available " +
"in ldap connection pool to " +
mConnInfo.getHost() + ":" + mConnInfo.getPort() + ". " +
"This could be a temporary condition or an indication of " +
"something more serious that can cause the server to " +
"hang.");
waited = true;
while (mNumConns == 0) {
wait();
}
} catch (InterruptedException e) {
}
}
mNumConns--;
AnonConnection conn = mConns[mNumConns];
mConns[mNumConns] = null;
if (waited) {
log(ILogger.LL_WARN,
"Ldap connections are available again in ldap connection pool " +
"to " + mConnInfo.getHost() + ":" + mConnInfo.getPort());
}
CMS.debug("LdapAnonConnFactory.getConn(): num avail conns now " + mNumConns);
//Beginning of fix for Bugzilla #630176
boolean isConnected = false;
if(conn != null) {
isConnected = conn.isConnected();
}
if(!isConnected) {
CMS.debug("LdapAnonConnFactory.getConn(): selected conn is down, try to reconnect...");
conn = null;
try {
conn = new AnonConnection(mConnInfo);
} catch (LDAPException e) {
CMS.debug("LdapAnonConnFactory.getConn(): error when trying to bring back a down connection.");
throw new ELdapException(
CMS.getUserMessage("CMS_LDAP_CONNECT_TO_LDAP_SERVER_FAILED",
mConnInfo.getHost(), "" + (Integer.valueOf(mConnInfo.getPort())), e.toString()));
}
}
//This is the end of the fix for Bugzilla #630176
return conn;
}
/**
* Returns a connection to the factory for recycling.
* All connections gotten from this factory must be returned.
* If not the max number of connections may be reached prematurely.
* * The best thing to put returnConn in a finally clause so it * always gets called. For example, *
* LDAPConnection c = null;
* try {
* c = factory.getConn();
* myclass.do_something_with_c(c);
* }
* catch (ELdapException e) {
* handle_error_here();
* }
* finally {
* factory.returnConn(c);
* }
*
*/
public synchronized void returnConn(LDAPConnection conn) {
if (conn == null) {
return;
}
// check if conn is valid and from this factory.
AnonConnection anon = (AnonConnection) conn;
if (anon.getFacId() != mConns) {
// returning a connection not from this factory.
log(ILogger.LL_WARN, "returnConn: unknown connection.");
/* swallow this error but see who's doing it. */
ELdapException e =
new ELdapException(CMS.getUserMessage("CMS_LDAP_UNKNOWN_RETURNED_CONN"));
}
// check if conn has already been returned.
for (int i = 0; i < mNumConns; i++) {
// returning connection already returned.
if (mConns[i] == anon) {
/* swallow this error but see who's doing it. */
log(ILogger.LL_WARN,
"returnConn: previously returned connection.");
ELdapException e =
new ELdapException(CMS.getUserMessage("CMS_LDAP_BAD_RETURNED_CONN"));
}
}
// this returned connection might authenticate as someone other than
// anonymonus. Reset it to anonymous first before it returns
// to the pool.
try {
anon.authenticate(null, null);
// return conn.
CMS.debug("returnConn: mNumConns now " + mNumConns);
} catch (LDAPException e) {
log(ILogger.LL_WARN,
"Could not re-authenticate ldap connection to anonymous." +
" Error " + e);
}
// return the connection even if can't reauthentication anon.
// most likely server was down.
mConns[mNumConns++] = anon;
notify();
}
protected void finalize()
throws Exception {
reset();
}
/**
* returns connection info.
*/
public LdapConnInfo getConnInfo() {
return mConnInfo;
}
/**
* resets this factory - if no connections outstanding,
* disconnections all connections and resets everything to 0 as if
* no connections were ever made. intended to be called just before
* shutdown or exit to disconnection & cleanup connections.
*/
// ok only if no connections outstanding.
public synchronized void reset()
throws ELdapException {
if (mNumConns == mTotal) {
for (int i = 0; i < mNumConns; i++) {
try {
CMS.debug("disconnecting connection " + i);
mConns[i].disconnect();
} catch (LDAPException e) {
log(ILogger.LL_INFO,
"exception during disconnect: " + e.toString());
}
mConns[i] = null;
}
mTotal = 0;
mNumConns = 0;
} else {
log(ILogger.LL_INFO,
"Cannot reset() while connections not all returned");
throw new ELdapException(
CMS.getUserMessage("CMS_LDAP_CANNOT_RESET_CONNFAC"));
}
}
/**
* handy routine for logging in this class.
*/
private void log(int level, String msg) {
mLogger.log(ILogger.EV_SYSTEM, ILogger.S_LDAP, level,
"In Ldap (anonymous) connection pool to" +
" host " + mConnInfo.getHost() +
" port " + mConnInfo.getPort() + ", " + msg);
}
/**
* used to keep track of connections from this factory.
*/
public class AnonConnection extends LdapAnonConnection {
public AnonConnection(LdapConnInfo connInfo)
throws LDAPException {
super(connInfo);
}
public AnonConnection(String host, int port, int version,
LDAPSocketFactory fac)
throws LDAPException {
super(host, port, version, fac);
}
/**
* instantiates a non-secure connection to a ldap server
*/
public AnonConnection(String host, int port, int version)
throws LDAPException {
super(host, port, version);
}
/**
* used only to identify the factory from which this came.
* mConns to identify factory.
*/
public AnonConnection[] getFacId() {
return mConns;
}
}
}