org.apache.james.protocols.netty

Class NettyProtocolTransport

java.lang.Object

org.apache.james.protocols.api.AbstractProtocolTransport

org.apache.james.protocols.netty.NettyProtocolTransport

All Implemented Interfaces:

ProtocolTransport

public class NettyProtocolTransport
extends AbstractProtocolTransport

A Netty implementation of a ProtocolTransport

Constructor Summary

Constructors

Constructor and Description
NettyProtocolTransport(org.jboss.netty.channel.Channel channel, SSLEngine engine)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	close() Close the Transport
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.
protected void	writeToClient(byte[] bytes, ProtocolSession session, boolean startTLS) Write the given byte's to the remote peer
protected void	writeToClient(InputStream in, ProtocolSession session, boolean startTLS) Write the given InputStream to the remote peer

Methods inherited from class org.apache.james.protocols.api.AbstractProtocolTransport

toBytes, writeResponse, writeResponseToClient

Methods inherited from class java.lang.Object

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

Constructor Detail

NettyProtocolTransport

public NettyProtocolTransport(org.jboss.netty.channel.Channel channel,
                      SSLEngine engine)

Method Detail

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Description copied from interface: ProtocolTransport

Return the InetSocketAddress of the remote peer

Returns:

address

See Also:

ProtocolTransport.getRemoteAddress()

getId

public String getId()

Description copied from interface: ProtocolTransport

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

See Also:

ProtocolTransport.getId()

isTLSStarted

public boolean isTLSStarted()

Description copied from interface: ProtocolTransport

Return true if TLS encryption is active

Returns:

tlsStarted

See Also:

ProtocolTransport.isTLSStarted()

isStartTLSSupported

public boolean isStartTLSSupported()

Description copied from interface: ProtocolTransport

Return true if STARTTLS is supported by this ProtocolTransport

Returns:

tlsSupprted

See Also:

ProtocolTransport.isStartTLSSupported()

popLineHandler

public void popLineHandler()

Description copied from interface: ProtocolTransport

Pop a LineHandler of the stack

See Also:

ProtocolTransport.popLineHandler()

getPushedLineHandlerCount

public int getPushedLineHandlerCount()

Description copied from interface: ProtocolTransport

Return the count of pushed LineHandler's

Returns:

lineCount

See Also:

ProtocolTransport.getPushedLineHandlerCount()

writeToClient

protected void writeToClient(byte[] bytes,
                 ProtocolSession session,
                 boolean startTLS)

Description copied from class: AbstractProtocolTransport

Write the given byte's to the remote peer

Specified by:

writeToClient in class AbstractProtocolTransport

Parameters:

bytes - the bytes to write

session - the ProtocolSession for the write request

startTLS - true if startTLS should be started after the bytes were written to the client

close

protected void close()

Description copied from class: AbstractProtocolTransport

Close the Transport

Specified by:

close in class AbstractProtocolTransport

writeToClient

protected void writeToClient(InputStream in,
                 ProtocolSession session,
                 boolean startTLS)

Description copied from class: AbstractProtocolTransport

Write the given InputStream to the remote peer

Specified by:

writeToClient in class AbstractProtocolTransport

Parameters:

in - the InputStream which should be written back to the client

session - the ProtocolSession for the write request

startTLS - true if startTLS should be started after the InputStream was written to the client

setReadable

public void setReadable(boolean readable)

Description copied from interface: ProtocolTransport

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

isReadable

public boolean isReadable()

Description copied from interface: ProtocolTransport

Return true if the channel is readable

Returns:

getLocalAddress

public InetSocketAddress getLocalAddress()

Description copied from interface: ProtocolTransport

Return the InetSocketAddress of the local bound address

Returns:

local

pushLineHandler

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

Description copied from interface: ProtocolTransport

Push a LineHandler in.