public class

RDN

extends Object
java.lang.Object
   ↳ sun.security.x509.RDN

Class Overview

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.

Summary

Public Constructors
RDN(String name)
Constructs an RDN from its printable representation.
RDN(String name, Map<String, String> keywordMap)
Constructs an RDN from its printable representation.
RDN(AVA ava)
RDN(AVA[] avas)
Public Methods
List<AVA> avas()
Return an immutable List of the AVAs in this RDN.
boolean equals(Object obj)
Indicates whether some other object is "equal to" this one.
int hashCode()
Returns a hash code value for the object.
int size()
Return the number of AVAs in this RDN.
String toRFC1779String()
String toRFC1779String(Map<String, String> oidMap)
String toRFC2253String(boolean canonical)
String toRFC2253String()
String toRFC2253String(Map<String, String> oidMap)
String toString()
Returns a string representation of the object.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public RDN (String name)

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 form of RDN
Throws
IOException on parsing error

public RDN (String name, Map<String, String> keywordMap)

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 form of RDN
Throws
IOException on parsing error

public RDN (AVA ava)

public RDN (AVA[] avas)

Public Methods

public List<AVA> avas ()

Return an immutable List of the AVAs in this RDN.

public boolean equals (Object obj)

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
obj the reference object with which to compare.
Returns
  • true if this object is the same as the obj argument; false otherwise.

public int hashCode ()

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

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(Object) 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(java.lang.Object) 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 hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

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 (boolean canonical)

public String toRFC2253String ()

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

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: 

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

Returns
  • a string representation of the object.