java.lang.Object

org.ldaptive.transport.DefaultOperationHandle<SearchRequest,SearchResponse>

org.ldaptive.transport.DefaultSearchOperationHandle

All Implemented Interfaces:: OperationHandle<SearchRequest,SearchResponse>, SearchOperationHandle

public class DefaultSearchOperationHandle extends DefaultOperationHandle<SearchRequest,SearchResponse> implements SearchOperationHandle

Handle that notifies on the components of a search request.

Field Summary

Fields

Modifier and Type

Field

Description

private LdapEntryHandler[]

onEntry

Functions to handle response entries.

private SearchReferenceHandler[]

onReference

Functions to handle response references.

private SearchResultHandler[]

onSearchResult

Functions to handle complete response.

private SearchResponse

result

Synthetic result that is built as entries and references are received.

private static final boolean

SORT_RESULTS

Whether to automatically sort search results.

Fields inherited from class org.ldaptive.transport.DefaultOperationHandle
logger
Constructor Summary

Constructors

Constructor

Description

DefaultSearchOperationHandle(SearchRequest req, TransportConnection conn, Duration timeout)

Creates a new search operation handle.
Method Summary

Modifier and Type

Method

Description

SearchResponse

await()

Waits for a result or reports a timeout exception.

void

entry(LdapEntry r)

Invokes onEntry.

SearchResponse

execute()

Convenience method that invokes OperationHandle.send() followed by OperationHandle.await().

LdapEntryHandler[]

getOnEntry()

SearchReferenceHandler[]

getOnReference()

SearchResultHandler[]

getOnSearchResult()

DefaultSearchOperationHandle

onComplete(CompleteHandler function)

Sets the function to execute when the operation completes.

DefaultSearchOperationHandle

onControl(ResponseControlHandler... function)

Sets the functions to execute when a control is received.

DefaultSearchOperationHandle

onEntry(LdapEntryHandler... function)

Sets the functions to execute when a search result entry is received.

DefaultSearchOperationHandle

onException(ExceptionHandler function)

Sets the function to execute when an exception occurs.

DefaultSearchOperationHandle

onIntermediate(IntermediateResponseHandler... function)

Sets the functions to execute when an intermediate response is received.

DefaultSearchOperationHandle

onReference(SearchReferenceHandler... function)

Sets the functions to execute when a search result reference is received.

DefaultSearchOperationHandle

onReferral(ReferralHandler... function)

Sets the functions to execute when a referral is received.

DefaultSearchOperationHandle

onResult(ResultHandler... function)

Sets the functions to execute when a result is received.

DefaultSearchOperationHandle

onSearchResult(SearchResultHandler... function)

Sets the functions to execute when a search result is complete.

DefaultSearchOperationHandle

onUnsolicitedNotification(UnsolicitedNotificationHandler... function)

Sets the functions to execute when an unsolicited notification is received.

void

reference(SearchResultReference r)

Invokes onReference.

DefaultSearchOperationHandle

send()

Sends this request to the server.

DefaultSearchOperationHandle

throwIf(ResultPredicate function)

Sets the function to determine whether an exception should be raised by a particular result.

String

toString()

Methods inherited from class org.ldaptive.transport.DefaultOperationHandle
abandon, abandon, cancel, consumedMessage, control, exception, getMessageID, getOnComplete, getOnControl, getOnException, getOnIntermediate, getOnReferral, getOnResult, getOnUnsolicitedNotification, getReceivedTime, getRequest, getSentTime, getThrowCondition, hasConsumedMessage, initializeMessageFunctional, intermediate, messageID, referral, result, sent, unsolicitedNotification

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ldaptive.OperationHandle
abandon, cancel, getReceivedTime, getSentTime

Field Details
- SORT_RESULTS
  
  private static final boolean SORT_RESULTS
  
  Whether to automatically sort search results.
- onEntry
  
  private LdapEntryHandler[] onEntry
  
  Functions to handle response entries.
- onReference
  
  private SearchReferenceHandler[] onReference
  
  Functions to handle response references.
- onSearchResult
  
  private SearchResultHandler[] onSearchResult
  
  Functions to handle complete response.
- result
  
  private SearchResponse result
  
  Synthetic result that is built as entries and references are received.
Constructor Details
- DefaultSearchOperationHandle
  
  public DefaultSearchOperationHandle(SearchRequest req, TransportConnection conn, Duration timeout)
  
  Creates a new search operation handle.
  
  Parameters:
  
  req - search request to expect a response for
  
  conn - the request will be executed on
  
  timeout - duration to wait for a response
Method Details
- send
  
  public DefaultSearchOperationHandle send()
  
  Description copied from interface: OperationHandle
  
  Sends this request to the server.
  
  Specified by:
  
  send in interface OperationHandle<SearchRequest,SearchResponse>
  
  Specified by:
  
  send in interface SearchOperationHandle
  
  Overrides:
  
  send in class DefaultOperationHandle<SearchRequest,SearchResponse>
  
  Returns:
  
  this handle
- await
  
  public SearchResponse await() throws LdapException
  
  Description copied from interface: OperationHandle
  
  Waits for a result or reports a timeout exception.
  
  Specified by:
  
  await in interface OperationHandle<SearchRequest,SearchResponse>
  
  Specified by:
  
  await in interface SearchOperationHandle
  
  Overrides:
  
  await in class DefaultOperationHandle<SearchRequest,SearchResponse>
  
  Returns:
  
  result of the operation or empty if the operation is abandoned
  
  Throws:
  
  LdapException - if an error occurs executing the request
- execute
  
  public SearchResponse execute() throws LdapException
  
  Description copied from interface: OperationHandle
  
  Convenience method that invokes OperationHandle.send() followed by OperationHandle.await(). Provides a single method to make a synchronous request.
  
  Specified by:
  
  execute in interface OperationHandle<SearchRequest,SearchResponse>
  
  Specified by:
  
  execute in interface SearchOperationHandle
  
  Returns:
  
  result of the operation or empty if the operation is abandoned
  
  Throws:
  
  LdapException - if an error occurs executing the request
- onResult
  
  public DefaultSearchOperationHandle onResult(ResultHandler... function)
  
  Description copied from interface: OperationHandle
  
  Sets the functions to execute when a result is received.
  
  Specified by:
  
  onResult in interface OperationHandle<SearchRequest,SearchResponse>
  
  Specified by:
  
  onResult in interface SearchOperationHandle
  
  Overrides:
  
  onResult in class DefaultOperationHandle<SearchRequest,SearchResponse>
  
  Parameters:
  
  function - to execute on a result
  
  Returns:
  
  this handle
- onControl
  
  public DefaultSearchOperationHandle onControl(ResponseControlHandler... function)
  
  Description copied from interface: OperationHandle
  
  Sets the functions to execute when a control is received.
  
  Specified by:
  
  onControl in interface OperationHandle<SearchRequest,SearchResponse>
  
  Specified by:
  
  onControl in interface SearchOperationHandle
  
  Overrides:
  
  onControl in class DefaultOperationHandle<SearchRequest,SearchResponse>
  
  Parameters:
  
  function - to execute on a control
  
  Returns:
  
  this handle
- onReferral
  
  public DefaultSearchOperationHandle onReferral(ReferralHandler... function)
  
  Description copied from interface: OperationHandle
  
  Sets the functions to execute when a referral is received.
  
  Specified by:
  
  onReferral in interface OperationHandle<SearchRequest,SearchResponse>
  
  Specified by:
  
  onReferral in interface SearchOperationHandle
  
  Overrides:
  
  onReferral in class DefaultOperationHandle<SearchRequest,SearchResponse>
  
  Parameters:
  
  function - to execute on a referral
  
  Returns:
  
  this handle
- onIntermediate
  
  public DefaultSearchOperationHandle onIntermediate(IntermediateResponseHandler... function)
  
  Description copied from interface: OperationHandle
  
  Sets the functions to execute when an intermediate response is received.
  
  Specified by:
  
  onIntermediate in interface OperationHandle<SearchRequest,SearchResponse>
  
  Specified by:
  
  onIntermediate in interface SearchOperationHandle
  
  Overrides:
  
  onIntermediate in class DefaultOperationHandle<SearchRequest,SearchResponse>
  
  Parameters:
  
  function - to execute on an intermediate response
  
  Returns:
  
  this handle
- onUnsolicitedNotification
  
  public DefaultSearchOperationHandle onUnsolicitedNotification(UnsolicitedNotificationHandler... function)
  
  Description copied from interface: OperationHandle
  
  Sets the functions to execute when an unsolicited notification is received.
  
  Specified by:
  
  onUnsolicitedNotification in interface OperationHandle<SearchRequest,SearchResponse>
  
  Specified by:
  
  onUnsolicitedNotification in interface SearchOperationHandle
  
  Overrides:
  
  onUnsolicitedNotification in class DefaultOperationHandle<SearchRequest,SearchResponse>
  
  Parameters:
  
  function - to execute on an unsolicited notification
  
  Returns:
  
  this handle
- onException
  
  public DefaultSearchOperationHandle onException(ExceptionHandler function)
  
  Description copied from interface: OperationHandle
  
  Sets the function to execute when an exception occurs.
  
  Specified by:
  
  onException in interface OperationHandle<SearchRequest,SearchResponse>
  
  Specified by:
  
  onException in interface SearchOperationHandle
  
  Overrides:
  
  onException in class DefaultOperationHandle<SearchRequest,SearchResponse>
  
  Parameters:
  
  function - to execute when an exception occurs
  
  Returns:
  
  this handle
- throwIf
  
  public DefaultSearchOperationHandle throwIf(ResultPredicate function)
  
  Description copied from interface: OperationHandle
  
  Sets the function to determine whether an exception should be raised by a particular result.
  
  Specified by:
  
  throwIf in interface OperationHandle<SearchRequest,SearchResponse>
  
  Specified by:
  
  throwIf in interface SearchOperationHandle
  
  Overrides:
  
  throwIf in class DefaultOperationHandle<SearchRequest,SearchResponse>
  
  Parameters:
  
  function - to determine whether to throw an exception
  
  Returns:
  
  this handle
- onComplete
  
  public DefaultSearchOperationHandle onComplete(CompleteHandler function)
  
  Description copied from interface: OperationHandle
  
  Sets the function to execute when the operation completes.
  
  Specified by:
  
  onComplete in interface OperationHandle<SearchRequest,SearchResponse>
  
  Specified by:
  
  onComplete in interface SearchOperationHandle
  
  Overrides:
  
  onComplete in class DefaultOperationHandle<SearchRequest,SearchResponse>
  
  Parameters:
  
  function - to execute on completion
  
  Returns:
  
  this handle
- onEntry
  
  public DefaultSearchOperationHandle onEntry(LdapEntryHandler... function)
  
  Description copied from interface: SearchOperationHandle
  
  Sets the functions to execute when a search result entry is received.
  
  Specified by:
  
  onEntry in interface SearchOperationHandle
  
  Parameters:
  
  function - to execute on a search result entry
  
  Returns:
  
  this handle
- onReference
  
  public DefaultSearchOperationHandle onReference(SearchReferenceHandler... function)
  
  Description copied from interface: SearchOperationHandle
  
  Sets the functions to execute when a search result reference is received.
  
  Specified by:
  
  onReference in interface SearchOperationHandle
  
  Parameters:
  
  function - to execute on a search result reference
  
  Returns:
  
  this handle
- onSearchResult
  
  public DefaultSearchOperationHandle onSearchResult(SearchResultHandler... function)
  
  Description copied from interface: SearchOperationHandle
  
  Sets the functions to execute when a search result is complete.
  
  Specified by:
  
  onSearchResult in interface SearchOperationHandle
  
  Parameters:
  
  function - to execute on a search result
  
  Returns:
  
  this handle
- getOnEntry
  
  public LdapEntryHandler[] getOnEntry()
- getOnReference
  
  public SearchReferenceHandler[] getOnReference()
- getOnSearchResult
  
  public SearchResultHandler[] getOnSearchResult()
- entry
  
  public void entry(LdapEntry r)
  
  Invokes onEntry.
  
  Parameters:
  
  r - search result entry
- reference
  
  public void reference(SearchResultReference r)
  
  Invokes onReference.
  
  Parameters:
  
  r - search result reference
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class DefaultOperationHandle<SearchRequest,SearchResponse>

Class DefaultSearchOperationHandle

Field Summary

Fields inherited from class org.ldaptive.transport.DefaultOperationHandle

Constructor Summary

Method Summary

Methods inherited from class org.ldaptive.transport.DefaultOperationHandle

Methods inherited from class java.lang.Object

Methods inherited from interface org.ldaptive.OperationHandle

Field Details

SORT_RESULTS

onEntry

onReference

onSearchResult

result

Constructor Details

DefaultSearchOperationHandle

Method Details

send

await

execute

onResult

onControl

onReferral

onIntermediate

onUnsolicitedNotification

onException

throwIf

onComplete

onEntry

onReference

onSearchResult

getOnEntry

getOnReference

getOnSearchResult

entry

reference

toString