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

Class ModifyDnFuture

java.lang.Object

org.apache.directory.ldap.client.api.future.ResponseFuture<ModifyDnResponse>

org.apache.directory.ldap.client.api.future.ModifyDnFuture

All Implemented Interfaces:

Future<ModifyDnResponse>

public class ModifyDnFuture
extends ResponseFuture<ModifyDnResponse>

A Future to manage ModifyDnRequest

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

Constructors

Constructor and Description
ModifyDnFuture(LdapConnection connection, int messageId) Creates a new instance of ModifyDnFuture.

Method Summary

Modifier and Type	Method and Description
ModifyDnResponse	get() Get the ModifyDnResponse, blocking until one is received.
ModifyDnResponse	get(long timeout, TimeUnit unit) Get the ModifyDnResponse, 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, isCancelled, isDone, set

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifyDnFuture

public ModifyDnFuture(LdapConnection connection,
                      int messageId)

Creates a new instance of ModifyDnFuture.

Parameters:

connection - The LdapConnection

messageId - The associated messageId

Method Detail

get

public ModifyDnResponse get()
                     throws InterruptedException,
                            ExecutionException

Get the ModifyDnResponse, blocking until one is received.

Specified by:

get in interface Future<ModifyDnResponse>

Overrides:

get in class ResponseFuture<ModifyDnResponse>

Returns:

The ModifyDnResponse

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

get

public ModifyDnResponse get(long timeout,
                            TimeUnit unit)
                     throws InterruptedException,
                            ExecutionException,
                            TimeoutException

Get the ModifyDnResponse, blocking until one is received, or until the given timeout is reached.

Specified by:

get in interface Future<ModifyDnResponse>

Overrides:

get in class ResponseFuture<ModifyDnResponse>

Parameters:

timeout - Number of TimeUnit to wait

unit - The TimeUnit

Returns:

The ModifyDnResponse The ModifyDnResponse found

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

TimeoutException

toString

public String toString()

Overrides:

toString in class ResponseFuture<ModifyDnResponse>