netscape.ldap

Class LDAPSSLSocketWrapFactory

Implemented Interfaces:
LDAPSocketFactory, LDAPSSLSocketFactoryExt, java.io.Serializable

public class LDAPSSLSocketWrapFactory
extends java.lang.Object
implements LDAPSSLSocketFactoryExt, java.io.Serializable

Creates an SSL socket connection to an LDAP Server. This class is provided by the package in which the SSL socket does not extend Socket object. The class internally provides a wrapper to convert the SSL socket extending the Object class to the one extending the Socket class. This factory class implements the LDAPSocketFactory interface.

To use this class, pass the instance of this factory object to the LDAPConnection constructor.

Version:
1.0
See Also:
LDAPSocketFactory, LDAPConnection.LDAPConnection(LDAPSocketFactory), Serialized Form

Constructor Summary

LDAPSSLSocketWrapFactory(String className)
The constructor with the specified package for security
LDAPSSLSocketWrapFactory(String className, Object cipherSuites)
The constructor with the specified package for security and the specified cipher suites.

Method Summary

void
enableClientAuth()
(Not implemented yet)
Enables client authentication for an application running in a java VM which provides transparent certificate database management.
Object
getCipherSuites()
Returns the suite of ciphers used for SSL connections made through sockets created by this factory.
String
getSSLSocketImpl()
Returns the name of the class that implements SSL sockets for this factory.
boolean
isClientAuth()
Returns true if client authentication is to be used.
Socket
makeSocket(String host, int port)
Returns socket to the specified host name and port number.

Constructor Details

LDAPSSLSocketWrapFactory

public LDAPSSLSocketWrapFactory(String className)
The constructor with the specified package for security
Parameters:
className - the name of a class which has an implementation of the SSL Socket extending Object class

LDAPSSLSocketWrapFactory

public LDAPSSLSocketWrapFactory(String className,
                                Object cipherSuites)
The constructor with the specified package for security and the specified cipher suites.
Parameters:
className - the name of a class which has an implementation of the SSL Socket extending Object class
cipherSuites - the cipher suites

Method Details

enableClientAuth

public void enableClientAuth()
            throws LDAPException
(Not implemented yet)
Enables client authentication for an application running in a java VM which provides transparent certificate database management. Calling this method has no effect after makeSocket() has been called.
Throws:
LDAPException - Since this method is not yet implemented, calling this method throws an exception.

getCipherSuites

public Object getCipherSuites()
Returns the suite of ciphers used for SSL connections made through sockets created by this factory.
Specified by:
getCipherSuites in interface LDAPSSLSocketFactoryExt
Returns:
the suite of ciphers used.

getSSLSocketImpl

public String getSSLSocketImpl()
Returns the name of the class that implements SSL sockets for this factory.
Returns:
the name of the class that implements SSL sockets for this factory.

isClientAuth

public boolean isClientAuth()
Returns true if client authentication is to be used.
Specified by:
isClientAuth in interface LDAPSSLSocketFactoryExt
Returns:
true if client authentication is enabled; falseif client authentication is disabled.

makeSocket

public Socket makeSocket(String host,
                         int port)
            throws LDAPException
Returns socket to the specified host name and port number.
Specified by:
makeSocket in interface LDAPSocketFactory
Parameters:
host - the host to connect to
port - the port number
Returns:
the socket to the host name and port number as passed in.
Throws:
LDAPException - A socket to the specified host and port could not be created.