Package org.ldaptive.schema

Class SchemaUtils

java.lang.Object

org.ldaptive.schema.SchemaUtils

public final class SchemaUtils
extends Object

Provides utility methods for this package.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SchemaUtils()	Default constructor.

Method Summary

Modifier and Type	Method	Description
private static void	encodeDescriptor(StringBuilder sb, String descr)	Encodes the supplied descriptor.
static String	formatDescriptors(String... descrs)	Returns a formatted string to describe the supplied descriptors.
static String	formatNumbers(int... numbers)	Returns a formatted string to describe the supplied numbers.
static String	formatOids(String... oids)	Returns a formatted string to describe the supplied OIDs.
static LdapEntry	getLdapEntry(ConnectionFactory factory, String dn, String filter, String... retAttrs)	Searches for the supplied dn and returns its ldap entry.
static String[]	parseDescriptors(String descrs)	Parses the supplied descriptors string and returns its contents as a string array.
static int[]	parseNumbers(String numbers)	Parses the supplied number string and returns its contents as a string array.
static String[]	parseOIDs(String oids)	Parses the supplied OID string and returns its contents as a string array.
static String	parseQDString(String value)	Returns a string with any HEX escaped characters encoded.

Methods inherited from class java.lang.Object

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

Constructor Details

SchemaUtils

private SchemaUtils()

Default constructor.

Method Details

parseDescriptors

public static String[] parseDescriptors(String descrs)

Parses the supplied descriptors string and returns its contents as a string array. If the string contains a single quote it is assumed to be a multivalue descriptor of the form "'value1' 'value2' 'value3'". Otherwise, it is treated as a single value descriptor.

Parameters:

descrs - string to parse

Returns:

array of descriptors

parseQDString

public static String parseQDString(String value)

Returns a string with any HEX escaped characters encoded.

Parameters:

value - to parse

Returns:

parsed value

parseOIDs

public static String[] parseOIDs(String oids)

Parses the supplied OID string and returns its contents as a string array. If the string contains a dollar sign it is assumed to be a multivalue OID of the form "value1 $ value2 $ value3". Otherwise, it is treated as a single value OID.

Parameters:

oids - string to parse

Returns:

array of oids

parseNumbers

public static int[] parseNumbers(String numbers)

Parses the supplied number string and returns its contents as a string array.

Parameters:

numbers - string to parse

Returns:

array of numbers

formatDescriptors

public static String formatDescriptors(String... descrs)

Returns a formatted string to describe the supplied descriptors.

Parameters:

descrs - to format

Returns:

formatted string

encodeDescriptor

private static void encodeDescriptor(StringBuilder sb,
 String descr)

Encodes the supplied descriptor. Hex encodes non-printable ASCII, including backslash and single quote.

Parameters:

sb - to append encoded descriptor to

descr - to encode

formatOids

public static String formatOids(String... oids)

Returns a formatted string to describe the supplied OIDs.

Parameters:

oids - to format

Returns:

formatted string

formatNumbers

public static String formatNumbers(int... numbers)

Returns a formatted string to describe the supplied numbers.

Parameters:

numbers - to format

Returns:

formatted string

getLdapEntry

public static LdapEntry getLdapEntry(ConnectionFactory factory,
 String dn,
 String filter,
 String... retAttrs)
                              throws LdapException

Searches for the supplied dn and returns its ldap entry.

Parameters:

factory - to obtain an LDAP connection from

dn - to search for

filter - search filter

retAttrs - attributes to return

Returns:

ldap entry

Throws:

LdapException - if the search fails