Package org.ldaptive.handler

Class DnAttributeEntryHandler

java.lang.Object

org.ldaptive.transport.MessageFunctional<Q,S>

org.ldaptive.transport.MessageFunctional.Function<SearchRequest,SearchResponse,T,T>

org.ldaptive.handler.AbstractEntryHandler<LdapEntry>

org.ldaptive.handler.DnAttributeEntryHandler

All Implemented Interfaces:

Function<LdapEntry,LdapEntry>, LdapEntryHandler

public class DnAttributeEntryHandler
extends AbstractEntryHandler<LdapEntry>
implements LdapEntryHandler

Adds the entry DN as an attribute to the result set. Provides a client side implementation of RFC 5020.

Nested Class Summary

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 boolean	addIfExists	Whether to add the entry dn if an attribute of the same name exists.
private String	dnAttributeName	Attribute name for the entry dn.
private static int	HASH_CODE_SEED	hash code seed.

Fields inherited from class org.ldaptive.handler.AbstractEntryHandler

logger

Constructor Summary

Constructors

Constructor	Description
DnAttributeEntryHandler()

Method Summary

Modifier and Type	Method	Description
LdapEntry	apply(LdapEntry entry)
boolean	equals(Object o)
String	getDnAttributeName()	Returns the DN attribute name.
protected void	handleAttributes(LdapEntry entry)	Handle the attributes of a search entry.
int	hashCode()
boolean	isAddIfExists()	Returns whether to add the entryDN if an attribute of the same name exists.
void	setAddIfExists(boolean b)	Sets whether to add the entryDN if an attribute of the same name exists.
void	setDnAttributeName(String name)	Sets the DN attribute name.
String	toString()

Methods inherited from class org.ldaptive.handler.AbstractEntryHandler

handleAttribute, handleAttributeName, handleAttributeValue, handleAttributeValue, handleDn, 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 Detail

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

Constant Field Values

dnAttributeName

private String dnAttributeName

Attribute name for the entry dn.

addIfExists

private boolean addIfExists

Whether to add the entry dn if an attribute of the same name exists.

Constructor Detail

DnAttributeEntryHandler

public DnAttributeEntryHandler()

Method Detail

getDnAttributeName

public String getDnAttributeName()

Returns the DN attribute name.

Returns:

DN attribute name

setDnAttributeName

public void setDnAttributeName(String name)

Sets the DN attribute name.

Parameters:

name - of the DN attribute

isAddIfExists

public boolean isAddIfExists()

Returns whether to add the entryDN if an attribute of the same name exists.

Returns:

whether to add the entryDN if an attribute of the same name exists

setAddIfExists

public void setAddIfExists(boolean b)

Sets whether to add the entryDN if an attribute of the same name exists.

Parameters:

b - whether to add the entryDN if an attribute of the same name exists

apply

public LdapEntry apply(LdapEntry entry)

Specified by:

apply in interface Function<LdapEntry,LdapEntry>

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

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