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

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

All Implemented Interfaces:

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

public class ModifyDnFuture
extends ResponseFuture<org.apache.directory.api.ldap.model.message.ModifyDnResponse>

A Future to manage ModifyDnRequest

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

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

Method Summary

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

ModifyDnFuture

public ModifyDnFuture(LdapConnection connection,
                      int messageId)

Creates a new instance of ModifyDnFuture.

Parameters:

connection - the LDAP connection

messageId - The associated messageId

Method Detail

get

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

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

Returns:

the modify Dn response

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

get

public org.apache.directory.api.ldap.model.message.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<org.apache.directory.api.ldap.model.message.Response>

Overrides:

get in class ResponseFuture<org.apache.directory.api.ldap.model.message.ModifyDnResponse>

Parameters:

timeout -

unit -

Returns:

the modify Dn 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.ModifyDnResponse>