org.ldaptive.provider.opendj

Class OpenDJConnection.AbstractOpenDJSearch

java.lang.Object

org.ldaptive.provider.opendj.OpenDJConnection.AbstractOpenDJSearch

Direct Known Subclasses:

OpenDJConnection.OpenDJAsyncSearchListener, OpenDJConnection.OpenDJSearchIterator

Enclosing class:

OpenDJConnection

protected abstract class OpenDJConnection.AbstractOpenDJSearch
extends Object

Common search functionality for opendj iterators and listeners.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AbstractOpenDJSearch(SearchRequest sr) Creates a new abstract opendj search.

Method Summary

Modifier and Type	Method and Description
protected org.forgerock.opendj.ldap.DereferenceAliasesPolicy	getDereferencePolicy(DerefAliases deref) Returns the opendj deference policy for the supplied deref aliases.
protected org.forgerock.opendj.ldap.requests.SearchRequest	getSearchRequest(SearchRequest sr) Returns an opendj search request object configured with the supplied search request.
protected org.forgerock.opendj.ldap.SearchScope	getSearchScope(SearchScope ss) Returns the opendj search scope for the supplied search scope.
protected ResultCode	ignoreSearchException(ResultCode[] ignoreResultCodes, org.forgerock.opendj.ldap.ErrorResultException e) Determines whether the supplied ldap exception should be ignored.
protected SearchItem	processIntermediateResponse(org.forgerock.opendj.ldap.responses.IntermediateResponse res) Processes the response controls on the supplied response and returns a corresponding search item.
protected SearchItem	processSearchResultEntry(org.forgerock.opendj.ldap.responses.SearchResultEntry entry) Processes the response controls on the supplied entry and returns a corresponding search item.
protected SearchItem	processSearchResultReference(org.forgerock.opendj.ldap.responses.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 OpenDJUtils util

Utility class.

Constructor Detail

AbstractOpenDJSearch

public AbstractOpenDJSearch(SearchRequest sr)

Creates a new abstract opendj search.

Parameters:

sr - search request

Method Detail

getSearchRequest

protected org.forgerock.opendj.ldap.requests.SearchRequest getSearchRequest(SearchRequest sr)

Returns an opendj search request object configured with the supplied search request.

Parameters:

sr - search request containing configuration to create opendj search request

Returns:

search request

getSearchScope

protected org.forgerock.opendj.ldap.SearchScope getSearchScope(SearchScope ss)

Returns the opendj search scope for the supplied search scope.

Parameters:

ss - search scope

Returns:

opendj search scope

getDereferencePolicy

protected org.forgerock.opendj.ldap.DereferenceAliasesPolicy getDereferencePolicy(DerefAliases deref)

Returns the opendj deference policy for the supplied deref aliases.

Parameters:

deref - deref aliases

Returns:

dereference policy

ignoreSearchException

protected ResultCode ignoreSearchException(ResultCode[] ignoreResultCodes,
                                           org.forgerock.opendj.ldap.ErrorResultException 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(org.forgerock.opendj.ldap.responses.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(org.forgerock.opendj.ldap.responses.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(org.forgerock.opendj.ldap.responses.IntermediateResponse res)

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

Parameters:

res - to process

Returns:

search item