netscape.ldap
Class LDAPSSLSocketFactory
java.lang.Object
netscape.ldap.LDAPSSLSocketFactory
- LDAPSocketFactory, LDAPSSLSocketFactoryExt, java.io.Serializable
public class LDAPSSLSocketFactory
extends java.lang.Object
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.
LDAPSSLSocketFactory() - Constructs an
LDAPSSLSocketFactory object using
the default SSL socket implementation,
netscape.net.SSLSocket .
|
LDAPSSLSocketFactory(String className) - Constructs an
LDAPSSLSocketFactory 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.
|
LDAPSSLSocketFactory(String className, boolean clientAuth) - Constructs an
LDAPSSLSocketFactory object using
the specified class.
|
LDAPSSLSocketFactory(boolean clientAuth) - Constructs an
LDAPSSLSocketFactory object using
the default SSL socket implementation,
netscape.net.SSLSocket .
|
void | enableClientAuth() - 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.
|
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 enabled.
|
Socket | makeSocket(String host, int port) - Returns a socket to the LDAP server with the specified
host name and port number.
|
LDAPSSLSocketFactory
public LDAPSSLSocketFactory()
Constructs an LDAPSSLSocketFactory
object using
the default SSL socket implementation,
netscape.net.SSLSocket
. (This class is provided
with Netscape Communicator 4.05 and higher.)
LDAPSSLSocketFactory
public LDAPSSLSocketFactory(String className)
Constructs an LDAPSSLSocketFactory
object using
the specified class. The class must implement the interface
javax.net.ssl.SSLSocket
.
className
- the name of a class implementing
the javax.net.ssl.SSLSocket
interface.
Pass null
for this parameter to use the
default SSL socket implementation,
netscape.net.SSLSocket
, which is included with
Netscape Communicator 4.05 and higher.
LDAPSSLSocketFactory
public LDAPSSLSocketFactory(String className,
Object cipherSuites)
The constructor with the specified package for security and the specified
cipher suites.
className
- the name of a class implementing the interface
javax.net.ssl.SSLSocket
.
Pass null
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
public LDAPSSLSocketFactory(String className,
Object cipherSuites,
boolean clientAuth)
The constructor with the specified package for security and the specified
cipher suites.
className
- the name of a class implementing the interface
javax.net.ssl.SSLSocket
.
Pass null
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.
LDAPSSLSocketFactory
public LDAPSSLSocketFactory(String className,
boolean clientAuth)
Constructs an LDAPSSLSocketFactory
object using
the specified class. The class must implement the interface
javax.net.ssl.SSLSocket
.
className
- the name of a class implementing
the javax.net.ssl.SSLSocket
interface.
Pass null
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
public LDAPSSLSocketFactory(boolean clientAuth)
Constructs an LDAPSSLSocketFactory
object using
the default SSL socket implementation,
netscape.net.SSLSocket
. (This class is provided
with Netscape Communicator 4.05 and up.)
clientAuth
- true
if certificate-based client
authentication is desired. By default, client authentication is
not used.
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 call makeSocket
.
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 call makeSocket
.
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
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)
getCipherSuites
public Object getCipherSuites()
Returns the suite of ciphers used for SSL connections made through
sockets created by this factory.
- getCipherSuites in interface LDAPSSLSocketFactoryExt
- the suite of ciphers used.
getSSLSocketImpl
public String getSSLSocketImpl()
Returns the name of the class that implements SSL sockets for this factory.
- the name of the class that implements SSL sockets for this factory.
makeSocket
public Socket makeSocket(String host,
int port)
throws LDAPException
Returns a socket to the LDAP server with the specified
host name and port number.
- makeSocket in interface LDAPSocketFactory
host
- the host to connect toport
- the port number
- the socket to the host name and port number.
LDAPException
- A socket to the specified host and port
could not be created.