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

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

All Implemented Interfaces:

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

public class AddFuture
extends ResponseFuture<org.apache.directory.api.ldap.model.message.AddResponse>

A Future to manage AddRequests.

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

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

Method Summary

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

AddFuture

public AddFuture(LdapConnection connection,
                 int messageId)

Creates a new instance of AddFuture.

Parameters:

connection - the LDAP connection

messageId - The associated messageId

Method Detail

get

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

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

Returns:

the add response

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

get

public org.apache.directory.api.ldap.model.message.AddResponse get(long timeout,
                                                                   TimeUnit unit)
                                                            throws InterruptedException,
                                                                   ExecutionException,
                                                                   TimeoutException

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

Parameters:

timeout -

unit -

Returns:

the add 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.AddResponse>