javax.security.auth.x500
Class X500Principal

java.lang.Object
  extended by javax.security.auth.x500.X500Principal
All Implemented Interfaces:
Serializable, Principal

public final class X500Principal
extends Object
implements Principal, Serializable

See Also:
Serialized Form

Field Summary
static String CANONICAL
           
static String RFC1779
           
static String RFC2253
           
 
Constructor Summary
X500Principal(byte[] encoded)
           
X500Principal(InputStream encoded)
           
X500Principal(String name)
           
 
Method Summary
 boolean equals(Object o)
          Determine whether this Object is semantically equal to another Object.
 byte[] getEncoded()
           
 String getName()
          This method returns a String that names this Principal.
 String getName(String format)
           
 int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
 String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

CANONICAL

public static final String CANONICAL
See Also:
Constant Field Values

RFC1779

public static final String RFC1779
See Also:
Constant Field Values

RFC2253

public static final String RFC2253
See Also:
Constant Field Values
Constructor Detail

X500Principal

public X500Principal(String name)

X500Principal

public X500Principal(byte[] encoded)

X500Principal

public X500Principal(InputStream encoded)
Method Detail

hashCode

public int hashCode()
Description copied from class: Object
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

Notice that since hashCode is used in Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

Specified by:
hashCode in interface Principal
Overrides:
hashCode in class Object
Returns:
the hash code for this Object
See Also:
Object.equals(Object), System.identityHashCode(Object)

equals

public boolean equals(Object o)
Description copied from class: Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

This is typically overridden to throw a ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

Specified by:
equals in interface Principal
Overrides:
equals in class Object
Parameters:
o - the Object to compare to
Returns:
whether this Object is semantically equal to another
See Also:
Object.hashCode()

getEncoded

public byte[] getEncoded()

getName

public String getName()
Description copied from interface: Principal
This method returns a String that names this Principal.

Specified by:
getName in interface Principal
Returns:
the name of this Principal

getName

public String getName(String format)

toString

public String toString()
Description copied from class: Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Specified by:
toString in interface Principal
Overrides:
toString in class Object
Returns:
the String representing this Object, which may be null
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)