org.apache.james.protocols.api

Interface ProtocolTransport

All Known Implementing Classes:

AbstractProtocolTransport, NettyProtocolTransport

public interface ProtocolTransport

ProtocolTransport is used by each ProtocolSession to communicate with the underlying transport. Transport implementations will provide their own implementation of the transport. Every new connection gets a new instance of ProtocolTransport. So its not shared between connections.

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() Return the unique id.
InetSocketAddress	getLocalAddress() Return the InetSocketAddress of the local bound address
int	getPushedLineHandlerCount() Return the count of pushed LineHandler's
InetSocketAddress	getRemoteAddress() Return the InetSocketAddress of the remote peer
boolean	isReadable() Return true if the channel is readable
boolean	isStartTLSSupported() Return true if STARTTLS is supported by this ProtocolTransport
boolean	isTLSStarted() Return true if TLS encryption is active
void	popLineHandler() Pop a LineHandler of the stack
void	pushLineHandler(LineHandler<? extends ProtocolSession> overrideCommandHandler, ProtocolSession session) Push a LineHandler in.
void	setReadable(boolean readable) Set the ProtocolTransport readable or not.
void	writeResponse(Response response, ProtocolSession session) Write the Response to the ProtocolTransport which will forward it to the connected peer

Method Detail

getRemoteAddress

InetSocketAddress getRemoteAddress()

Return the InetSocketAddress of the remote peer

Returns:

address

getLocalAddress

InetSocketAddress getLocalAddress()

Return the InetSocketAddress of the local bound address

Returns:

local

getId

String getId()

Return the unique id. The id MUST NOT be 100 % unique for ever. It just should just not have the same id when having concurrent connections

Returns:

id

isTLSStarted

boolean isTLSStarted()

Return true if TLS encryption is active

Returns:

tlsStarted

isStartTLSSupported

boolean isStartTLSSupported()

Return true if STARTTLS is supported by this ProtocolTransport

Returns:

tlsSupprted

writeResponse

void writeResponse(Response response,
                 ProtocolSession session)

Write the Response to the ProtocolTransport which will forward it to the connected peer

Parameters:

response -

session -

popLineHandler

void popLineHandler()

Pop a LineHandler of the stack

pushLineHandler

void pushLineHandler(LineHandler<? extends ProtocolSession> overrideCommandHandler,
                   ProtocolSession session)

Push a LineHandler in.

Parameters:

overrideCommandHandler -

session -

getPushedLineHandlerCount

int getPushedLineHandlerCount()

Return the count of pushed LineHandler's

Returns:

lineCount

setReadable

void setReadable(boolean readable)

Set the ProtocolTransport readable or not. If its not readable then no new lines should get processed

Parameters:

readable -

isReadable

boolean isReadable()

Return true if the channel is readable

Returns: