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

Class BindFuture

java.lang.Object

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

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

All Implemented Interfaces:

Future<BindResponse>

public class BindFuture
extends ResponseFuture<BindResponse>

A Future to manage BindRequests

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

Method Summary

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

BindFuture

public BindFuture(LdapConnection connection,
                  int messageId)

Creates a new instance of BindFuture.

Parameters:

connection - The LdapConnection

messageId - The associated messageId

Method Detail

get

public BindResponse get()
                 throws InterruptedException,
                        ExecutionException

Get the BindResponse, blocking until one is received.

Specified by:

get in interface Future<BindResponse>

Overrides:

get in class ResponseFuture<BindResponse>

Returns:

The BindResponse

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

get

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

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

Specified by:

get in interface Future<BindResponse>

Overrides:

get in class ResponseFuture<BindResponse>

Parameters:

timeout - Number of TimeUnit to wait

unit - The TimeUnit

Returns:

The BindResponse The BindResponse found

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

TimeoutException

toString

public String toString()

Overrides:

toString in class ResponseFuture<BindResponse>