org.ldaptive.handler.CaseChangeEntryHandler

All Implemented Interfaces:: Function<LdapEntry,LdapEntry>, LdapEntryHandler

public class CaseChangeEntryHandler extends AbstractEntryHandler<LdapEntry> implements LdapEntryHandler

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

Description

static enum

CaseChangeEntryHandler.CaseChange

Enum to define the type of case change.

Nested classes/interfaces inherited from class org.ldaptive.transport.MessageFunctional
MessageFunctional.BiConsumer<Q extends Request,S extends Result,T,U>, MessageFunctional.Consumer<Q extends Request,S extends Result,T>, MessageFunctional.Function<Q extends Request,S extends Result,T,R>
Field Summary

Fields

Modifier and Type

Field

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 final int

HASH_CODE_SEED

hash code seed.

Fields inherited from class org.ldaptive.handler.AbstractEntryHandler
logger
Constructor Summary

Constructors

Constructor

Description

CaseChangeEntryHandler()
Method Summary

Modifier and Type

Method

Description

LdapEntry

apply(LdapEntry entry)

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(String name)

Returns the supplied attribute name unaltered.

protected void

handleAttributes(LdapEntry entry)

Handle the attributes of a search entry.

protected byte[]

handleAttributeValue(byte[] value)

Returns the supplied attribute value unaltered.

protected String

handleAttributeValue(String value)

Returns the supplied attribute value unaltered.

protected String

handleDn(LdapEntry 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.AbstractEntryHandler
handleAttribute, handleEntry

Methods inherited from class org.ldaptive.transport.MessageFunctional
getConnection, getHandle, getRequest, setConnection, setHandle, setRequest

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Function
andThen, compose

Field Details
- 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 Details
- CaseChangeEntryHandler
  
  public CaseChangeEntryHandler()
Method Details
- 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
- apply
  
  public LdapEntry apply(LdapEntry entry)
  
  Specified by:
  
  apply in interface Function<LdapEntry,LdapEntry>
- handleDn
  
  protected String handleDn(LdapEntry entry)
  
  Description copied from class: AbstractEntryHandler
  
  Handle the dn of a search entry.
  
  Overrides:
  
  handleDn in class AbstractEntryHandler<LdapEntry>
  
  Parameters:
  
  entry - search entry to extract the dn from
  
  Returns:
  
  handled dn
- handleAttributes
  
  protected void handleAttributes(LdapEntry entry)
  
  Description copied from class: AbstractEntryHandler
  
  Handle the attributes of a search entry.
  
  Overrides:
  
  handleAttributes in class AbstractEntryHandler<LdapEntry>
  
  Parameters:
  
  entry - search entry to extract the attributes from
- handleAttributeName
  
  protected String handleAttributeName(String name)
  
  Description copied from class: AbstractEntryHandler
  
  Returns the supplied attribute name unaltered.
  
  Overrides:
  
  handleAttributeName in class AbstractEntryHandler<LdapEntry>
  
  Parameters:
  
  name - to handle
  
  Returns:
  
  handled name
- handleAttributeValue
  
  protected String handleAttributeValue(String value)
  
  Description copied from class: AbstractEntryHandler
  
  Returns the supplied attribute value unaltered.
  
  Overrides:
  
  handleAttributeValue in class AbstractEntryHandler<LdapEntry>
  
  Parameters:
  
  value - to handle
  
  Returns:
  
  handled value
- handleAttributeValue
  
  protected byte[] handleAttributeValue(byte[] value)
  
  Description copied from class: AbstractEntryHandler
  
  Returns the supplied attribute value unaltered.
  
  Overrides:
  
  handleAttributeValue in class AbstractEntryHandler<LdapEntry>
  
  Parameters:
  
  value - to handle
  
  Returns:
  
  handled value
- equals
  
  public boolean equals(Object o)
  
  Overrides:
  
  equals in class AbstractEntryHandler<LdapEntry>
- hashCode
  
  public int hashCode()
  
  Specified by:
  
  hashCode in class AbstractEntryHandler<LdapEntry>
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object

Class CaseChangeEntryHandler

Nested Class Summary

Nested classes/interfaces inherited from class org.ldaptive.transport.MessageFunctional

Field Summary

Fields inherited from class org.ldaptive.handler.AbstractEntryHandler

Constructor Summary

Method Summary

Methods inherited from class org.ldaptive.handler.AbstractEntryHandler

Methods inherited from class org.ldaptive.transport.MessageFunctional

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.function.Function

Field Details

HASH_CODE_SEED

dnCaseChange

attributeNameCaseChange

attributeValueCaseChange

attributeNames

Constructor Details

CaseChangeEntryHandler

Method Details

getDnCaseChange

setDnCaseChange

getAttributeNameCaseChange

setAttributeNameCaseChange

getAttributeValueCaseChange

setAttributeValueCaseChange

getAttributeNames

setAttributeNames

apply

handleDn

handleAttributes

handleAttributeName

handleAttributeValue

handleAttributeValue

equals

hashCode

toString