org.apache.directory.api.ldap.model.ldif

Class LdifUtils

java.lang.Object

org.apache.directory.api.ldap.model.ldif.LdifUtils

public final class LdifUtils
extends java.lang.Object

Some LDIF helper methods.

Field Summary

Fields

Modifier and Type	Field and Description
private static int	DEFAULT_LINE_LENGTH The default length for a line in a ldif file
private static boolean[]	LDIF_SAFE_OTHER_CHARS_ALPHABET The array that will be used to match the other chars.
private static boolean[]	LDIF_SAFE_STARTING_CHAR_ALPHABET The array that will be used to match the first char.
private static java.lang.String	LINE_SEPARATOR The file separator

Constructor Summary

Constructors

Modifier	Constructor and Description
private	LdifUtils() Private constructor.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	convertAttributesToLdif(Entry entry) Convert all the Entry's attributes to LDIF.
static java.lang.String	convertAttributesToLdif(Entry entry, int length) Convert the Entry's attributes to LDIF.
static java.lang.String	convertToLdif(Attribute attr) Converts an EntryAttribute to LDIF
static java.lang.String	convertToLdif(Attribute attr, int length) Converts an EntryAttribute as LDIF
static java.lang.String	convertToLdif(javax.naming.directory.Attributes attrs) Convert an Attributes as LDIF
static java.lang.String	convertToLdif(javax.naming.directory.Attributes attrs, Dn dn) Convert an Attributes as LDIF.
static java.lang.String	convertToLdif(javax.naming.directory.Attributes attrs, Dn dn, int length) Convert an Attributes as LDIF.
static java.lang.String	convertToLdif(javax.naming.directory.Attributes attrs, int length) Convert an Attributes as LDIF
static java.lang.String	convertToLdif(Entry entry) Convert an Entry to LDIF
static java.lang.String	convertToLdif(Entry entry, boolean includeVersionInfo) Convert an Entry to LDIF including a version number at the top
static java.lang.String	convertToLdif(Entry entry, int length) Convert an Entry as LDIF
static java.lang.String	convertToLdif(LdifEntry entry) Convert an LdifEntry to LDIF
static java.lang.String	convertToLdif(LdifEntry entry, int length) Convert an LdifEntry to LDIF
static javax.naming.directory.Attributes	createJndiAttributes(java.lang.Object... avas) Build a new Attributes instance from a LDIF list of lines.
private static java.lang.String	encodeBase64(java.lang.String str) Base64 encode a String
static javax.naming.directory.Attributes	getJndiAttributesFromLdif(java.lang.String ldif) Convert a LDIF String to a JNDI attributes.
static boolean	isLDIFSafe(java.lang.String str) Checks if the input String contains only safe values, that is, the data does not need to be encoded for use with LDIF.
static java.lang.String	stripLineToNChars(java.lang.String str, int nbChars) Strips the String every n specified characters

Methods inherited from class java.lang.Object

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

Field Detail

LDIF_SAFE_STARTING_CHAR_ALPHABET

private static final boolean[] LDIF_SAFE_STARTING_CHAR_ALPHABET

The array that will be used to match the first char.

LDIF_SAFE_OTHER_CHARS_ALPHABET

private static final boolean[] LDIF_SAFE_OTHER_CHARS_ALPHABET

The array that will be used to match the other chars.

DEFAULT_LINE_LENGTH

private static final int DEFAULT_LINE_LENGTH

The default length for a line in a ldif file

See Also:

Constant Field Values

LINE_SEPARATOR

private static final java.lang.String LINE_SEPARATOR

The file separator

Constructor Detail

LdifUtils

private LdifUtils()

Private constructor.

Method Detail

isLDIFSafe

public static boolean isLDIFSafe(java.lang.String str)

Checks if the input String contains only safe values, that is, the data does not need to be encoded for use with LDIF. The rules for checking safety are based on the rules for LDIF (LDAP Data Interchange Format) per RFC 2849. The data does not need to be encoded if all the following are true: The data cannot start with the following char values:

• 00 (NUL)
• 10 (LF)
• 13 (CR)
• 32 (SPACE)
• 58 (:)
• 60 (<)
• Any character with value greater than 127

The data cannot contain any of the following char values:

• 00 (NUL)
• 10 (LF)
• 13 (CR)
• Any character with value greater than 127

The data cannot end with a space.

Parameters:

str - the String to be checked

Returns:

true if encoding not required for LDIF

convertToLdif

public static java.lang.String convertToLdif(javax.naming.directory.Attributes attrs)
                                      throws LdapException

Convert an Attributes as LDIF

Parameters:

attrs - the Attributes to convert

Returns:

the corresponding LDIF code as a String

Throws:

LdapException - If a naming exception is encountered.

convertToLdif

public static java.lang.String convertToLdif(javax.naming.directory.Attributes attrs,
                                             int length)
                                      throws LdapException

Convert an Attributes as LDIF

Parameters:

attrs - the Attributes to convert

length - The ldif line length

Returns:

the corresponding LDIF code as a String

Throws:

LdapException - If a naming exception is encountered.

convertToLdif

public static java.lang.String convertToLdif(javax.naming.directory.Attributes attrs,
                                             Dn dn,
                                             int length)
                                      throws LdapException

Convert an Attributes as LDIF. The Dn is written.

Parameters:

attrs - the Attributes to convert

dn - The Dn for this entry

length - The ldif line length

Returns:

the corresponding LDIF code as a String

Throws:

LdapException - If a naming exception is encountered.

convertToLdif

public static java.lang.String convertToLdif(javax.naming.directory.Attributes attrs,
                                             Dn dn)
                                      throws LdapException

Convert an Attributes as LDIF. The Dn is written.

Parameters:

attrs - the Attributes to convert

dn - The Dn for this entry

Returns:

the corresponding LDIF code as a String

Throws:

LdapException - If a naming exception is encountered.

convertToLdif

public static java.lang.String convertToLdif(Entry entry)
                                      throws LdapException

Convert an Entry to LDIF

Parameters:

entry - the Entry to convert

Returns:

the corresponding LDIF code as a String

Throws:

LdapException - If a naming exception is encountered.

convertToLdif

public static java.lang.String convertToLdif(Entry entry,
                                             boolean includeVersionInfo)
                                      throws LdapException

Convert an Entry to LDIF including a version number at the top

Parameters:

entry - the Entry to convert

includeVersionInfo - flag to tell whether to include version number or not

Returns:

the corresponding LDIF code as a String

Throws:

LdapException - If a naming exception is encountered.

convertAttributesToLdif

public static java.lang.String convertAttributesToLdif(Entry entry)
                                                throws LdapException

Convert all the Entry's attributes to LDIF. The Dn is not written

Parameters:

entry - the Entry to convert

Returns:

the corresponding LDIF code as a String

Throws:

LdapException - If a naming exception is encountered.

getJndiAttributesFromLdif

public static javax.naming.directory.Attributes getJndiAttributesFromLdif(java.lang.String ldif)
                                                                   throws LdapLdifException

Convert a LDIF String to a JNDI attributes.

Parameters:

ldif - The LDIF string containing an attribute value

Returns:

An Attributes instance

Throws:

LdapLdifException - If the LDIF String cannot be converted to an Attributes

convertToLdif

public static java.lang.String convertToLdif(Entry entry,
                                             int length)
                                      throws LdapException

Convert an Entry as LDIF

Parameters:

entry - the Entry to convert

length - the expected line length

Returns:

the corresponding LDIF code as a String

Throws:

LdapException - If a naming exception is encountered.

convertAttributesToLdif

public static java.lang.String convertAttributesToLdif(Entry entry,
                                                       int length)
                                                throws LdapException

Convert the Entry's attributes to LDIF. The Dn is not written.

Parameters:

entry - the Entry to convert

length - the expected line length

Returns:

the corresponding LDIF code as a String

Throws:

LdapException - If a naming exception is encountered.

convertToLdif

public static java.lang.String convertToLdif(LdifEntry entry)
                                      throws LdapException

Convert an LdifEntry to LDIF

Parameters:

entry - the LdifEntry to convert

Returns:

the corresponding LDIF as a String

Throws:

LdapException - If a naming exception is encountered.

convertToLdif

public static java.lang.String convertToLdif(LdifEntry entry,
                                             int length)
                                      throws LdapException

Convert an LdifEntry to LDIF

Parameters:

entry - the LdifEntry to convert

length - The maximum line's length

Returns:

the corresponding LDIF as a String

Throws:

LdapException - If a naming exception is encountered.

encodeBase64

private static java.lang.String encodeBase64(java.lang.String str)

Base64 encode a String

Parameters:

str - The string to encode

Returns:

the base 64 encoded string

convertToLdif

public static java.lang.String convertToLdif(Attribute attr)
                                      throws LdapException

Converts an EntryAttribute to LDIF

Parameters:

attr - the >EntryAttribute to convert

Returns:

the corresponding LDIF code as a String

Throws:

LdapException - If a naming exception is encountered.

convertToLdif

public static java.lang.String convertToLdif(Attribute attr,
                                             int length)
                                      throws LdapException

Converts an EntryAttribute as LDIF

Parameters:

attr - the EntryAttribute to convert

length - the expected line length

Returns:

the corresponding LDIF code as a String

Throws:

LdapException - If a naming exception is encountered.

stripLineToNChars

public static java.lang.String stripLineToNChars(java.lang.String str,
                                                 int nbChars)

Strips the String every n specified characters

Parameters:

str - the string to strip

nbChars - the number of characters

Returns:

the stripped String

createJndiAttributes

public static javax.naming.directory.Attributes createJndiAttributes(java.lang.Object... avas)
                                                              throws LdapException

Build a new Attributes instance from a LDIF list of lines. The values can be either a complete Ava, or a couple of AttributeType ID and a value (a String or a byte[]). The following sample shows the three cases :

 Attribute attr = AttributeUtils.createAttributes(
     "objectclass: top",
     "cn", "My name",
     "jpegPhoto", new byte[]{0x01, 0x02} );
 

Parameters:

avas - The AttributeType and Values, using a ldif format, or a couple of Attribute ID/Value

Returns:

An Attributes instance

Throws:

LdapException - If the data are invalid