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

java.lang.Object
  extended by org.apache.directory.ldap.client.api.future.ResponseFuture<BindResponse>
      extended by org.apache.directory.ldap.client.api.future.BindFuture
All Implemented Interfaces:
java.util.concurrent.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
BindFuture(LdapConnection connection, int messageId)
          Creates a new instance of BindFuture.
 
Method Summary
 BindResponse get()
          Get the BindResponse, blocking until one is received.
 BindResponse get(long timeout, java.util.concurrent.TimeUnit unit)
          Get the BindResponse, blocking until one is received, or until the given timeout is reached.
 java.lang.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 java.lang.InterruptedException,
                        java.util.concurrent.ExecutionException
Get the BindResponse, blocking until one is received.

Specified by:
get in interface java.util.concurrent.Future<BindResponse>
Overrides:
get in class ResponseFuture<BindResponse>
Returns:
The BindResponse
Throws:
java.lang.InterruptedException - if the operation has been cancelled by client
java.util.concurrent.ExecutionException

get

public BindResponse get(long timeout,
                        java.util.concurrent.TimeUnit unit)
                 throws java.lang.InterruptedException,
                        java.util.concurrent.ExecutionException,
                        java.util.concurrent.TimeoutException
Get the BindResponse, blocking until one is received, or until the given timeout is reached.

Specified by:
get in interface java.util.concurrent.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:
java.lang.InterruptedException - if the operation has been cancelled by client
java.util.concurrent.ExecutionException
java.util.concurrent.TimeoutException

toString

public java.lang.String toString()

Overrides:
toString in class ResponseFuture<BindResponse>


Copyright © 2009-2011 Apache Software Foundation. All Rights Reserved.