org.ldaptive.handler

Class CaseChangeEntryHandler

java.lang.Object

org.ldaptive.handler.AbstractSearchEntryHandler

org.ldaptive.handler.CaseChangeEntryHandler

All Implemented Interfaces:

Handler<SearchRequest,SearchEntry>, SearchEntryHandler

public class CaseChangeEntryHandler
extends AbstractSearchEntryHandler

Provides the ability to modify the case of search entry DNs, attribute names, and attribute values.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CaseChangeEntryHandler.CaseChange Enum to define the type of case change.

Field Summary

Fields

Modifier and Type	Field and Description
private CaseChangeEntryHandler.CaseChange	attributeNameCaseChange Type of case modification to make to the attribute names.
private String[]	attributeNames Attribute names to modify.
private CaseChangeEntryHandler.CaseChange	attributeValueCaseChange Type of case modification to make to the attributes values.
private CaseChangeEntryHandler.CaseChange	dnCaseChange Type of case modification to make to the entry DN.
private static int	HASH_CODE_SEED hash code seed.

Fields inherited from class org.ldaptive.handler.AbstractSearchEntryHandler

logger

Constructor Summary

Constructors

Constructor and Description
CaseChangeEntryHandler()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
CaseChangeEntryHandler.CaseChange	getAttributeNameCaseChange() Returns the attribute name case change.
String[]	getAttributeNames() Returns the attribute names.
CaseChangeEntryHandler.CaseChange	getAttributeValueCaseChange() Returns the attribute value case change.
CaseChangeEntryHandler.CaseChange	getDnCaseChange() Returns the DN case change.
protected String	handleAttributeName(Connection conn, SearchRequest request, String name) Returns the supplied attribute name unaltered.
protected void	handleAttributes(Connection conn, SearchRequest request, SearchEntry entry) Handle the attributes of a search entry.
protected byte[]	handleAttributeValue(Connection conn, SearchRequest request, byte[] value) Returns the supplied attribute value unaltered.
protected String	handleAttributeValue(Connection conn, SearchRequest request, String value) Returns the supplied attribute value unaltered.
protected String	handleDn(Connection conn, SearchRequest request, SearchEntry entry) Handle the dn of a search entry.
int	hashCode()
void	setAttributeNameCaseChange(CaseChangeEntryHandler.CaseChange cc) Sets the attribute name case change.
void	setAttributeNames(String... names) Sets the attribute names.
void	setAttributeValueCaseChange(CaseChangeEntryHandler.CaseChange cc) Sets the attribute value case change.
void	setDnCaseChange(CaseChangeEntryHandler.CaseChange cc) Sets the DN case change.
String	toString()

Methods inherited from class org.ldaptive.handler.AbstractSearchEntryHandler

handle, handleAttribute, initializeRequest

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

Constant Field Values

dnCaseChange

private CaseChangeEntryHandler.CaseChange dnCaseChange

Type of case modification to make to the entry DN.

attributeNameCaseChange

private CaseChangeEntryHandler.CaseChange attributeNameCaseChange

Type of case modification to make to the attribute names.

attributeValueCaseChange

private CaseChangeEntryHandler.CaseChange attributeValueCaseChange

Type of case modification to make to the attributes values.

attributeNames

private String[] attributeNames

Attribute names to modify.

Constructor Detail

CaseChangeEntryHandler

public CaseChangeEntryHandler()

Method Detail

getDnCaseChange

public CaseChangeEntryHandler.CaseChange getDnCaseChange()

Returns the DN case change.

Returns:

case change

setDnCaseChange

public void setDnCaseChange(CaseChangeEntryHandler.CaseChange cc)

Sets the DN case change.

Parameters:

cc - case change

getAttributeNameCaseChange

public CaseChangeEntryHandler.CaseChange getAttributeNameCaseChange()

Returns the attribute name case change.

Returns:

case change

setAttributeNameCaseChange

public void setAttributeNameCaseChange(CaseChangeEntryHandler.CaseChange cc)

Sets the attribute name case change.

Parameters:

cc - case change

getAttributeValueCaseChange

public CaseChangeEntryHandler.CaseChange getAttributeValueCaseChange()

Returns the attribute value case change.

Returns:

case change

setAttributeValueCaseChange

public void setAttributeValueCaseChange(CaseChangeEntryHandler.CaseChange cc)

Sets the attribute value case change.

Parameters:

cc - case change

getAttributeNames

public String[] getAttributeNames()

Returns the attribute names.

Returns:

attribute names

setAttributeNames

public void setAttributeNames(String... names)

Sets the attribute names.

Parameters:

names - of the attributes

handleDn

protected String handleDn(Connection conn,
                          SearchRequest request,
                          SearchEntry entry)

Description copied from class: AbstractSearchEntryHandler

Handle the dn of a search entry.

Overrides:

handleDn in class AbstractSearchEntryHandler

Parameters:

conn - the search was performed on

request - used to find the search entry

entry - search entry to extract the dn from

Returns:

handled dn

handleAttributes

protected void handleAttributes(Connection conn,
                                SearchRequest request,
                                SearchEntry entry)
                         throws LdapException

Description copied from class: AbstractSearchEntryHandler

Handle the attributes of a search entry.

Overrides:

handleAttributes in class AbstractSearchEntryHandler

Parameters:

conn - the search was performed on

request - used to find the search entry

entry - search entry to extract the attributes from

Throws:

LdapException - if the LDAP returns an error

handleAttributeName

protected String handleAttributeName(Connection conn,
                                     SearchRequest request,
                                     String name)

Description copied from class: AbstractSearchEntryHandler

Returns the supplied attribute name unaltered.

Overrides:

handleAttributeName in class AbstractSearchEntryHandler

Parameters:

conn - the search was performed on

request - used to find the search entry

name - to handle

Returns:

handled name

handleAttributeValue

protected String handleAttributeValue(Connection conn,
                                      SearchRequest request,
                                      String value)

Description copied from class: AbstractSearchEntryHandler

Returns the supplied attribute value unaltered.

Overrides:

handleAttributeValue in class AbstractSearchEntryHandler

Parameters:

conn - the search was performed on

request - used to find the search entry

value - to handle

Returns:

handled value

handleAttributeValue

protected byte[] handleAttributeValue(Connection conn,
                                      SearchRequest request,
                                      byte[] value)

Description copied from class: AbstractSearchEntryHandler

Returns the supplied attribute value unaltered.

Overrides:

handleAttributeValue in class AbstractSearchEntryHandler

Parameters:

conn - the search was performed on

request - used to find the search entry

value - to handle

Returns:

handled value

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractSearchEntryHandler

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractSearchEntryHandler

toString

public String toString()

Overrides:

toString in class Object