APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.jndi.ldap

pack-priv Class ClientId

extends Object
Class Inheritance
Known Direct Subclasses
com.sun.jndi.ldap.SimpleClientId
Imports
java.util.Locale, .Arrays, java.io.OutputStream, javax.naming.ldap.Control, java.lang.reflect.Method, javax.net.SocketFactory
Represents identity information about an anonymous LDAP connection. This base class contains the following information: - protocol version number - server's hostname (case-insensitive) - server's port number - prototype type (plain or ssl) - controls to be sent with the LDAP bind request All other identity classes must be a subclass of ClientId. Identity subclasses would add more distinguishing information, depending on the type of authentication that the connection is to have. The equals() and hashCode() methods of this class and its subclasses are important because they are used to determine whether two requests for the same connection are identical, and thus whether the same connection may be shared. This is especially important for authenticated connections because a mistake would result in a serious security violation.
Author
Rosanna Lee

Field Summary

Modifier and TypeField and Description
private final Control[]
bindCtls

private final int
ctlHash

public static final boolean
debug

private SocketFactory
factory

private final String
hostname

private boolean
isDefaultSockFactory

private final int
myHash

private final int
port

private final String
protocol

private Method
sockComparator

private final String
socketFactory

private final OutputStream
trace

private final int
version

Constructor Summary

AccessConstructor and Description
pack-priv
ClientId(int version, String hostname, int port, String protocol, Control[] bindCtls, OutputStream trace, String socketFactory)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

private static boolean
equalsControls(Control[] a, Control[] b)

private boolean
equalsSockFactory(ClientId other)

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

private static int
hashCodeControls(Control[] c)

private boolean
invokeComparator(ClientId c1, ClientId c2)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

private static String
toStringControls(Control[] ctls)

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

bindCtlsback to summary
private final Control[] bindCtls
ctlHashback to summary
private final int ctlHash
debugback to summary
public static final boolean debug
factoryback to summary
private SocketFactory factory
hostnameback to summary
private final String hostname
isDefaultSockFactoryback to summary
private boolean isDefaultSockFactory
myHashback to summary
private final int myHash
portback to summary
private final int port
protocolback to summary
private final String protocol
sockComparatorback to summary
private Method sockComparator
socketFactoryback to summary
private final String socketFactory
traceback to summary
private final OutputStream trace
versionback to summary
private final int version

Constructor Detail

ClientIdback to summary
pack-priv ClientId(int version, String hostname, int port, String protocol, Control[] bindCtls, OutputStream trace, String socketFactory)

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

equalsControlsback to summary
private static boolean equalsControls(Control[] a, Control[] b)
equalsSockFactoryback to summary
private boolean equalsSockFactory(ClientId other)
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
hashCodeControlsback to summary
private static int hashCodeControls(Control[] c)
invokeComparatorback to summary
private boolean invokeComparator(ClientId c1, ClientId c2)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

toStringControlsback to summary
private static String toStringControls(Control[] ctls)