org.apache.directory.api.ldap.model.filter

Class FilterEncoder

java.lang.Object

org.apache.directory.api.ldap.model.filter.FilterEncoder

public final class FilterEncoder
extends java.lang.Object

An encoder for LDAP filters.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
private	FilterEncoder()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	encodeFilterValue(java.lang.String value) Handles encoding of special characters in LDAP search filter assertion values using the <valueencoding> rule as described in RFC 4515.
static java.lang.String	format(java.lang.String filterTemplate, java.lang.String... values) Formats a filter and handles encoding of special characters in the value arguments using the <valueencoding> rule as described in RFC 4515.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

private static final java.lang.String[] EMPTY

Constructor Detail

FilterEncoder

private FilterEncoder()

Method Detail

format

public static java.lang.String format(java.lang.String filterTemplate,
                                      java.lang.String... values)
                               throws java.lang.IllegalArgumentException

Formats a filter and handles encoding of special characters in the value arguments using the <valueencoding> rule as described in RFC 4515.

Example of filter template format: (&(cn={0})(uid={1}))

Parameters:

filterTemplate - the filter with placeholders

values - the values to encode and substitute

Returns:

the formatted filter with escaped values

Throws:

java.lang.IllegalArgumentException - if the number of values does not match the number of placeholders in the template

encodeFilterValue

public static java.lang.String encodeFilterValue(java.lang.String value)

Handles encoding of special characters in LDAP search filter assertion values using the <valueencoding> rule as described in RFC 4515.

Parameters:

value - Right hand side of "attrId=value" assertion occurring in an LDAP search filter.

Returns:

Escaped version of value