Package org.cryptacular.x509.dn

Class LdapNameFormatter

java.lang.Object

org.cryptacular.x509.dn.LdapNameFormatter

All Implemented Interfaces:

NameFormatter

public class LdapNameFormatter
extends Object
implements NameFormatter

Produces a string representation of an X.500 distinguished name using the process described in section 2 of RFC 2253, LADPv3 Distinguished Names.

Field Summary

Fields

Modifier and Type	Field	Description
static final char	ATV_SEPARATOR	Separator character between ATV components in the same RDN element.
private static final HexEncoder	ENCODER	Handles hex encoding.
static final char	ESCAPE_CHAR	Escape character.
static final char	RDN_SEPARATOR	Separator character between RDN components.
static final String	RESERVED_CHARS	String of characters that need to be escaped.

Constructor Summary

Constructors

Constructor	Description
LdapNameFormatter()

Method Summary

Modifier and Type	Method	Description
private static void	encode(String value, StringBuilder output)	Appends the given value to the output using the HEX encoding method described in section 2.4.
private static void	escape(String value, StringBuilder output)	Appends the given value to the output with proper character escaping.
String	format(X500Principal dn)	Produces a string representation of the given X.500 principal.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

RDN_SEPARATOR

public static final char RDN_SEPARATOR

Separator character between RDN components.

See Also:

• Constant Field Values

ATV_SEPARATOR

public static final char ATV_SEPARATOR

Separator character between ATV components in the same RDN element.

See Also:

• Constant Field Values

ESCAPE_CHAR

public static final char ESCAPE_CHAR

Escape character.

See Also:

• Constant Field Values

RESERVED_CHARS

public static final String RESERVED_CHARS

String of characters that need to be escaped.

See Also:

• Constant Field Values

ENCODER

private static final HexEncoder ENCODER

Handles hex encoding.

Constructor Details

LdapNameFormatter

public LdapNameFormatter()

Method Details

format

public String format(X500Principal dn)

Description copied from interface: NameFormatter

Produces a string representation of the given X.500 principal.

Specified by:

format in interface NameFormatter

Parameters:

dn - Distinguished name as an X.500 principal.

Returns:

String representation of DN.

escape

private static void escape(String value,
 StringBuilder output)

Appends the given value to the output with proper character escaping.

Parameters:

value - Value to escape.

output - String builder where escaped value is written.

encode

private static void encode(String value,
 StringBuilder output)

Appends the given value to the output using the HEX encoding method described in section 2.4.

Parameters:

value - Value to encode.

output - String builder where encoded value is written.