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

java.lang.Object
  org.apache.directory.ldap.client.api.future.ResponseFuture<org.apache.directory.api.ldap.model.message.Response>
      org.apache.directory.ldap.client.api.future.ExtendedFuture

All Implemented Interfaces:

Future<org.apache.directory.api.ldap.model.message.Response>

public class ExtendedFuture
extends ResponseFuture<org.apache.directory.api.ldap.model.message.Response>

A Future to manage ExtendedRequests.

Author:

Apache Directory Project

Field Summary

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

cancelled, cause, connection, messageId, queue

Constructor Summary

ExtendedFuture(LdapConnection connection, int messageId)
Creates a new instance of ExtendedFuture.

Method Summary

org.apache.directory.api.ldap.model.message.Response	get() Get the ExtendedResponse, blocking until one is received.
org.apache.directory.api.ldap.model.message.Response	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, cancel, getCause, isCancelled, isDone, set, setCause

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.

Parameters:

connection - the LDAP connection

messageId - The associated messageId

Method Detail

get

public org.apache.directory.api.ldap.model.message.Response get()
                                                         throws InterruptedException,
                                                                ExecutionException

Get the ExtendedResponse, blocking until one is received.

Specified by:

get in interface Future<org.apache.directory.api.ldap.model.message.Response>

Overrides:

get in class ResponseFuture<org.apache.directory.api.ldap.model.message.Response>

Returns:

the extended response

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

get

public org.apache.directory.api.ldap.model.message.Response 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<org.apache.directory.api.ldap.model.message.Response>

Overrides:

get in class ResponseFuture<org.apache.directory.api.ldap.model.message.Response>

Parameters:

timeout -

unit -

Returns:

the extended response

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

TimeoutException

toString

public String toString()

Overrides:

toString in class ResponseFuture<org.apache.directory.api.ldap.model.message.Response>