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

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

All Implemented Interfaces:

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

public class DeleteFuture
extends ResponseFuture<org.apache.directory.api.ldap.model.message.DeleteResponse>

A Future to manage DeleteRequests.

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

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

Method Summary

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

DeleteFuture

public DeleteFuture(LdapConnection connection,
                    int messageId)

Creates a new instance of DeleteFuture.

Parameters:

connection - the LDAP connection

messageId - The associated messageId

Method Detail

get

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

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

Returns:

the delete response

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

get

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

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

Parameters:

timeout -

unit -

Returns:

the delete 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.DeleteResponse>