LDAPJDK 4.1

netscape.ldap
Class LDAPSSLSocketWrapFactory

java.lang.Object
  |
  +--netscape.ldap.LDAPSSLSocketWrapFactory

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.

See Also:
LDAPSocketFactory, LDAPConnection.LDAPConnection(netscape.ldap.LDAPSocketFactory), Serialized Form

Constructor Summary
LDAPSSLSocketWrapFactory(java.lang.String className)
          The constructor with the specified package for security
LDAPSSLSocketWrapFactory(java.lang.String className, java.lang.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.
 java.lang.Object getCipherSuites()
          Returns the suite of ciphers used for SSL connections made through sockets created by this factory.
 java.lang.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.
 java.net.Socket makeSocket(java.lang.String host, int port)
          Returns socket to the specified host name and port number.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LDAPSSLSocketWrapFactory

public LDAPSSLSocketWrapFactory(java.lang.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(java.lang.String className,
                                java.lang.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 Detail

makeSocket

public java.net.Socket makeSocket(java.lang.String host,
                                  int port)
                           throws LDAPException
Returns socket to the specified host name and port number.
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.

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.

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.

getSSLSocketImpl

public java.lang.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.

getCipherSuites

public java.lang.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.

LDAPJDK 4.1