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

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

All Implemented Interfaces:

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

public class BindFuture
extends ResponseFuture<org.apache.directory.api.ldap.model.message.BindResponse>

A Future to manage BindRequests.

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

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

Method Summary

org.apache.directory.api.ldap.model.message.BindResponse	get() Get the BindResponse, blocking until one is received.
org.apache.directory.api.ldap.model.message.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, 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

BindFuture

public BindFuture(LdapConnection connection,
                  int messageId)

Creates a new instance of BindFuture.

Parameters:

connection - the LDAP connection

messageId - the associated messageId

Method Detail

get

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

Get the BindResponse, 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.BindResponse>

Returns:

the bind response

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

get

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

Overrides:

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

Parameters:

timeout -

unit -

Returns:

the bind 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.BindResponse>