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

Class ExtendedFuture

java.lang.Object

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

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

All Implemented Interfaces:

Future<ExtendedResponse>

public class ExtendedFuture
extends ResponseFuture<ExtendedResponse>

A Future to manage ExtendedRequests

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
ExtendedFuture(LdapConnection connection, int messageId) Creates a new instance of ExtendedFuture.

Method Summary

Modifier and Type	Method and Description
ExtendedResponse	get() Get the ExtendedResponse, blocking until one is received.
ExtendedResponse	get(long timeout, TimeUnit unit) Get the ExtendedResponse, 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

ExtendedFuture

public ExtendedFuture(LdapConnection connection,
                      int messageId)

Creates a new instance of ExtendedFuture.

Method Detail

get

public ExtendedResponse get()
                     throws InterruptedException,
                            ExecutionException

Get the ExtendedResponse, blocking until one is received.

Specified by:

get in interface Future<ExtendedResponse>

Overrides:

get in class ResponseFuture<ExtendedResponse>

Returns:

The ExtendedResponse

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

get

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

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

Specified by:

get in interface Future<ExtendedResponse>

Overrides:

get in class ResponseFuture<ExtendedResponse>

Parameters:

timeout - Number of TimeUnit to wait

unit - The TimeUnit

Returns:

The ExtendedResponse The ExtendedResponse found

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

TimeoutException

toString

public String toString()

Overrides:

toString in class ResponseFuture<ExtendedResponse>