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

Interface ResponseFuture<R extends org.apache.directory.api.ldap.model.message.Response>

Type Parameters:

R - The result type returned by this Future's get method

All Superinterfaces:

Future<R>

All Known Implementing Classes:

AddFuture, BindFuture, CompareFuture, DeleteFuture, ExtendedFuture, ModifyDnFuture, ModifyFuture, MultipleResponseFuture, SearchFuture, UniqueResponseFuture

public interface ResponseFuture<R extends org.apache.directory.api.ldap.model.message.Response>
extends Future<R>

A Future implementation used in LdapConnection operations.

Author:

Apache Directory Project

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel the Future
Throwable	getCause()
void	set(R response) Set the associated Response in this Future
void	setCause(Throwable cause) Associate a cause to the ResponseFuture

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Method Detail

set

void set(R response)
  throws InterruptedException

Set the associated Response in this Future

Parameters:

response - The response to add into the Future

Throws:

InterruptedException - if the operation has been cancelled by client

getCause

Throwable getCause()

Returns:

the cause

setCause

void setCause(Throwable cause)

Associate a cause to the ResponseFuture

Parameters:

cause - the cause to set

cancel

void cancel()

Cancel the Future