org.ldaptive.handler

Class DnAttributeEntryHandler

java.lang.Object

org.ldaptive.handler.AbstractSearchEntryHandler

org.ldaptive.handler.DnAttributeEntryHandler

All Implemented Interfaces:

Handler<SearchRequest,SearchEntry>, SearchEntryHandler

public class DnAttributeEntryHandler
extends AbstractSearchEntryHandler

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

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	addIfExists Whether to add the entry dn if an attribute of the same name exists.
private java.lang.String	dnAttributeName Attribute name for 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
DnAttributeEntryHandler()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDnAttributeName() Returns the DN attribute name.
protected void	handleAttributes(Connection conn, SearchRequest request, SearchEntry 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(java.lang.String name) Sets the DN attribute name.
java.lang.String	toString()

Methods inherited from class org.ldaptive.handler.AbstractSearchEntryHandler

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

dnAttributeName

private java.lang.String dnAttributeName

Attribute name for the entry dn. The default value of this variable is .

addIfExists

private boolean addIfExists

Whether to add the entry dn if an attribute of the same name exists. The default value of this variable is .

Constructor Detail

DnAttributeEntryHandler

public DnAttributeEntryHandler()

Method Detail

getDnAttributeName

public java.lang.String getDnAttributeName()

Returns the DN attribute name.

Returns:

DN attribute name

setDnAttributeName

public void setDnAttributeName(java.lang.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

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

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractSearchEntryHandler

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object