RDN (6.0 API Documentation)

java.lang.Object
- iaik.asn1.structures.RDN

All Implemented Interfaces:

ASN1Type
```
public class RDN
extends java.lang.Object
implements ASN1Type
```
This class implements the ASN.1 type RelativeDistinguishedName.
A Distinguished Name is used to specify a path within a X.500 directory information tree. A distinguished name is defined as a sequence of relative distinguished names, where a relative distinguished name is defined as follows:
```
 RelativeDistinguishedName ::= SET OF AttributeValueAssertion

 AttributeValueAssertion ::= SEQUENCE {
  AttributeType    OBJECT IDENTIFIER,
  AttributeValue   ANY
 }
 
```
Note that some (newer) standards (e.g. RFC 5280) use the term AttributeTypeAndValue instead of AttributeValueAssertion; the ASN.1 syntax is the same:
```
 RelativeDistinguishedName ::= SET OF AttributeTypeAndValue

 AttributeTypeAndValue ::= SEQUENCE {
  AttributeType    AttributeType,
  AttributeValue   AttributeValue
 }
 
 AttributeType ::= OBJECT IDENTIFIER

 AttributeValue ::= ANY -- DEFINED BY AttributeType
 
```
You may directly supply a AttributeValueAssertion (AVA) when creating a RelativeDistinguishedName object, or (and) you may use the addAVA method for later adding some AVA, e.g.:
```
 RDN rel_dis_name = new RDN(ObjectID.country, "AT");
 rel_dis_name.addAVA(ObjectID.locality, "Graz");
 
```
When specifying issuer or subject within a X.509 certificate by a distinguished name composed of relative distinguished names, it is recommended that each set of AttributeValueAssertions constituting a RelativeDistinguishedName only should contain one element.
Version:

File Revision 30

See Also:
Name, AVA

Field Summary

Fields
Modifier and Type Field and Description

protected java.util.Vector avas
Repository for AttributeValueAssertion objects.

Fields
Modifier and Type	Field and Description
`protected java.util.Vector`	`avas` Repository for AttributeValueAssertion objects.

Constructor Summary

Constructors
Constructor and Description
`RDN()` Creates an empty RelativeDistinguishedName.
`RDN(ASN1Object obj)` Creates a RelativeDistinguishedName from an ASN1Object.
`RDN(ObjectID oid, java.lang.Object value)` Creates a new RelativeDistinguishedName for one AVA.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAVA(AVA ava)` Adds a AttributeValueAssertion (AttributeTypeAndValue) object to this RelativeDistinguishedName.
`void`	`addAVA(AVA ava, boolean replace)` Adds a AttributeValueAssertion (AttributeTypeAndValue) object to this RelativeDistinguishedName.
`void`	`addAVA(ObjectID oid, java.lang.Object value)` Creates a new AttributeValueAssertion (AttributeTypeAndValue) with given type and value and adds it to this RelativeDistinguishedName.
`void`	`decode(ASN1Object obj)` Decodes a RelativeDistinguishedName from the given ASN1Object.
`java.util.Enumeration`	`elements()` Returns an enumeration of the AVAs in this RDN.
`boolean`	`equals(java.lang.Object obj)` Compares two RelativeDistinguishedNames.
`AVA`	`getAVA()` This method returns one AVA.
`AVA`	`getAVA(ObjectID oid)` Returns an AttributeValueAssertion (AttributeTypeAndValue) of given type from this RelativeDistinguishedName.
`AVA[]`	`getAVAs()` Returns an array containing the AVAs of this RDN.
`AVA[]`	`getAVAs(ObjectID oid)` Returns all AttributeValueAssertion (AttributeTypeAndValue) objects of given type from this RelativeDistinguishedName.
`java.lang.String`	`getRFC2253String()` Returns a string representation of this RDN according to RFC 2253.
`java.lang.String`	`getRFC2253String(boolean strictEscaping)` Returns a string representation of this RDN according to RFC 2253.
`int`	`hashCode()` Returns the hashcode for this RDN.
`ASN1Object`	`toASN1Object()` Returns the RelativeDistinguishedName as an ASN1Object.
`java.lang.String`	`toString()` Returns a string that represents the contents of this RDN.
`java.lang.String`	`toString(boolean detailed)` Returns a string that represents the contents of this RDN.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - avas
```
protected java.util.Vector avas
```
    Repository for AttributeValueAssertion objects.
- Constructor Detail
  - RDN
```
public RDN()
```
    Creates an empty RelativeDistinguishedName.
  - RDN
```
public RDN(ObjectID oid,
   java.lang.Object value)
```
    Creates a new RelativeDistinguishedName for one AVA. Further AttributeValueAssertion (AttributeTypeAndValue) objects may be added by using a proper addAVA method.
    
    Parameters:
    oid - the type (object ID) of the AVA to be added
    value - the value of the AVA to be added
  - RDN
```
public RDN(ASN1Object obj)
    throws CodingException
```
    Creates a RelativeDistinguishedName from an ASN1Object.
    The supplied ASN1Object represents an already existing RDN that may have been created by means of the toASN1Object method.
    
    Parameters:
    obj - the RelativeDistinguishedName as ASN1Object
    
    Throws:
    
    CodingException - if this ASN1Object could not be parsed
- Method Detail
  - decode
```
public void decode(ASN1Object obj)
            throws CodingException
```
    Decodes a RelativeDistinguishedName from the given ASN1Object.
    The supplied ASN1Object represents an already existing RDN object that may have been created by means of the toASN1Object() method.
    
    Specified by:
    
    decode in interface ASN1Type
    
    Parameters:
    obj - the RDN as ASN1Object
    
    Throws:
    
    CodingException - if the ASN1Object has the wrong format
  - toASN1Object
```
public ASN1Object toASN1Object()
```
    Returns the RelativeDistinguishedName as an ASN1Object.
    
    Specified by:
    
    toASN1Object in interface ASN1Type
    
    Returns:
    the RelativeDistinguishedName as ASN1Object
  - addAVA
```
public void addAVA(ObjectID oid,
          java.lang.Object value)
```
    Creates a new AttributeValueAssertion (AttributeTypeAndValue) with given type and value and adds it to this RelativeDistinguishedName. If an AVA of the given type already is included, it will be replaced by the new AVA. If you do not want to replace an already existing AVA with the same type use method addAVA(AVA ava, boolean replace), e.g.:
```
 RDN rdn = ...;
 AVA ava = new AVA(ObjectID.organization, "IAIK");
 boolean replace = false;
 rdn.addAVA(ava, replace);
 
```
    Parameters:
    oid - the attribute type of the AVA to be added, as object ID
    value - the attribute value
  - addAVA
```
public void addAVA(AVA ava)
```
    Adds a AttributeValueAssertion (AttributeTypeAndValue) object to this RelativeDistinguishedName.
    If an AVA of the same type already is included, it will be replaced by the new AVA. If you do not want to replace an already existing AVA with the same type use method addAVA(AVA ava, boolean replace), e.g.:
```
 RDN rdn = ...;
 AVA ava = new AVA(ObjectID.organization, "IAIK");
 boolean replace = false;
 rdn.addAVA(ava, replace);
 
```
    Parameters:
    ava - the AttributeValueAssertion (AttributeTypeAndValue) to add
  - addAVA
```
public void addAVA(AVA ava,
          boolean replace)
```
    Adds a AttributeValueAssertion (AttributeTypeAndValue) object to this RelativeDistinguishedName. Depending on the value of the replace parameter the new AVA will replace an already existing AVA with the same type or will be added to the set of AVAs.
    
    Parameters:
    ava - the AttributeValueAssertion (AttributeTypeAndValue) to add
    replace - whether to replace an already existing AVA with the same type or to add the new AVA add the end of the set of AVAs
  - getAVA
```
public AVA getAVA(ObjectID oid)
```
    Returns an AttributeValueAssertion (AttributeTypeAndValue) of given type from this RelativeDistinguishedName. If more than one AVA of the same type are included, only the first one is returned.
    
    Parameters:
    oid - the type of the AVA to be searched for, as ObjectID
    
    Returns:
    the AVA with the requested type or null if no AVA with the given type is included
  - getAVAs
```
public AVA[] getAVAs(ObjectID oid)
```
    Returns all AttributeValueAssertion (AttributeTypeAndValue) objects of given type from this RelativeDistinguishedName.
    
    Parameters:
    oid - the type of the AVA to be searched for, as ObjectID
    
    Returns:
    an array of AVAs with the requested type; the array may be empty if no AVAs with the given type are included
  - getAVA
```
public AVA getAVA()
```
    This method returns one AVA.
    
    Returns:
    the first AVA
  - elements
```
public java.util.Enumeration elements()
```
    Returns an enumeration of the AVAs in this RDN.
    
    Returns:
    an enumeration of the AVAs in this RDN
  - getAVAs
```
public AVA[] getAVAs()
```
    Returns an array containing the AVAs of this RDN.
    
    Returns:
    an array of the AVAs in this RDN
  - hashCode
```
public int hashCode()
```
    Returns the hashcode for this RDN.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    a hashcode for this RDN
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Compares two RelativeDistinguishedNames.
    The two RDNs are considered as being equal if they contain the same AVAs (in any order).
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    obj - the other RelativeDistinguishedName
    
    Returns:
    true, if the two RelativeDistinguishedNames are equal, false otherwise
  - toString
```
public java.lang.String toString()
```
    Returns a string that represents the contents of this RDN.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    the string representation
  - toString
```
public java.lang.String toString(boolean detailed)
```
    Returns a string that represents the contents of this RDN.
    
    Returns:
    the string representation
  - getRFC2253String
```
public java.lang.String getRFC2253String()
                                  throws RFC2253NameParserException
```
    Returns a string representation of this RDN according to RFC 2253.
    RFC 2253 specifies a string representation of Distinguished Names as used for LDAP lookups. This implementation is also compliant with the updated standard RFC 4514, which obsoleted RFC 2253.
    Each included AttributeTypeAndValue is represented as specified in sections 2.3, 2.4 of RFC 2253 (adjoining AttributeTypeAndValues (or AVAs) are separated by a plus ("+") character):
    The attribute type is represented as described in section 2.3 of RFC 2253. If there is no known name string for the attribute type a dotted-decimal encoding of the attribute type's identifier.
    The string representation of the attribute value is either a hexadecimal representation of its BER encoding (introduced by a "#" character) or based on the algorithm given in section 2.4 of RFC 2253 applying the following escaping mechanisms:
    - A space or "#" character at the beginning of the string is escaped.
    - A space at the end of the string is escaped.
    - Any of the characters ",", "+", """, "\", "<", ">" or ";" is escaped.
    Additionally this method escapes Any non printable ASCII (< 0x21 or > 0x7e) and any non-ASCII character by an hexadecimal representation of its UTF-8 encoding. The space character (0x21) only is escaped when appearing at the beginning or the end of the string.
    Returns:
    the string representation according to RFC 2253.
    
    Throws:
    
    RFC2253NameParserException - if the AVA cannot be represented according to the rules above
  - getRFC2253String
```
public java.lang.String getRFC2253String(boolean strictEscaping)
                                  throws RFC2253NameParserException
```
    Returns a string representation of this RDN according to RFC 2253.
    RFC 2253 specifies a string representation of Distinguished Names as used for LDAP lookups. This implementation is also compliant with the updated standard RFC 4514, which obsoleted RFC 2253.
    Each included AttributeTypeAndValue is represented as specified in sections 2.3, 2.4 of RFC 2253 (adjoining AttributeTypeAndValues (or AVAs) are separated by a plus ("+") character):
    The attribute type is represented as described in section 2.3 of RFC 2253. If there is no known name string for the attribute type a dotted-decimal encoding of the attribute type's identifier.
    The string representation of the attribute value is either a hexadecimal representation of its BER encoding (introduced by a "#" character) or based on the algorithm given in section 2.4 of RFC 2253 applying the following escaping mechanisms:
    - A space or "#" character at the beginning of the string is escaped.
    - A space at the end of the string is escaped.
    - The space character (0x21) only is escaped when appearing at the beginning or the end of the string.
    Additionally this method escapes any non printable ASCII (< 0x21 or > 0x7e) and any non-ASCII character by an hexadecimal representation of its UTF-8 encoding if strictEscaping is set to true
    Parameters:
    strictEscaping - whether to escape non printable ASCII (< 0x21 or > 0x7e) and non-ASCII characters by an hexadecimal representation of their UTF-8 encoding
    
    Returns:
    the string representation according to RFC 2253.
    
    Throws:
    
    RFC2253NameParserException - if the AVA cannot be represented according to the rules above

Class RDN

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

avas

Constructor Detail

RDN

RDN

RDN

Method Detail

decode

toASN1Object

addAVA

addAVA

addAVA

getAVA

getAVAs

getAVA

elements

getAVAs

hashCode

equals

toString

toString

getRFC2253String

getRFC2253String