javax.security.auth.x500

Class X500Principal

java.lang.Object

javax.security.auth.x500.X500Principal

All Implemented Interfaces:

java.io.Serializable, java.security.Principal

public final class X500Principal
extends java.lang.Object
implements java.security.Principal, java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CANONICAL
static java.lang.String	RFC1779
static java.lang.String	RFC2253

Constructor Summary

Constructors

Constructor and Description
X500Principal(byte[] encoded)
X500Principal(java.io.InputStream encoded)
X500Principal(java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Determine whether this Object is semantically equal to another Object.
byte[]	getEncoded()
java.lang.String	getName() This method returns a String that names this Principal.
java.lang.String	getName(java.lang.String format)
int	hashCode() Get a value that represents this Object, as uniquely as possible within the confines of an int.
java.lang.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 java.lang.String CANONICAL

See Also:

Constant Field Values

RFC1779

public static final java.lang.String RFC1779

See Also:

Constant Field Values

RFC2253

public static final java.lang.String RFC2253

See Also:

Constant Field Values

Constructor Detail

X500Principal

public X500Principal(java.lang.String name)

X500Principal

public X500Principal(byte[] encoded)

X500Principal

public X500Principal(java.io.InputStream encoded)

Method Detail

hashCode

public int hashCode()

Description copied from class: java.lang.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:

• Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
• It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

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 java.security.Principal

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code for this Object

See Also:

Object.equals(Object), System.identityHashCode(Object)

equals

public boolean equals(java.lang.Object o)

Description copied from class: java.lang.Object

Determine whether this Object is semantically equal to another Object.

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

• It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
• It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
• It must be reflexive. a.equals(a) must always be true.
• It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
• a.equals(null) must be false.
• It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

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 java.security.Principal

Overrides:

equals in class java.lang.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 java.lang.String getName()

Description copied from interface: java.security.Principal

This method returns a String that names this Principal.

Specified by:

getName in interface java.security.Principal

Returns:

the name of this Principal

getName

public java.lang.String getName(java.lang.String format)

toString

public java.lang.String toString()

Description copied from class: java.lang.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 java.security.Principal

Overrides:

toString in class java.lang.Object

Returns:

the String representing this Object, which may be null

See Also:

Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)