org.apache.james.protocols.api

Class AbstractProtocolTransport

java.lang.Object

org.apache.james.protocols.api.AbstractProtocolTransport

All Implemented Interfaces:

ProtocolTransport

Direct Known Subclasses:

NettyProtocolTransport

public abstract class AbstractProtocolTransport
extends Object
implements ProtocolTransport

Abstract base class for ProtocolTransport implementation which already takes care of all the complex stuff when handling Response's.

Constructor Summary

Constructors

Constructor and Description
AbstractProtocolTransport()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	close() Close the Transport
protected static byte[]	toBytes(Response response) Take the Response and encode it to a byte array
void	writeResponse(Response response, ProtocolSession session) Write the Response to the ProtocolTransport which will forward it to the connected peer
protected void	writeResponseToClient(Response response, ProtocolSession session) Write the Response to the client
protected abstract void	writeToClient(byte[] bytes, ProtocolSession session, boolean startTLS) Write the given byte's to the remote peer
protected abstract void	writeToClient(InputStream in, ProtocolSession session, boolean startTLS) Write the given InputStream to the remote peer

Methods inherited from class java.lang.Object

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

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

getId, getLocalAddress, getPushedLineHandlerCount, getRemoteAddress, isReadable, isStartTLSSupported, isTLSStarted, popLineHandler, pushLineHandler, setReadable

Constructor Detail

AbstractProtocolTransport

public AbstractProtocolTransport()

Method Detail

writeResponse

public final void writeResponse(Response response,
                 ProtocolSession session)

Description copied from interface: ProtocolTransport

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

Specified by:

writeResponse in interface ProtocolTransport

See Also:

ProtocolTransport.writeResponse(org.apache.james.protocols.api.Response, org.apache.james.protocols.api.ProtocolSession)

writeResponseToClient

protected void writeResponseToClient(Response response,
                         ProtocolSession session)

Write the Response to the client

Parameters:

response -

session -

toBytes

protected static byte[] toBytes(Response response)

Take the Response and encode it to a byte array

Parameters:

response -

Returns:

bytes

writeToClient

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

Write the given byte's to the remote peer

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

writeToClient

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

Write the given InputStream to the remote peer

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

close

protected abstract void close()

Close the Transport