edu.amc.sakai.user

Class LDAPJSSESecureSocketFactory

java.lang.Object

edu.amc.sakai.user.LDAPJSSESecureSocketFactory

All Implemented Interfaces:

org.ietf.ldap.LDAPSocketFactory

public class LDAPJSSESecureSocketFactory
extends Object
implements com.novell.ldap.LDAPSocketFactory, org.ietf.ldap.LDAPSocketFactory

Represents a socket factory that creates secure socket connections to LDAP servers using JSSE technology. Unlike the one in the JLDAP library this actually has a connection connectTimeout that is sensible in production. This modifies the standard one in the JLDAP library to specify a connect timeout so that we don't wait forever to connect to a server.

See Also:

LDAPConnection#LDAPConnection(LDAPSocketFactory), LDAPConnection#setSocketFactory

Constructor Summary

Constructors

Constructor and Description
LDAPJSSESecureSocketFactory() Constructs an LDAPSecureSocketFactory object using the default provider for a JSSE SSLSocketFactory.
LDAPJSSESecureSocketFactory(SSLSocketFactory factory) Constructs an LDAPSocketFactory object using the SSLSocketFactory specified.

Method Summary

Modifier and Type	Method and Description
Socket	createSocket(String host, int port) Returns the socket connected to the LDAP server with the specified host name and port number.
int	getConnectTimeout()
void	setConnectTimeout(int connectTimeout)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LDAPJSSESecureSocketFactory

public LDAPJSSESecureSocketFactory()

Constructs an LDAPSecureSocketFactory object using the default provider for a JSSE SSLSocketFactory.

Setting the keystore for the default provider is specific to the provider implementation. For Sun's JSSE provider, the property javax.net.ssl.truststore should be set to the path of a keystore that holds the trusted root certificate of the directory server.

For information on creating keystores see the keytool documentation on Java 2, security tools.

LDAPJSSESecureSocketFactory

public LDAPJSSESecureSocketFactory(SSLSocketFactory factory)

Constructs an LDAPSocketFactory object using the SSLSocketFactory specified. For information on using the the SSLSocketFactory, see also javax.net.ssl.SSLSocketFactory

Method Detail

getConnectTimeout

public int getConnectTimeout()

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

createSocket

public Socket createSocket(String host,
                           int port)
                    throws IOException,
                           UnknownHostException

Returns the socket connected to the LDAP server with the specified host name and port number.

The secure connection is established to the server when this call returns. This method is called by the constructor of LDAPConnection

Specified by:

createSocket in interface org.ietf.ldap.LDAPSocketFactory

Parameters:

host - The host name or a dotted string representing the IP address of the LDAP server to which you want to establish a connection.

port - The port number on the specified LDAP server that you want to use for this connection. The default LDAP port for SSL connections is 636.

Returns:

A socket to the LDAP server using the specific host name and port number.

Throws:

IOException - A socket to the specified host and port could not be created.

UnknownHostException - The specified host could not be found.