org.apache.directory.ldap.client.api.future

Class SearchFuture

java.lang.Object

org.apache.directory.ldap.client.api.future.ResponseFuture<SearchResponse>

org.apache.directory.ldap.client.api.future.SearchFuture

All Implemented Interfaces:

Future<SearchResponse>

public class SearchFuture
extends ResponseFuture<SearchResponse>

A Future to manage SerachRequest

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.ldap.client.api.future.ResponseFuture

cancelled, connection, messageId, queue

Constructor Summary

Constructors

Constructor and Description
SearchFuture(LdapConnection connection, int messageId) Creates a new instance of SearchFuture.

Method Summary

Modifier and Type	Method and Description
SearchResponse	get() Get the SearchResponse, blocking until one is received.
SearchResponse	get(long timeout, TimeUnit unit) Get the SearchResponse, blocking until one is received, or until the given timeout is reached.
String	toString()

Methods inherited from class org.apache.directory.ldap.client.api.future.ResponseFuture

cancel, isCancelled, isDone, set

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchFuture

public SearchFuture(LdapConnection connection,
                    int messageId)

Creates a new instance of SearchFuture.

Parameters:

connection - The LdapConnection

messageId - The associated messageId

Method Detail

get

public SearchResponse get()
                   throws InterruptedException,
                          ExecutionException

Get the SearchResponse, blocking until one is received. It can be either a SearchResultEntry, a SearchResultReference or a SearchResultDone, the last of all the SearchResponse.

Specified by:

get in interface Future<SearchResponse>

Overrides:

get in class ResponseFuture<SearchResponse>

Returns:

The SearchResponse

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

get

public SearchResponse get(long timeout,
                          TimeUnit unit)
                   throws InterruptedException,
                          ExecutionException,
                          TimeoutException

Get the SearchResponse, blocking until one is received, or until the given timeout is reached.

Specified by:

get in interface Future<SearchResponse>

Overrides:

get in class ResponseFuture<SearchResponse>

Parameters:

timeout - Number of TimeUnit to wait

unit - The TimeUnit

Returns:

The SearchResponse The SearchResponse found

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

TimeoutException

toString

public String toString()

Overrides:

toString in class ResponseFuture<SearchResponse>