java.security.cert
Class LDAPCertStoreParameters

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.security.cert.LDAPCertStoreParameters
All Implemented Interfaces:
Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable , CertStoreParameters sample code for java.security.cert.CertStoreParameters definition code for java.security.cert.CertStoreParameters

public class LDAPCertStoreParameters
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements CertStoreParameters sample code for java.security.cert.CertStoreParameters definition code for java.security.cert.CertStoreParameters

Parameters used as input for the LDAP CertStore algorithm.

This class is used to provide necessary configuration parameters (server name and port number) to implementations of the LDAP CertStore algorithm.

Concurrent Access

Unless otherwise specified, the methods defined in this class are not thread-safe. Multiple threads that need to access a single object concurrently should synchronize amongst themselves and provide the necessary locking. Multiple threads each manipulating separate objects need not synchronize.

Since:
1.4
See Also:
CertStore sample code for java.security.cert.CertStore definition code for java.security.cert.CertStore

Constructor Summary
LDAPCertStoreParameters sample code for java.security.cert.LDAPCertStoreParameters.LDAPCertStoreParameters() definition code for java.security.cert.LDAPCertStoreParameters.LDAPCertStoreParameters() ()
          Creates an instance of LDAPCertStoreParameters with the default parameter values (server name "localhost", port 389).
LDAPCertStoreParameters sample code for java.security.cert.LDAPCertStoreParameters.LDAPCertStoreParameters(java.lang.String) definition code for java.security.cert.LDAPCertStoreParameters.LDAPCertStoreParameters(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  serverName)
          Creates an instance of LDAPCertStoreParameters with the specified server name and a default port of 389.
LDAPCertStoreParameters sample code for java.security.cert.LDAPCertStoreParameters.LDAPCertStoreParameters(java.lang.String, int) definition code for java.security.cert.LDAPCertStoreParameters.LDAPCertStoreParameters(java.lang.String, int) (String sample code for java.lang.String definition code for java.lang.String  serverName, int port)
          Creates an instance of LDAPCertStoreParameters with the specified parameter values.
 
Method Summary
 Object sample code for java.lang.Object definition code for java.lang.Object clone sample code for java.security.cert.LDAPCertStoreParameters.clone() definition code for java.security.cert.LDAPCertStoreParameters.clone() ()
          Returns a copy of this object.
 int getPort sample code for java.security.cert.LDAPCertStoreParameters.getPort() definition code for java.security.cert.LDAPCertStoreParameters.getPort() ()
          Returns the port number of the LDAP server.
 String sample code for java.lang.String definition code for java.lang.String getServerName sample code for java.security.cert.LDAPCertStoreParameters.getServerName() definition code for java.security.cert.LDAPCertStoreParameters.getServerName() ()
          Returns the DNS name of the LDAP server.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for java.security.cert.LDAPCertStoreParameters.toString() definition code for java.security.cert.LDAPCertStoreParameters.toString() ()
          Returns a formatted string describing the parameters.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

LDAPCertStoreParameters sample code for java.security.cert.LDAPCertStoreParameters(java.lang.String, int) definition code for java.security.cert.LDAPCertStoreParameters(java.lang.String, int)

public LDAPCertStoreParameters(String sample code for java.lang.String definition code for java.lang.String  serverName,
                               int port)
Creates an instance of LDAPCertStoreParameters with the specified parameter values.

Parameters:
serverName - the DNS name of the LDAP server
port - the port number of the LDAP server
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if serverName is null

LDAPCertStoreParameters sample code for java.security.cert.LDAPCertStoreParameters(java.lang.String) definition code for java.security.cert.LDAPCertStoreParameters(java.lang.String)

public LDAPCertStoreParameters(String sample code for java.lang.String definition code for java.lang.String  serverName)
Creates an instance of LDAPCertStoreParameters with the specified server name and a default port of 389.

Parameters:
serverName - the DNS name of the LDAP server
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if serverName is null

LDAPCertStoreParameters sample code for java.security.cert.LDAPCertStoreParameters() definition code for java.security.cert.LDAPCertStoreParameters()

public LDAPCertStoreParameters()
Creates an instance of LDAPCertStoreParameters with the default parameter values (server name "localhost", port 389).

Method Detail

getServerName sample code for java.security.cert.LDAPCertStoreParameters.getServerName() definition code for java.security.cert.LDAPCertStoreParameters.getServerName()

public String sample code for java.lang.String definition code for java.lang.String  getServerName()
Returns the DNS name of the LDAP server.

Returns:
the name (not null)

getPort sample code for java.security.cert.LDAPCertStoreParameters.getPort() definition code for java.security.cert.LDAPCertStoreParameters.getPort()

public int getPort()
Returns the port number of the LDAP server.

Returns:
the port number

clone sample code for java.security.cert.LDAPCertStoreParameters.clone() definition code for java.security.cert.LDAPCertStoreParameters.clone()

public Object sample code for java.lang.Object definition code for java.lang.Object  clone()
Returns a copy of this object. Changes to the copy will not affect the original and vice versa.

Note: this method currently performs a shallow copy of the object (simply calls Object.clone()). This may be changed in a future revision to perform a deep copy if new parameters are added that should not be shared.

Specified by:
clone sample code for java.security.cert.CertStoreParameters.clone() definition code for java.security.cert.CertStoreParameters.clone() in interface CertStoreParameters sample code for java.security.cert.CertStoreParameters definition code for java.security.cert.CertStoreParameters
Overrides:
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
the copy
See Also:
Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable

toString sample code for java.security.cert.LDAPCertStoreParameters.toString() definition code for java.security.cert.LDAPCertStoreParameters.toString()

public String sample code for java.lang.String definition code for java.lang.String  toString()
Returns a formatted string describing the parameters.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a formatted string describing the parameters