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

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

All Implemented Interfaces:

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

public class ModifyFuture
extends ResponseFuture<org.apache.directory.api.ldap.model.message.ModifyResponse>

A Future to manage ModifyRequest.

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

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

Method Summary

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

ModifyFuture

public ModifyFuture(LdapConnection connection,
                    int messageId)

Creates a new instance of ModifyFuture.

Parameters:

connection - the LDAP connection

messageId - The associated messageId

Method Detail

get

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

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

Returns:

the modify response

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

get

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

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

Parameters:

timeout -

unit -

Returns:

the modify 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.ModifyResponse>