org.ldaptive

Class SearchRequest

java.lang.Object

org.ldaptive.AbstractRequest

org.ldaptive.SearchRequest

All Implemented Interfaces:

Message<RequestControl>, Request

Direct Known Subclasses:

AbstractSearchExecutor, SearchExecutor

public class SearchRequest
extends AbstractRequest

Contains the data required to perform an ldap search operation.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	baseDn DN to search.
private java.lang.String[]	binaryAttrs Binary attribute names.
private DerefAliases	derefAliases How to handle aliases.
private SearchEntryHandler[]	entryHandlers Ldap entry handlers.
private static int	HASH_CODE_SEED hash code seed.
private SearchReferenceHandler[]	referenceHandlers Search reference handlers.
private java.lang.String[]	retAttrs Attributes to return.
private SearchFilter	searchFilter Search filter to execute.
private SearchScope	searchScope Search scope.
private long	sizeLimit Number of entries to return.
private SortBehavior	sortBehavior Sort behavior of results.
private long	timeLimit Time search operation will block.
private boolean	typesOnly Whether to return only attribute types.

Constructor Summary

Constructors

Constructor and Description
SearchRequest() Default constructor.
SearchRequest(java.lang.String dn, SearchFilter filter) Creates a new search request.
SearchRequest(java.lang.String dn, SearchFilter filter, java.lang.String... attrs) Creates a new search request.
SearchRequest(java.lang.String dn, java.lang.String filter) Creates a new search request.
SearchRequest(java.lang.String dn, java.lang.String filter, java.lang.String... attrs) Creates a new search request.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getBaseDn() Returns the base DN.
java.lang.String[]	getBinaryAttributes() Returns names of binary attributes.
DerefAliases	getDerefAliases() Returns how to dereference aliases.
java.lang.String[]	getReturnAttributes() Returns the search return attributes.
SearchEntryHandler[]	getSearchEntryHandlers() Returns the search entry handlers.
SearchFilter	getSearchFilter() Returns the search filter.
SearchReferenceHandler[]	getSearchReferenceHandlers() Returns the search reference handlers.
SearchScope	getSearchScope() Gets the search scope.
long	getSizeLimit() Returns the size limit.
SortBehavior	getSortBehavior() Returns the sort behavior.
long	getTimeLimit() Returns the time limit.
boolean	getTypesOnly() Returns whether to return only attribute types.
int	hashCode()
static SearchRequest	newObjectScopeSearchRequest(java.lang.String dn) Returns a search request initialized for use with an object level search scope.
static SearchRequest	newObjectScopeSearchRequest(java.lang.String dn, java.lang.String[] attrs) Returns a search request initialized for use with an object level search scope.
static SearchRequest	newObjectScopeSearchRequest(java.lang.String dn, java.lang.String[] attrs, SearchFilter filter) Returns a search request initialized for use with an object level search scope.
protected static SearchRequest	newSearchRequest(SearchRequest request) Returns a search request initialized with the supplied request.
void	setBaseDn(java.lang.String dn) Sets the base DN.
void	setBinaryAttributes(java.lang.String... attrs) Sets names of binary attributes.
void	setDerefAliases(DerefAliases da) Sets how to dereference aliases.
void	setReturnAttributes(java.lang.String... attrs) Sets the search return attributes.
void	setSearchEntryHandlers(SearchEntryHandler... handlers) Sets the search entry handlers.
void	setSearchFilter(SearchFilter filter) Sets the search filter.
void	setSearchReferenceHandlers(SearchReferenceHandler... handlers) Sets the search reference handlers.
void	setSearchScope(SearchScope scope) Sets the search scope.
void	setSizeLimit(long limit) Sets the size limit.
void	setSortBehavior(SortBehavior sb) Sets the sort behavior.
void	setTimeLimit(long limit) Sets the time limit.
void	setTypesOnly(boolean b) Sets whether to return only attribute types.
java.lang.String	toString()

Methods inherited from class org.ldaptive.AbstractRequest

getControls, getIntermediateResponseHandlers, getReferralHandler, setControls, setIntermediateResponseHandlers, setReferralHandler

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

baseDn

private java.lang.String baseDn

DN to search.

searchFilter

private SearchFilter searchFilter

Search filter to execute.

retAttrs

private java.lang.String[] retAttrs

Attributes to return.

searchScope

private SearchScope searchScope

Search scope.

timeLimit

private long timeLimit

Time search operation will block.

sizeLimit

private long sizeLimit

Number of entries to return.

derefAliases

private DerefAliases derefAliases

How to handle aliases.

typesOnly

private boolean typesOnly

Whether to return only attribute types.

binaryAttrs

private java.lang.String[] binaryAttrs

Binary attribute names.

sortBehavior

private SortBehavior sortBehavior

Sort behavior of results.

entryHandlers

private SearchEntryHandler[] entryHandlers

Ldap entry handlers.

referenceHandlers

private SearchReferenceHandler[] referenceHandlers

Search reference handlers.

Constructor Detail

SearchRequest

public SearchRequest()

Default constructor.

SearchRequest

public SearchRequest(java.lang.String dn,
                     SearchFilter filter)

Creates a new search request.

Parameters:

dn - to search

filter - search filter

SearchRequest

public SearchRequest(java.lang.String dn,
                     SearchFilter filter,
                     java.lang.String... attrs)

Creates a new search request.

Parameters:

dn - to search

filter - search filter

attrs - to return

SearchRequest

public SearchRequest(java.lang.String dn,
                     java.lang.String filter)

Creates a new search request.

Parameters:

dn - to search

filter - search filter

SearchRequest

public SearchRequest(java.lang.String dn,
                     java.lang.String filter,
                     java.lang.String... attrs)

Creates a new search request.

Parameters:

dn - to search

filter - search filter

attrs - to return

Method Detail

getBaseDn

public java.lang.String getBaseDn()

Returns the base DN.

Returns:

base DN

setBaseDn

public void setBaseDn(java.lang.String dn)

Sets the base DN.

Parameters:

dn - base DN

getSearchFilter

public SearchFilter getSearchFilter()

Returns the search filter.

Returns:

search filter

setSearchFilter

public void setSearchFilter(SearchFilter filter)

Sets the search filter.

Parameters:

filter - search filter

getReturnAttributes

public java.lang.String[] getReturnAttributes()

Returns the search return attributes.

Returns:

search return attributes

setReturnAttributes

public void setReturnAttributes(java.lang.String... attrs)

Sets the search return attributes.

Parameters:

attrs - search return attributes

getSearchScope

public SearchScope getSearchScope()

Gets the search scope.

Returns:

search scope

setSearchScope

public void setSearchScope(SearchScope scope)

Sets the search scope.

Parameters:

scope - search scope

getTimeLimit

public long getTimeLimit()

Returns the time limit.

Returns:

time limit

setTimeLimit

public void setTimeLimit(long limit)

Sets the time limit.

Parameters:

limit - time limit

getSizeLimit

public long getSizeLimit()

Returns the size limit.

Returns:

size limit

setSizeLimit

public void setSizeLimit(long limit)

Sets the size limit.

Parameters:

limit - size limit

getDerefAliases

public DerefAliases getDerefAliases()

Returns how to dereference aliases.

Returns:

how to dereference aliases

setDerefAliases

public void setDerefAliases(DerefAliases da)

Sets how to dereference aliases.

Parameters:

da - how to dereference aliases

getTypesOnly

public boolean getTypesOnly()

Returns whether to return only attribute types.

Returns:

whether to return only attribute types

setTypesOnly

public void setTypesOnly(boolean b)

Sets whether to return only attribute types.

Parameters:

b - whether to return only attribute types

getBinaryAttributes

public java.lang.String[] getBinaryAttributes()

Returns names of binary attributes.

Returns:

binary attribute names

setBinaryAttributes

public void setBinaryAttributes(java.lang.String... attrs)

Sets names of binary attributes.

Parameters:

attrs - binary attribute names

getSortBehavior

public SortBehavior getSortBehavior()

Returns the sort behavior.

Returns:

sort behavior

setSortBehavior

public void setSortBehavior(SortBehavior sb)

Sets the sort behavior.

Parameters:

sb - sort behavior

getSearchEntryHandlers

public SearchEntryHandler[] getSearchEntryHandlers()

Returns the search entry handlers.

Returns:

search entry handlers

setSearchEntryHandlers

public void setSearchEntryHandlers(SearchEntryHandler... handlers)

Sets the search entry handlers.

Parameters:

handlers - search entry handlers

getSearchReferenceHandlers

public SearchReferenceHandler[] getSearchReferenceHandlers()

Returns the search reference handlers.

Returns:

search reference handlers

setSearchReferenceHandlers

public void setSearchReferenceHandlers(SearchReferenceHandler... handlers)

Sets the search reference handlers.

Parameters:

handlers - search reference handlers

newObjectScopeSearchRequest

public static SearchRequest newObjectScopeSearchRequest(java.lang.String dn)

Returns a search request initialized for use with an object level search scope.

Parameters:

dn - of an ldap entry

Returns:

search request

newObjectScopeSearchRequest

public static SearchRequest newObjectScopeSearchRequest(java.lang.String dn,
                                                        java.lang.String[] attrs)

Returns a search request initialized for use with an object level search scope.

Parameters:

dn - of an ldap entry

attrs - to return

Returns:

search request

newObjectScopeSearchRequest

public static SearchRequest newObjectScopeSearchRequest(java.lang.String dn,
                                                        java.lang.String[] attrs,
                                                        SearchFilter filter)

Returns a search request initialized for use with an object level search scope.

Parameters:

dn - of an ldap entry

attrs - to return

filter - to execute on the ldap entry

Returns:

search request

newSearchRequest

protected static SearchRequest newSearchRequest(SearchRequest request)

Returns a search request initialized with the supplied request. Note that stateful ldap entry handlers could cause thread safety issues.

Parameters:

request - search request to read properties from

Returns:

search request

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object