org.apache.james.protocols.api.future

Class FutureResponseImpl

java.lang.Object

org.apache.james.protocols.api.future.FutureResponseImpl

All Implemented Interfaces:

FutureResponse, Response

Direct Known Subclasses:

FutureStartTlsResponse, FutureStreamResponseImpl

public class FutureResponseImpl
extends Object
implements FutureResponse

FutureResponse implementation which wraps a AbstractResponse implementation

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.james.protocols.api.future.FutureResponse

FutureResponse.ResponseListener

Field Summary

Fields

Modifier and Type	Field and Description
protected Response	response

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

DISCONNECT

Constructor Summary

Constructors

Constructor and Description
FutureResponseImpl()
FutureResponseImpl(Logger logger)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(FutureResponse.ResponseListener listener) Add a FutureResponse.ResponseListener which will get notified once FutureResponse.isReady() is true
protected void	checkReady()
List<CharSequence>	getLines() Return a List of all response lines stored in this Response.
String	getRetCode() Return return-code
boolean	isEndSession() Return true if the session is ended
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
void	setResponse(Response response) Set the Response which will be used to notify the registered ResponseListener'.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

response

protected Response response

Constructor Detail

FutureResponseImpl

public FutureResponseImpl()

FutureResponseImpl

public FutureResponseImpl(Logger logger)

Method Detail

checkReady

protected final void checkReady()

addListener

public void addListener(FutureResponse.ResponseListener listener)

Description copied from interface: FutureResponse

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

Specified by:

addListener in interface FutureResponse

removeListener

public void removeListener(FutureResponse.ResponseListener listener)

Description copied from interface: FutureResponse

Remote a FutureResponse.ResponseListener

Specified by:

removeListener in interface FutureResponse

isReady

public boolean isReady()

Description copied from interface: FutureResponse

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

Specified by:

isReady in interface FutureResponse

Returns:

ready

getLines

public List<CharSequence> getLines()

Description copied from interface: Response

Return a List of all response lines stored in this Response. This should be used for encoding the Response before sending it to the client.

Specified by:

getLines in interface Response

Returns:

all responseLines

getRetCode

public String getRetCode()

Description copied from interface: Response

Return return-code

Specified by:

getRetCode in interface Response

Returns:

the return code

isEndSession

public boolean isEndSession()

Description copied from interface: Response

Return true if the session is ended

Specified by:

isEndSession in interface Response

Returns:

true if session is ended

toString

public String toString()

Overrides:

toString in class Object

setResponse

public void setResponse(Response response)

Set the Response which will be used to notify the registered ResponseListener'. After this method is called all waiting threads will get notified and isReady() will return true.

Parameters:

response -