org.ldaptive.provider.unboundid

Class UnboundIDConnection.AbstractUnboundIDSearch

java.lang.Object

org.ldaptive.provider.unboundid.UnboundIDConnection.AbstractUnboundIDSearch

Direct Known Subclasses:

UnboundIDConnection.UnboundIDAsyncSearchListener, UnboundIDConnection.UnboundIDSearchIterator

Enclosing class:

UnboundIDConnection

protected abstract class UnboundIDConnection.AbstractUnboundIDSearch
extends Object

Common search functionality for unbound id iterators and listeners.

Field Summary

Fields

Modifier and Type	Field and Description
protected SearchRequest	request Search request.
protected UnboundIDUtils	util Utility class.

Constructor Summary

Constructors

Constructor and Description
AbstractUnboundIDSearch(SearchRequest sr) Creates a new abstract unbound id search.

Method Summary

Modifier and Type	Method and Description
protected com.unboundid.ldap.sdk.DereferencePolicy	getDereferencePolicy(DerefAliases deref) Returns the unbound id deference policy for the supplied deref aliases.
protected com.unboundid.ldap.sdk.SearchRequest	getSearchRequest(SearchRequest sr, com.unboundid.ldap.sdk.SearchResultListener srListener, com.unboundid.ldap.sdk.IntermediateResponseListener irListener) Returns an unbound id search request object configured with the supplied search request.
protected com.unboundid.ldap.sdk.SearchScope	getSearchScope(SearchScope ss) Returns the unbound id search scope for the supplied search scope.
protected ResultCode	ignoreSearchException(ResultCode[] ignoreResultCodes, com.unboundid.ldap.sdk.LDAPException e) Determines whether the supplied ldap exception should be ignored.
protected SearchItem	processIntermediateResponse(com.unboundid.ldap.sdk.IntermediateResponse res) Processes the response controls on the supplied response and returns a corresponding search item.
protected SearchItem	processSearchResultEntry(com.unboundid.ldap.sdk.SearchResultEntry entry) Processes the response controls on the supplied entry and returns a corresponding search item.
protected SearchItem	processSearchResultReference(com.unboundid.ldap.sdk.SearchResultReference ref) Processes the response controls on the supplied reference and returns a corresponding search item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

request

protected final SearchRequest request

Search request.

util

protected final UnboundIDUtils util

Utility class.

Constructor Detail

AbstractUnboundIDSearch

public AbstractUnboundIDSearch(SearchRequest sr)

Creates a new abstract unbound id search.

Parameters:

sr - search request

Method Detail

getSearchRequest

protected com.unboundid.ldap.sdk.SearchRequest getSearchRequest(SearchRequest sr,
                                                                com.unboundid.ldap.sdk.SearchResultListener srListener,
                                                                com.unboundid.ldap.sdk.IntermediateResponseListener irListener)
                                                         throws com.unboundid.ldap.sdk.LDAPSearchException

Returns an unbound id search request object configured with the supplied search request.

Parameters:

sr - search request containing configuration to create unbound id search request

srListener - search result listener

irListener - intermediate response listener

Returns:

search request

Throws:

com.unboundid.ldap.sdk.LDAPSearchException - if the search request cannot be initialized

getSearchScope

protected com.unboundid.ldap.sdk.SearchScope getSearchScope(SearchScope ss)

Returns the unbound id search scope for the supplied search scope.

Parameters:

ss - search scope

Returns:

unbound id search scope

getDereferencePolicy

protected com.unboundid.ldap.sdk.DereferencePolicy getDereferencePolicy(DerefAliases deref)

Returns the unbound id deference policy for the supplied deref aliases.

Parameters:

deref - deref aliases

Returns:

dereference policy

ignoreSearchException

protected ResultCode ignoreSearchException(ResultCode[] ignoreResultCodes,
                                           com.unboundid.ldap.sdk.LDAPException e)

Determines whether the supplied ldap exception should be ignored.

Parameters:

ignoreResultCodes - to match against the exception

e - ldap exception to match

Returns:

result code that should be ignored or null

processSearchResultEntry

protected SearchItem processSearchResultEntry(com.unboundid.ldap.sdk.SearchResultEntry entry)

Processes the response controls on the supplied entry and returns a corresponding search item.

Parameters:

entry - to process

Returns:

search item

processSearchResultReference

protected SearchItem processSearchResultReference(com.unboundid.ldap.sdk.SearchResultReference ref)

Processes the response controls on the supplied reference and returns a corresponding search item.

Parameters:

ref - to process

Returns:

search item

processIntermediateResponse

protected SearchItem processIntermediateResponse(com.unboundid.ldap.sdk.IntermediateResponse res)

Processes the response controls on the supplied response and returns a corresponding search item.

Parameters:

res - to process

Returns:

search item