| java.lang.Object | |
| ↳ | javax.security.auth.x500.X500Principal |
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.
| 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 | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Creates a new X500Principal from a given ASN.1 DER encoding of a
distinguished name.
| |||||||||||
Creates a new X500Principal from a given ASN.1 DER encoding of a
distinguished name.
| |||||||||||
Creates a new X500Principal from a string representation of a
distinguished name.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Compares this instance with the specified object and indicates if they
are equal.
| |||||||||||
Returns an ASN.1 DER-encoded representation of the distinguished name
contained in this X.500 principal.
| |||||||||||
Returns a human-readable string representation of the distinguished name
contained in this X.500 principal.
| |||||||||||
Returns a string representation of the distinguished name contained in
this X.500 principal.
| |||||||||||
Returns an integer hash code for this object.
| |||||||||||
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
| |||||||||||
Defines a constant for the canonical string format of distinguished names.
Defines a constant for the RFC 1779 string format of distinguished names.
Defines a constant for the RFC 2253 string format of distinguished names.
Creates a new X500Principal from a given ASN.1 DER encoding of a distinguished name.
| name | the ASN.1 DER-encoded distinguished name |
|---|
| IllegalArgumentException | if the ASN.1 DER-encoded distinguished name is incorrect |
|---|
Creates a new X500Principal from a given ASN.1 DER encoding of a distinguished name.
| in | an InputStream holding the ASN.1 DER-encoded
distinguished name |
|---|
| IllegalArgumentException | if the ASN.1 DER-encoded distinguished name is incorrect |
|---|
Creates a new X500Principal from a string representation of a distinguished name.
| name | the string representation of the distinguished name |
|---|
| IllegalArgumentException | if the string representation of the distinguished name is incorrect |
|---|
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.
| o | the object to compare this instance with. |
|---|
true if the specified object is equal to this Object; false otherwise.Returns an ASN.1 DER-encoded representation of the distinguished name contained in this X.500 principal.
Returns a human-readable string representation of the distinguished name contained in this X.500 principal.
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.
| format | the name of the format to use for the representation |
|---|
| IllegalArgumentException | if the format argument is not one of the three
mentioned above
|
|---|
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 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.