org.sodeac.common.xuri.ldapfilter

Class LDAPFilterDecodingHandler

java.lang.Object

org.sodeac.common.xuri.ldapfilter.LDAPFilterDecodingHandler

All Implemented Interfaces:

Serializable, IDecodingExtensionHandler<IFilterItem>

public class LDAPFilterDecodingHandler
extends Object
implements IDecodingExtensionHandler<IFilterItem>, Serializable

XURI decoding extension handler to decode ldap filter items of type IFilterItem

Since:

1.0

Version:

1.0

Author:

Sebastian Palarus

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static char	CLOSER
static char[]	CLOSER_CHARACTERS
static char	ESCAPE
static char	OPENER
static char[]	OPENER_CHARACTERS

Constructor Summary

Constructors

Constructor and Description
LDAPFilterDecodingHandler()

Method Summary

Modifier and Type	Method and Description
IFilterItem	decodeFromString(String raw) decodes a string encoded extension to extension object of type T
ComponentType[]	getApplicableComponents()
char[]	getCloserCharacters(ComponentType component) setter for closer characters
static LDAPFilterDecodingHandler	getInstance()
char[]	getOpenerCharacters(ComponentType component) getter for opener characters
String	getType() extension type of decoding extension handler
int	openerCharactersMatched(ExtensionHandleObject extensionHandleObject) check if current position of parsed URI worker object is an special start sequence of extension
int	parseRawExtensionString(ExtensionHandleObject extensionHandleObject) parse a string encoded extension and set an extension object in extensionHandleObject

Methods inherited from class java.lang.Object

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

Field Detail

OPENER

public static final char OPENER

See Also:

Constant Field Values

CLOSER

public static final char CLOSER

See Also:

Constant Field Values

ESCAPE

public static final char ESCAPE

See Also:

Constant Field Values

OPENER_CHARACTERS

public static final char[] OPENER_CHARACTERS

CLOSER_CHARACTERS

public static final char[] CLOSER_CHARACTERS

Constructor Detail

LDAPFilterDecodingHandler

public LDAPFilterDecodingHandler()

Method Detail

getInstance

public static LDAPFilterDecodingHandler getInstance()

getType

public String getType()

Description copied from interface: IDecodingExtensionHandler

extension type of decoding extension handler

Specified by:

getType in interface IDecodingExtensionHandler<IFilterItem>

Returns:

getApplicableComponents

public ComponentType[] getApplicableComponents()

Specified by:

getApplicableComponents in interface IDecodingExtensionHandler<IFilterItem>

Returns:

applicable components for extension

parseRawExtensionString

public int parseRawExtensionString(ExtensionHandleObject extensionHandleObject)

Description copied from interface: IDecodingExtensionHandler

parse a string encoded extension and set an extension object in extensionHandleObject

Specified by:

parseRawExtensionString in interface IDecodingExtensionHandler<IFilterItem>

Parameters:

extensionHandleObject - worker object

Returns:

position after extension ends

openerCharactersMatched

public int openerCharactersMatched(ExtensionHandleObject extensionHandleObject)

Description copied from interface: IDecodingExtensionHandler

check if current position of parsed URI worker object is an special start sequence of extension

Specified by:

openerCharactersMatched in interface IDecodingExtensionHandler<IFilterItem>

Parameters:

extensionHandleObject - worker object

Returns:

-1, if current position is not special start sequence, otherwise first position of

decodeFromString

public IFilterItem decodeFromString(String raw)

Description copied from interface: IDecodingExtensionHandler

decodes a string encoded extension to extension object of type T

Specified by:

decodeFromString in interface IDecodingExtensionHandler<IFilterItem>

Parameters:

raw - string represents extension object

Returns:

decoded extension data object

getOpenerCharacters

public char[] getOpenerCharacters(ComponentType component)

getter for opener characters

Parameters:

component - applicable component

Returns:

opener characters

getCloserCharacters

public char[] getCloserCharacters(ComponentType component)

setter for closer characters

Parameters:

component - applicable component

Returns:

closer characters