Android APIs
public final class

X500Principal

extends Object
implements Serializable Principal
java.lang.Object
   ↳ javax.security.auth.x500.X500Principal

Class Overview

Represents an X.500 principal, which holds the distinguished name of some network entity. An example of a distinguished name is "O=SomeOrg, OU=SomeOrgUnit, C=US". The class can be instantiated from a byte representation of an object identifier (OID), an ASN.1 DER-encoded version, or a simple string holding the distinguished name. The representations must follow either RFC 2253, RFC 1779, or RFC2459.

Summary

Constants
String CANONICAL Defines a constant for the canonical string format of distinguished names.
String RFC1779 Defines a constant for the RFC 1779 string format of distinguished names.
String RFC2253 Defines a constant for the RFC 2253 string format of distinguished names.
Public Constructors
X500Principal(byte[] name)
Creates a new X500Principal from a given ASN.1 DER encoding of a distinguished name.
X500Principal(InputStream in)
Creates a new X500Principal from a given ASN.1 DER encoding of a distinguished name.
X500Principal(String name)
Creates a new X500Principal from a string representation of a distinguished name.
X500Principal(String name, Map<StringString> keywordMap)
Public Methods
boolean equals(Object o)
Compares this instance with the specified object and indicates if they are equal.
byte[] getEncoded()
Returns an ASN.1 DER-encoded representation of the distinguished name contained in this X.500 principal.
String getName()
Returns a human-readable string representation of the distinguished name contained in this X.500 principal.
String getName(String format)
Returns a string representation of the distinguished name contained in this X.500 principal.
String getName(String format, Map<StringString> oidMap)
int hashCode()
Returns an integer hash code for this object.
String toString()
Returns a string containing a concise, human-readable description of this object.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.security.Principal

Constants

public static final String CANONICAL

Added in API level 1

Defines a constant for the canonical string format of distinguished names.

Constant Value: "CANONICAL"

public static final String RFC1779

Added in API level 1

Defines a constant for the RFC 1779 string format of distinguished names.

Constant Value: "RFC1779"

public static final String RFC2253

Added in API level 1

Defines a constant for the RFC 2253 string format of distinguished names.

Constant Value: "RFC2253"

Public Constructors

public X500Principal (byte[] name)

Added in API level 1

Creates a new X500Principal from a given ASN.1 DER encoding of a distinguished name.

Parameters
name byte: the ASN.1 DER-encoded distinguished name
Throws
IllegalArgumentException if the ASN.1 DER-encoded distinguished name is incorrect

public X500Principal (InputStream in)

Added in API level 1

Creates a new X500Principal from a given ASN.1 DER encoding of a distinguished name.

Parameters
in InputStream: an InputStream holding the ASN.1 DER-encoded distinguished name
Throws
IllegalArgumentException if the ASN.1 DER-encoded distinguished name is incorrect

public X500Principal (String name)

Added in API level 1

Creates a new X500Principal from a string representation of a distinguished name.

Parameters
name String: the string representation of the distinguished name
Throws
IllegalArgumentException if the string representation of the distinguished name is incorrect

public X500Principal (String name, Map<StringString> keywordMap)

Added in API level 9

Parameters
name String
keywordMap Map

Public Methods

public boolean equals (Object o)

Added in API level 1

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
o Object: the object to compare this instance with.
Returns
boolean true if the specified object is equal to this Object; false otherwise.

public byte[] getEncoded ()

Added in API level 1

Returns an ASN.1 DER-encoded representation of the distinguished name contained in this X.500 principal.

Returns
byte[] the ASN.1 DER-encoded representation

public String getName ()

Added in API level 1

Returns a human-readable string representation of the distinguished name contained in this X.500 principal.

Returns
String the string representation

public String getName (String format)

Added in API level 1

Returns a string representation of the distinguished name contained in this X.500 principal. The format of the representation can be chosen. Valid arguments are RFC1779, RFC2253, and CANONICAL. The representations are specified in RFC 1779 and RFC 2253, respectively. The canonical form is based on RFC 2253, but adds some canonicalizing operations like removing leading and trailing whitespace, lower-casing the whole name, and bringing it into a normalized Unicode representation.

Parameters
format String: the name of the format to use for the representation
Returns
String the string representation
Throws
IllegalArgumentException if the format argument is not one of the three mentioned above

public String getName (String format, Map<StringString> oidMap)

Added in API level 9

Parameters
format String
oidMap Map
Returns
String

public int hashCode ()

Added in API level 1

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
int this object's hash code.

public String toString ()

Added in API level 1

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
String a printable representation of this object.