org.ldaptive.handler

Class RecursiveEntryHandler

java.lang.Object

org.ldaptive.handler.AbstractSearchEntryHandler

org.ldaptive.handler.RecursiveEntryHandler

All Implemented Interfaces:

Handler<SearchRequest,SearchEntry>, SearchEntryHandler

public class RecursiveEntryHandler
extends AbstractSearchEntryHandler

This recursively searches based on a supplied attribute and merges those results into the original entry. For the following LDIF:

   dn: uugid=group1,ou=groups,dc=ldaptive,dc=org
   uugid: group1
   member: uugid=group2,ou=groups,dc=ldaptive,dc=org

   dn: uugid=group2,ou=groups,dc=ldaptive,dc=org
   uugid: group2
 

With the following code:

   RecursiveEntryHandler reh = new RecursiveEntryHandler("member", "uugid");
 

Will produce this result for the query (uugid=group1):

   dn: uugid=group1,ou=groups,dc=ldaptive,dc=org
   uugid: group1
   uugid: group2
   member: uugid=group2,ou=groups,dc=ldaptive,dc=org
 

Field Summary

Fields

Modifier and Type	Field and Description
private static int	HASH_CODE_SEED hash code seed.
private java.lang.String[]	mergeAttributes Attribute(s) to merge.
private java.lang.String[]	retAttrs Attributes to return when searching, mergeAttributes + searchAttribute.
private java.lang.String	searchAttribute Attribute to recursively search on.

Fields inherited from class org.ldaptive.handler.AbstractSearchEntryHandler

logger

Constructor Summary

Constructors

Constructor and Description
RecursiveEntryHandler() Default constructor.
RecursiveEntryHandler(java.lang.String searchAttr, java.lang.String... mergeAttrs) Creates a new recursive entry handler.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getMergeAttributes() Returns the attribute names that will be merged by the recursive search.
java.lang.String	getSearchAttribute() Returns the attribute name that will be recursively searched on.
HandlerResult<SearchEntry>	handle(Connection conn, SearchRequest request, SearchEntry entry) Handle the supplied result.
int	hashCode()
protected void	initalizeReturnAttributes() Initializes the return attributes array.
private void	readSearchAttribute(Connection conn, LdapEntry entry, java.util.List<java.lang.String> searchedDns) Reads the values of searchAttribute from the supplied attributes and calls recursiveSearch(org.ldaptive.Connection, java.lang.String, org.ldaptive.LdapEntry, java.util.List<java.lang.String>) for each.
private void	recursiveSearch(Connection conn, java.lang.String dn, LdapEntry entry, java.util.List<java.lang.String> searchedDns) Recursively gets the attribute(s) mergeAttributes for the supplied dn and adds the values to the supplied attributes.
void	setMergeAttributes(java.lang.String... mergeAttrs) Sets the attribute name that will be merged by the recursive search.
void	setSearchAttribute(java.lang.String name) Sets the attribute name that will be recursively searched on.
java.lang.String	toString()

Methods inherited from class org.ldaptive.handler.AbstractSearchEntryHandler

equals, handleAttribute, handleAttributeName, handleAttributes, 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

searchAttribute

private java.lang.String searchAttribute

Attribute to recursively search on.

mergeAttributes

private java.lang.String[] mergeAttributes

Attribute(s) to merge.

retAttrs

private java.lang.String[] retAttrs

Attributes to return when searching, mergeAttributes + searchAttribute.

Constructor Detail

RecursiveEntryHandler

public RecursiveEntryHandler()

Default constructor.

RecursiveEntryHandler

public RecursiveEntryHandler(java.lang.String searchAttr,
                             java.lang.String... mergeAttrs)

Creates a new recursive entry handler.

Parameters:

searchAttr - attribute to search on

mergeAttrs - attribute names to merge

Method Detail

getSearchAttribute

public java.lang.String getSearchAttribute()

Returns the attribute name that will be recursively searched on.

Returns:

attribute name

setSearchAttribute

public void setSearchAttribute(java.lang.String name)

Sets the attribute name that will be recursively searched on.

Parameters:

name - of the search attribute

getMergeAttributes

public java.lang.String[] getMergeAttributes()

Returns the attribute names that will be merged by the recursive search.

Returns:

attribute names

setMergeAttributes

public void setMergeAttributes(java.lang.String... mergeAttrs)

Sets the attribute name that will be merged by the recursive search.

Parameters:

mergeAttrs - attribute names to merge

initalizeReturnAttributes

protected void initalizeReturnAttributes()

Initializes the return attributes array. Must be called after both searchAttribute and mergeAttributes have been set.

handle

public HandlerResult<SearchEntry> handle(Connection conn,
                                         SearchRequest request,
                                         SearchEntry entry)
                                  throws LdapException

Description copied from interface: Handler

Handle the supplied result.

Specified by:

handle in interface Handler<SearchRequest,SearchEntry>

Specified by:

handle in interface SearchEntryHandler

Overrides:

handle in class AbstractSearchEntryHandler

Parameters:

conn - connection the operation was executed on

request - executed by the operation

entry - produced from the operation

Returns:

handler result

Throws:

LdapException - if handling fails

readSearchAttribute

private void readSearchAttribute(Connection conn,
                                 LdapEntry entry,
                                 java.util.List<java.lang.String> searchedDns)
                          throws LdapException

Reads the values of searchAttribute from the supplied attributes and calls recursiveSearch(org.ldaptive.Connection, java.lang.String, org.ldaptive.LdapEntry, java.util.List<java.lang.String>) for each.

Parameters:

conn - to perform search operation on

entry - to read

searchedDns - list of DNs whose attributes have been read

Throws:

LdapException - if a search error occurs

recursiveSearch

private void recursiveSearch(Connection conn,
                             java.lang.String dn,
                             LdapEntry entry,
                             java.util.List<java.lang.String> searchedDns)
                      throws LdapException

Recursively gets the attribute(s) mergeAttributes for the supplied dn and adds the values to the supplied attributes.

Parameters:

conn - to perform search operation on

dn - to get attribute(s) for

entry - to merge with

searchedDns - list of DNs that have been searched for

Throws:

LdapException - if a search error occurs

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractSearchEntryHandler

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object