Top Description Fields Constructors Methods
sun.security.x509

public Class RDN

Additional top-level class in compilation unit: AVAComparator.

extends Object
Class Inheritance
Imports
java.io.IOException, .StringReader, java.util.Arrays, .StringJoiner, java.util.*, sun.security.util.*
RDNs are a set of {attribute = value} assertions. Some of those attributes are "distinguished" (unique w/in context). Order is never relevant. Some X.500 names include only a single distinguished attribute per RDN. This style is currently common. Note that DER-encoded RDNs sort AVAs by assertion OID ... so that when we parse this data we don't have to worry about canonicalizing it, but we'll need to sort them when we expose the RDN class more.

The ASN.1 for RDNs is: 

RelativeDistinguishedName ::=
  SET OF AttributeTypeAndValue

AttributeTypeAndValue ::= SEQUENCE {
  type     AttributeType,
  value    AttributeValue }

AttributeType ::= OBJECT IDENTIFIER

AttributeValue ::= ANY DEFINED BY AttributeType
Note that instances of this class are immutable.

Field Summary

Modifier and TypeField and Description
pack-priv final AVA[]
assertion

private volatile List<AVA>
avaList

private volatile String
canonicalString

Constructor Summary

AccessConstructor and Description
public
RDN(String
String form of RDN
name)

Constructs an RDN from its printable representation.

public
RDN(String
String form of RDN
name, Map<String, String>
an additional mapping of keywords to OIDs
keywordMap)

Constructs an RDN from its printable representation.

pack-priv
RDN(String name, String format)

pack-priv
RDN(String name, String format, Map<String, String> keywordMap)

pack-priv
RDN(DerValue rdn)

pack-priv
RDN(int i)

public
RDN(AVA ava)

public
RDN(AVA[] avas)

Method Summary

Modifier and TypeMethod and Description
public List<AVA>
avas()

Return an immutable List of the AVAs in this RDN.

pack-priv void
encode(DerOutputStream out)

public boolean
equals(Object
the reference object with which to compare.
obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

pack-priv DerValue
findAttribute(ObjectIdentifier oid)

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public int
size()

Return the number of AVAs in this RDN.

public String
toRFC1779String()

public String
toRFC1779String(Map<String, String> oidMap)

public String
toRFC2253String()

public String
toRFC2253String(Map<String, String> oidMap)

public String
toRFC2253String(boolean canonical)

private String
toRFC2253StringInternal(boolean canonical, Map<String, String> oidMap)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

assertionback to summary
pack-priv final AVA[] assertion
avaListback to summary
private volatile List<AVA> avaList
canonicalStringback to summary
private volatile String canonicalString

Constructor Detail

RDNback to summary
public RDN(String name) throws IOException

Constructs an RDN from its printable representation. An RDN may consist of one or multiple Attribute Value Assertions (AVAs), using '+' as a separator. If the '+' should be considered part of an AVA value, it must be preceded by '\'.

Parameters
name:String

String form of RDN

Exceptions
IOException:
on parsing error
RDNback to summary
public RDN(String name, Map<String, String> keywordMap) throws IOException

Constructs an RDN from its printable representation. An RDN may consist of one or multiple Attribute Value Assertions (AVAs), using '+' as a separator. If the '+' should be considered part of an AVA value, it must be preceded by '\'.

Parameters
name:String

String form of RDN

keywordMap:Map<String, String>

an additional mapping of keywords to OIDs

Exceptions
IOException:
on parsing error
RDNback to summary
pack-priv RDN(String name, String format) throws IOException
RDNback to summary
pack-priv RDN(String name, String format, Map<String, String> keywordMap) throws IOException
RDNback to summary
pack-priv RDN(DerValue rdn) throws IOException
RDNback to summary
pack-priv RDN(int i)
RDNback to summary
public RDN(AVA ava)
RDNback to summary
public RDN(AVA[] avas)

Method Detail

avasback to summary
public List<AVA> avas()

Return an immutable List of the AVAs in this RDN.

encodeback to summary
pack-priv void encode(DerOutputStream out)
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

findAttributeback to summary
pack-priv DerValue findAttribute(ObjectIdentifier oid)
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

sizeback to summary
public int size()

Return the number of AVAs in this RDN.

toRFC1779Stringback to summary
public String toRFC1779String()
toRFC1779Stringback to summary
public String toRFC1779String(Map<String, String> oidMap)
toRFC2253Stringback to summary
public String toRFC2253String()
toRFC2253Stringback to summary
public String toRFC2253String(Map<String, String> oidMap)
toRFC2253Stringback to summary
public String toRFC2253String(boolean canonical)
toRFC2253StringInternalback to summary
private String toRFC2253StringInternal(boolean canonical, Map<String, String> oidMap)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object