Package netscape.ldap
Class LDAPSSLSocketFactory
java.lang.Object
netscape.ldap.LDAPSSLSocketFactory
- All Implemented Interfaces:
Serializable
,LDAPSocketFactory
,LDAPSSLSocketFactoryExt
Creates an SSL socket connection to an LDAP Server. This class
implements the
LDAPSSLSocketFactoryExt
interface.
To construct an object of this class, you need to specify the
name of a class that implements the javax.net.ssl.SSLSocket
interface. If you do not specify a class name, the class
netscape.net.SSLSocket
is used by default. This
class is included with Netscape Communicator 4.05 and up.
If you are using a Java VM that provides certificate database management (such as Netscape Communicator), you can authenticate your client to a secure LDAP server by using certificates.
- Version:
- 1.0
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs anLDAPSSLSocketFactory
object using the default SSL socket implementation,netscape.net.SSLSocket
.LDAPSSLSocketFactory
(boolean clientAuth) Constructs anLDAPSSLSocketFactory
object using the default SSL socket implementation,netscape.net.SSLSocket
.LDAPSSLSocketFactory
(String className) Constructs anLDAPSSLSocketFactory
object using the specified class.LDAPSSLSocketFactory
(String className, boolean clientAuth) Constructs anLDAPSSLSocketFactory
object using the specified class.LDAPSSLSocketFactory
(String className, Object cipherSuites) The constructor with the specified package for security and the specified cipher suites.LDAPSSLSocketFactory
(String className, Object cipherSuites, boolean clientAuth) The constructor with the specified package for security and the specified cipher suites. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Enables certificate-based client authentication for an application.void
enableClientAuth
(String certdb, String keydb, String keypwd, String certnickname, String keynickname) This method is currently not implemented.Returns the suite of ciphers used for SSL connections made through sockets created by this factory.Returns the name of the class that implements SSL sockets for this factory.boolean
Returnstrue
if client authentication is enabled.makeSocket
(String host, int port) Returns a socket to the LDAP server with the specified host name and port number.
-
Constructor Details
-
LDAPSSLSocketFactory
public LDAPSSLSocketFactory()Constructs anLDAPSSLSocketFactory
object using the default SSL socket implementation,netscape.net.SSLSocket
. (This class is provided with Netscape Communicator 4.05 and higher.) -
LDAPSSLSocketFactory
public LDAPSSLSocketFactory(boolean clientAuth) Constructs anLDAPSSLSocketFactory
object using the default SSL socket implementation,netscape.net.SSLSocket
. (This class is provided with Netscape Communicator 4.05 and up.)- Parameters:
clientAuth
-true
if certificate-based client authentication is desired. By default, client authentication is not used.
-
LDAPSSLSocketFactory
Constructs anLDAPSSLSocketFactory
object using the specified class. The class must implement the interfacejavax.net.ssl.SSLSocket
.- Parameters:
className
- the name of a class implementing thejavax.net.ssl.SSLSocket
interface. Passnull
for this parameter to use the default SSL socket implementation,netscape.net.SSLSocket
, which is included with Netscape Communicator 4.05 and higher.
-
LDAPSSLSocketFactory
Constructs anLDAPSSLSocketFactory
object using the specified class. The class must implement the interfacejavax.net.ssl.SSLSocket
.- Parameters:
className
- the name of a class implementing thejavax.net.ssl.SSLSocket
interface. Passnull
for this parameter to use the default SSL socket implementation,netscape.net.SSLSocket
, which is included with Netscape Communicator 4.05 and higher.clientAuth
-true
if certificate-based client authentication is desired. By default, client authentication is not used.
-
LDAPSSLSocketFactory
The constructor with the specified package for security and the specified cipher suites.- Parameters:
className
- the name of a class implementing the interfacejavax.net.ssl.SSLSocket
. Passnull
for this parameter to use the default SSL socket implementation,netscape.net.SSLSocket
, which is included with Netscape Communicator 4.05 and higher.cipherSuites
- the cipher suites to use for SSL connections
-
LDAPSSLSocketFactory
The constructor with the specified package for security and the specified cipher suites.- Parameters:
className
- the name of a class implementing the interfacejavax.net.ssl.SSLSocket
. Passnull
for this parameter to use the default SSL socket implementation,netscape.net.SSLSocket
, which is included with Netscape Communicator 4.05 and higher.cipherSuites
- the cipher suites to use for SSL connectionsclientAuth
-true
if certificate-based client authentication is desired. By default, client authentication is not used.
-
-
Method Details
-
enableClientAuth
public void enableClientAuth()Enables certificate-based client authentication for an application. The application must be running in a Java VM that provides transparent certificate database management (for example, Netscape Communicator's Java VM). Call this method before you callmakeSocket
. -
enableClientAuth
public void enableClientAuth(String certdb, String keydb, String keypwd, String certnickname, String keynickname) throws LDAPException This method is currently not implemented. Enables client authentication for an application that uses an external (file-based) certificate database. Call this method before you callmakeSocket
.- Parameters:
certdb
- the pathname for the certificate databasekeydb
- the pathname for the private key databasekeypwd
- the password for the private key databasecertnickname
- the alias for the certificatekeynickname
- the alias for the key- Throws:
LDAPException
- Since this method is not yet implemented, calling this method throws an exception. Note:enableClientAuth(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
is deprecated. This method is replaced by any one of the following constructors:LDAPSSLSocketFactory(boolean)
LDAPSSLSocketFactory(java.lang.String, boolean)
LDAPSSLSocketFactory(java.lang.String, java.lang.Object, boolean)
- See Also:
-
isClientAuth
public boolean isClientAuth()Returnstrue
if client authentication is enabled.- Specified by:
isClientAuth
in interfaceLDAPSSLSocketFactoryExt
- See Also:
-
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
Returns the suite of ciphers used for SSL connections made through sockets created by this factory.- Specified by:
getCipherSuites
in interfaceLDAPSSLSocketFactoryExt
- Returns:
- the suite of ciphers used.
-
makeSocket
Returns a socket to the LDAP server with the specified host name and port number.- Specified by:
makeSocket
in interfaceLDAPSocketFactory
- Parameters:
host
- the host to connect toport
- the port number- Returns:
- the socket to the host name and port number.
- Throws:
LDAPException
- A socket to the specified host and port could not be created.- See Also:
-