java.lang.Object javax.security.auth.x500.X500Principal
public final class X500Principal
This class represents an X.500 Principal. X500Principals are represented by distinguished names such as "CN=Duke, OU=JavaSoft, O=Sun Microsystems, C=US".
This class can be instantiated by using a string representation of the distinguished name, or by using the ASN.1 DER encoded byte representation of the distinguished name. The current specification for the string representation of a distinguished name is defined in RFC 2253 . This class, however, accepts string formats from both RFC 2253 and RFC 1779 , and also recognizes attribute type keywords whose OIDs (Object Identifiers) are defined in RFC 2459 .
The string representation for this X500Principal can be obtained by calling the getName methods.
Note that the getSubjectX500Principal and getIssuerX500Principal methods of X509Certificate return X500Principals representing the issuer and subject fields of the certificate.
Field Summary | |
---|---|
static String |
CANONICAL
Canonical String format of Distinguished Names. |
static String |
RFC1779
RFC 1779 String format of Distinguished Names. |
static String |
RFC2253
RFC 2253 String format of Distinguished Names. |
Constructor Summary | |
---|---|
X500Principal
(byte[] name) Creates an X500Principal from a distinguished name in ASN.1 DER encoded form. |
|
X500Principal
(
InputStream
is) Creates an X500Principal from an InputStream containing the distinguished name in ASN.1 DER encoded form. |
|
X500Principal
(
String
name) Creates an X500Principal from a string representation of an X.500 distinguished name (ex: "CN=Duke, OU=JavaSoft, O=Sun Microsystems, C=US"). |
|
X500Principal
(
String
name,
Map
<
String
,
String
Creates an X500Principal from a string representation of an X.500 distinguished name (ex: "CN=Duke, OU=JavaSoft, O=Sun Microsystems, C=US"). |
Method Summary | |
---|---|
boolean |
equals
(
Object
o) Compares the specified Object with this X500Principal for equality. |
byte[] |
getEncoded
() Returns the distinguished name in ASN.1 DER encoded form. |
String |
getName
() Returns a string representation of the X.500 distinguished name using the format defined in RFC 2253. |
String |
getName
(
String
format) Returns a string representation of the X.500 distinguished name using the specified format. |
String |
getName
(
String
format,
Map
<
String
,
String
Returns a string representation of the X.500 distinguished name using the specified format. |
int |
hashCode
() Return a hash code for this X500Principal. |
String |
toString
() Return a user-friendly string representation of this X500Principal. |
Methods inherited from class java.lang. Object |
---|
clone , finalize , getClass , notify , notifyAll , wait , wait , wait |
Field Detail |
---|
public static final String RFC1779
public static final String RFC2253
public static final String CANONICAL
Constructor Detail |
---|
public X500Principal(String name)
This constructor recognizes the attribute type keywords defined in RFC 1779 and RFC 2253 (and listed in getName(String format) ), as well as the T, DNQ or DNQUALIFIER, SURNAME, GIVENNAME, INITIALS, GENERATION, EMAILADDRESS, and SERIALNUMBER keywords whose OIDs are defined in RFC 2459 and its successor. Any other attribute type must be specified as an OID.
public X500Principal ( String name, Map< String, String> keywordMap)
This constructor recognizes the attribute type keywords specified in X500Principal(String) and also recognizes additional keywords that have entries in the keywordMap parameter. Keyword entries in the keywordMap take precedence over the default keywords recognized by X500Principal(String). Keywords MUST be specified in all upper-case, otherwise they will be ignored. Improperly specified keywords are ignored; however if a keyword in the name maps to an improperly specified OID, an IllegalArgumentException is thrown. It is permissible to have 2 different keywords that map to the same OID.
public X500Principal(byte[] name)
Name ::= CHOICE { RDNSequence } RDNSequence ::= SEQUENCE OF RelativeDistinguishedName RelativeDistinguishedName ::= SET SIZE (1 .. MAX) OF AttributeTypeAndValue AttributeTypeAndValue ::= SEQUENCE { type AttributeType, value AttributeValue } AttributeType ::= OBJECT IDENTIFIER AttributeValue ::= ANY DEFINED BY AttributeType .... DirectoryString ::= CHOICE { teletexString TeletexString (SIZE (1..MAX)), printableString PrintableString (SIZE (1..MAX)), universalString UniversalString (SIZE (1..MAX)), utf8String UTF8String (SIZE (1.. MAX)), bmpString BMPString (SIZE (1..MAX)) }
public X500Principal(InputStream is)
The read position of the input stream is positioned to the next available byte after the encoded distinguished name.
Method Detail |
---|
public String getName()
This method is equivalent to calling getName(X500Principal.RFC2253).
public String getName(String format)
If "RFC1779" is specified as the format, this method emits the attribute type keywords defined in RFC 1779 (CN, L, ST, O, OU, C, STREET). Any other attribute type is emitted as an OID.
If "RFC2253" is specified as the format, this method emits the attribute type keywords defined in RFC 2253 (CN, L, ST, O, OU, C, STREET, DC, UID). Any other attribute type is emitted as an OID. Under a strict reading, RFC 2253 only specifies a UTF-8 string representation. The String returned by this method is the Unicode string achieved by decoding this UTF-8 representation.
If "CANONICAL" is specified as the format, this method returns an RFC 2253 conformant string representation with the following additional canonicalizations:
Additional standard formats may be introduced in the future.
public StringgetName ( String format, Map< String, String> oidMap)
This method returns Strings in the format as specified in getName(String) and also emits additional attribute type keywords for OIDs that have entries in the oidMap parameter. OID entries in the oidMap take precedence over the default OIDs recognized by getName(String). Improperly specified OIDs are ignored; however if an OID in the name maps to an improperly specified keyword, an IllegalArgumentException is thrown.
Additional standard formats may be introduced in the future.
Warning: additional attribute type keywords may not be recognized by other implementations; therefore do not use this method if you are unsure if these keywords will be recognized by other implementations.
public byte[] getEncoded()
Note that the byte array returned is cloned to protect against subsequent modifications.
public String toString()
public boolean equals(Object o)
Specifically, this method returns true if the Object o is an X500Principal and if the respective canonical string representations (obtained via the getName(X500Principal.CANONICAL) method) of this object and o are equal.
This implementation is compliant with the requirements of RFC 2459.
public int hashCode()
The hash code is calculated via: getName(X500Principal.CANONICAL).hashCode()