| java.lang.Object javax.security.auth.x500.X500Principal
Field Summary | |
final public static String | CANONICAL Canonical String format of Distinguished Names. | final public static String | RFC1779 RFC 1779 String format of Distinguished Names. | final public static String | RFC2253 RFC 2253 String format of Distinguished Names. |
Constructor Summary | |
| X500Principal(X500Name x500Name) Creates an X500Principal by wrapping an X500Name.
NOTE: The constructor is package private. | public | 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").
The distinguished name must be specified using the grammar defined in
RFC 1779 or RFC 2253 (either format is acceptable). | public | X500Principal(String name, Map<String, String> keywordMap) Creates an X500Principal from a string representation of
an X.500 distinguished name (ex:
"CN=Duke, OU=JavaSoft, O=Sun Microsystems, C=US").
The distinguished name must be specified using the grammar defined in
RFC 1779 or RFC 2253 (either format is acceptable).
This constructor recognizes the attribute type keywords specified
in
X500Principal.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) . | public | X500Principal(byte[] name) Creates an X500Principal from a distinguished name in
ASN.1 DER encoded form. | public | X500Principal(InputStream is) Creates an X500Principal from an InputStream
containing the distinguished name in ASN.1 DER encoded form. |
Method Summary | |
public boolean | equals(Object o) Compares the specified Object with this
X500Principal for equality. | public byte[] | getEncoded() Returns the distinguished name in ASN.1 DER encoded form. | public String | getName() Returns a string representation of the X.500 distinguished name using
the format defined in RFC 2253. | public String | getName(String format) Returns a string representation of the X.500 distinguished name
using the specified format. | public String | getName(String format, Map<String, String> oidMap) Returns a string representation of the X.500 distinguished name
using the specified format. | public int | hashCode() Return a hash code for this X500Principal . | public String | toString() Return a user-friendly string representation of this
X500Principal . |
CANONICAL | final public static String CANONICAL(Code) | | Canonical String format of Distinguished Names.
|
RFC1779 | final public static String RFC1779(Code) | | RFC 1779 String format of Distinguished Names.
|
RFC2253 | final public static String RFC2253(Code) | | RFC 2253 String format of Distinguished Names.
|
X500Principal | X500Principal(X500Name x500Name)(Code) | | Creates an X500Principal by wrapping an X500Name.
NOTE: The constructor is package private. It is intended to be accessed
using privileged reflection from classes in sun.security.*.
Currently referenced from sun.security.x509.X500Name.asX500Principal().
|
X500Principal | public X500Principal(String name)(Code) | | Creates an X500Principal from a string representation of
an X.500 distinguished name (ex:
"CN=Duke, OU=JavaSoft, O=Sun Microsystems, C=US").
The distinguished name must be specified using the grammar defined in
RFC 1779 or RFC 2253 (either format is acceptable).
This constructor recognizes the attribute type keywords
defined in RFC 1779 and RFC 2253
(and listed in
X500Principal.getName(String format) 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 3280 and its successor.
Any other attribute type must be specified as an OID.
Parameters: name - an X.500 distinguished name in RFC 1779 or RFC 2253 format exception: NullPointerException - if the name is null exception: IllegalArgumentException - if the name is improperly specified |
X500Principal | public X500Principal(String name, Map<String, String> keywordMap)(Code) | | Creates an X500Principal from a string representation of
an X.500 distinguished name (ex:
"CN=Duke, OU=JavaSoft, O=Sun Microsystems, C=US").
The distinguished name must be specified using the grammar defined in
RFC 1779 or RFC 2253 (either format is acceptable).
This constructor recognizes the attribute type keywords specified
in
X500Principal.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.
Parameters: name - an X.500 distinguished name in RFC 1779 or RFC 2253 format Parameters: keywordMap - an attribute type keyword map, where each key is akeyword String that maps to a corresponding object identifier in Stringform (a sequence of nonnegative integers separated by periods). The mapmay be empty but never null . exception: NullPointerException - if name orkeywordMap is null exception: IllegalArgumentException - if the name isimproperly specified or a keyword in the name maps to an OID that is not in the correct form since: 1.6 |
X500Principal | public X500Principal(byte[] name)(Code) | | Creates an X500Principal from a distinguished name in
ASN.1 DER encoded form. The ASN.1 notation for this structure is as
follows.
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)) }
Parameters: name - a byte array containing the distinguished name in ASN.1 DER encoded form throws: IllegalArgumentException - if an encoding error occurs(incorrect form for DN) |
X500Principal | public X500Principal(InputStream is)(Code) | | Creates an X500Principal from an InputStream
containing the distinguished name in ASN.1 DER encoded form.
The ASN.1 notation for this structure is supplied in the
documentation for
X500Principal.X500Principal(byte[] name) X500Principal(byte[] name) .
The read position of the input stream is positioned
to the next available byte after the encoded distinguished name.
Parameters: is - an InputStream containing the distinguishedname in ASN.1 DER encoded form exception: NullPointerException - if the InputStream is null exception: IllegalArgumentException - if an encoding error occurs(incorrect form for DN) |
equals | public boolean equals(Object o)(Code) | | Compares the specified Object with this
X500Principal for equality.
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 3280.
Parameters: o - Object to be compared for equality with thisX500Principal true if the specified Object is equal to this X500Principal , false otherwise |
getEncoded | public byte[] getEncoded()(Code) | | Returns the distinguished name in ASN.1 DER encoded form. The ASN.1
notation for this structure is supplied in the documentation for
X500Principal.X500Principal(byte[] name) X500Principal(byte[] name) .
Note that the byte array returned is cloned to protect against
subsequent modifications.
a byte array containing the distinguished name in ASN.1 DER encoded form |
getName | public String getName()(Code) | | Returns a string representation of the X.500 distinguished name using
the format defined in RFC 2253.
This method is equivalent to calling
getName(X500Principal.RFC2253) .
the distinguished name of this X500Principal |
getName | public String getName(String format)(Code) | | Returns a string representation of the X.500 distinguished name
using the specified format. Valid values for the format are
"RFC1779", "RFC2253", and "CANONICAL" (case insensitive).
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:
- Leading zeros are removed from attribute types
that are encoded as dotted decimal OIDs
- DirectoryString attribute values of type
PrintableString and UTF8String are not
output in hexadecimal format
- DirectoryString attribute values of types
other than PrintableString and UTF8String
are output in hexadecimal format
- Leading and trailing white space characters
are removed from non-hexadecimal attribute values
(unless the value consists entirely of white space characters)
- Internal substrings of one or more white space characters are
converted to a single space in non-hexadecimal
attribute values
- Relative Distinguished Names containing more than one
Attribute Value Assertion (AVA) are output in the
following order: an alphabetical ordering of AVAs
containing standard keywords, followed by a numeric
ordering of AVAs containing OID keywords.
- The only characters in attribute values that are escaped are
those which section 2.4 of RFC 2253 states must be escaped
(they are escaped using a preceding backslash character)
- The entire name is converted to upper case
using
String.toUpperCase(Locale.US)
- The entire name is converted to lower case
using
String.toLowerCase(Locale.US)
- The name is finally normalized using normalization form KD,
as described in the Unicode Standard and UAX #15
Additional standard formats may be introduced in the future.
Parameters: format - the format to use a string representation of this X500Principal using the specified format throws: IllegalArgumentException - if the specified format is invalidor null |
getName | public String getName(String format, Map<String, String> oidMap)(Code) | | Returns a string representation of the X.500 distinguished name
using the specified format. Valid values for the format are
"RFC1779" and "RFC2253" (case insensitive). "CANONICAL" is not
permitted and an IllegalArgumentException will be thrown.
This method returns Strings in the format as specified in
X500Principal.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.
Parameters: format - the format to use Parameters: oidMap - an OID map, where each key is an object identifier inString form (a sequence of nonnegative integers separated by periods)that maps to a corresponding attribute type keyword String.The map may be empty but never null . a string representation of this X500Principal using the specified format throws: IllegalArgumentException - if the specified format is invalid, null, or an OID in the name maps to an improperly specified keyword throws: NullPointerException - if oidMap is null since: 1.6 |
hashCode | public int hashCode()(Code) | | Return a hash code for this X500Principal .
The hash code is calculated via:
getName(X500Principal.CANONICAL).hashCode()
a hash code for this X500Principal |
toString | public String toString()(Code) | | Return a user-friendly string representation of this
X500Principal .
a string representation of this X500Principal |
|
|