org.apache.james.protocols.api.future

Interface FutureResponse

All Superinterfaces:

Response

All Known Implementing Classes:

FutureResponseImpl, FutureStartTlsResponse, FutureStreamResponseImpl

public interface FutureResponse
extends Response

An special Response which allows to populate it in an async fashion. It also allows to register listeners which will get notified once the FutureResponse is ready

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FutureResponse.ResponseListener Listener which will get notified once the isReady() returns true

Field Summary

Fields inherited from interface org.apache.james.protocols.api.Response

DISCONNECT

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(FutureResponse.ResponseListener listener) Add a FutureResponse.ResponseListener which will get notified once isReady() is true
boolean	isReady() Return true once the FutureResponse is ready and calling any of the get methods will not block any more.
void	removeListener(FutureResponse.ResponseListener listener) Remote a FutureResponse.ResponseListener

Methods inherited from interface org.apache.james.protocols.api.Response

getLines, getRetCode, isEndSession

Method Detail

addListener

void addListener(FutureResponse.ResponseListener listener)

Add a FutureResponse.ResponseListener which will get notified once isReady() is true

Parameters:

listener -

removeListener

void removeListener(FutureResponse.ResponseListener listener)

Remote a FutureResponse.ResponseListener

Parameters:

listener -

isReady

boolean isReady()

Return true once the FutureResponse is ready and calling any of the get methods will not block any more.

Returns:

ready