org.apache.james.protocols.api

Class ProtocolSessionImpl

java.lang.Object

org.apache.james.protocols.api.ProtocolSessionImpl

All Implemented Interfaces:

ProtocolSession

Direct Known Subclasses:

POP3SessionImpl, SMTPSessionImpl

public class ProtocolSessionImpl
extends Object
implements ProtocolSession

Basic implementation of ProtocolSession

Nested Class Summary

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

ProtocolSession.State

Field Summary

Fields

Modifier and Type	Field and Description
protected ProtocolConfiguration	config

Constructor Summary

Constructors

Constructor and Description
ProtocolSessionImpl(Logger logger, ProtocolTransport transport, ProtocolConfiguration config)

Method Summary

Methods

Modifier and Type	Method and Description
Object	getAttachment(String key, ProtocolSession.State state) Return the value which is stored for the given key in the specified ProtocolSession.State or null if non was stored before.
Charset	getCharset() Returns a Charset for US-ASCII
ProtocolConfiguration	getConfiguration() Return the ProtocolConfiguration
Map<String,Object>	getConnectionState() Returns Map that consists of the state of the ProtocolSession per connection
String	getLineDelimiter() Returns "\r\n";
InetSocketAddress	getLocalAddress() Return the InetSocketAddress of the local bound address
Logger	getLogger() Gets the context sensitive log for this session.
ProtocolTransport	getProtocolTransport() Return the wrapped ProtocolTransport which is used for this ProtocolSession
int	getPushedLineHandlerCount() Return the size of the pushed LineHandler
InetSocketAddress	getRemoteAddress() Return the InetSocketAddress of the remote peer
String	getSessionID() Return the ID for the session
Map<String,Object>	getState() Return Map which can be used to store objects within a session
String	getUser() Returns the user name associated with this interaction.
boolean	isStartTLSSupported() Return true if StartTLS is supported by the configuration
boolean	isTLSStarted() Return true if the starttls was started
Response	newFatalErrorResponse() This implementation just returns null.
Response	newLineTooLongResponse() This implementation just returns null.
void	popLineHandler() Pop the last command handler
<T extends ProtocolSession> void	pushLineHandler(LineHandler<T> overrideCommandHandler) Put a new line handler in the chain
void	resetState() This implementation just clears the sessions state.
Object	setAttachment(String key, Object value, ProtocolSession.State state) Store the given value with the given key in the specified ProtocolSession.State.
void	setUser(String user) Sets the user name associated with this interaction.

Methods inherited from class java.lang.Object

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

Field Detail

config

protected final ProtocolConfiguration config

Constructor Detail

ProtocolSessionImpl

public ProtocolSessionImpl(Logger logger,
                   ProtocolTransport transport,
                   ProtocolConfiguration config)

Method Detail

getLocalAddress

public InetSocketAddress getLocalAddress()

Description copied from interface: ProtocolSession

Return the InetSocketAddress of the local bound address

Specified by:

getLocalAddress in interface ProtocolSession

Returns:

local

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Description copied from interface: ProtocolSession

Return the InetSocketAddress of the remote peer

Specified by:

getRemoteAddress in interface ProtocolSession

Returns:

address

getUser

public String getUser()

Description copied from interface: ProtocolSession

Returns the user name associated with this interaction.

Specified by:

getUser in interface ProtocolSession

Returns:

the user name

See Also:

ProtocolSession.getUser()

setUser

public void setUser(String user)

Description copied from interface: ProtocolSession

Sets the user name associated with this interaction.

Specified by:

setUser in interface ProtocolSession

Parameters:

user - the user name

See Also:

ProtocolSession.setUser(java.lang.String)

getProtocolTransport

public ProtocolTransport getProtocolTransport()

Return the wrapped ProtocolTransport which is used for this ProtocolSession

Returns:

transport

isStartTLSSupported

public boolean isStartTLSSupported()

Description copied from interface: ProtocolSession

Return true if StartTLS is supported by the configuration

Specified by:

isStartTLSSupported in interface ProtocolSession

Returns:

supported

See Also:

ProtocolSession.isStartTLSSupported()

isTLSStarted

public boolean isTLSStarted()

Description copied from interface: ProtocolSession

Return true if the starttls was started

Specified by:

isTLSStarted in interface ProtocolSession

Returns:

true

See Also:

ProtocolSession.isTLSStarted()

getLogger

public Logger getLogger()

Description copied from interface: ProtocolSession

Gets the context sensitive log for this session.

Specified by:

getLogger in interface ProtocolSession

Returns:

log, not null

See Also:

ProtocolSession.getLogger()

getSessionID

public String getSessionID()

Description copied from interface: ProtocolSession

Return the ID for the session

Specified by:

getSessionID in interface ProtocolSession

Returns:

id

See Also:

ProtocolSession.getSessionID()

getConnectionState

public Map<String,Object> getConnectionState()

Description copied from interface: ProtocolSession

Returns Map that consists of the state of the ProtocolSession per connection

Specified by:

getConnectionState in interface ProtocolSession

Returns:

map of the current ProtocolSession state per connection

See Also:

ProtocolSession.getConnectionState()

getState

public Map<String,Object> getState()

Description copied from interface: ProtocolSession

Return Map which can be used to store objects within a session

Specified by:

getState in interface ProtocolSession

Returns:

state

See Also:

ProtocolSession.getState()

newLineTooLongResponse

public Response newLineTooLongResponse()

This implementation just returns null. Sub-classes should overwrite this if needed

Specified by:

newLineTooLongResponse in interface ProtocolSession

Returns:

Response or null if no response should be written before closing the connection

newFatalErrorResponse

public Response newFatalErrorResponse()

This implementation just returns null. Sub-classes should overwrite this if needed

Specified by:

newFatalErrorResponse in interface ProtocolSession

Returns:

Response or null if no response should be written before closing the connection

resetState

public void resetState()

This implementation just clears the sessions state. Sub-classes should overwrite this if needed

Specified by:

resetState in interface ProtocolSession

getConfiguration

public ProtocolConfiguration getConfiguration()

Description copied from interface: ProtocolSession

Return the ProtocolConfiguration

Specified by:

getConfiguration in interface ProtocolSession

Returns:

config

See Also:

ProtocolSession.getConfiguration()

setAttachment

public Object setAttachment(String key,
                   Object value,
                   ProtocolSession.State state)

Description copied from interface: ProtocolSession

Store the given value with the given key in the specified ProtocolSession.State. If you want to remove a value you need to use null as value

Specified by:

setAttachment in interface ProtocolSession

Parameters:

key - the key under which the value should get stored

value - the value which will get stored under the given key or null if you want to remove any value which is stored under the key

state - the ProtocolSession.State to which the mapping belongs

Returns:

oldValue the value which was stored before for this key or null if non was stored before.

getAttachment

public Object getAttachment(String key,
                   ProtocolSession.State state)

Description copied from interface: ProtocolSession

Return the value which is stored for the given key in the specified ProtocolSession.State or null if non was stored before.

Specified by:

getAttachment in interface ProtocolSession

Parameters:

key - the key under which the value should be searched

state - the ProtocolSession.State in which the value was stored for the key

Returns:

value the stored value for the key

getCharset

public Charset getCharset()

Returns a Charset for US-ASCII

Specified by:

getCharset in interface ProtocolSession

Returns:

charset

getLineDelimiter

public String getLineDelimiter()

Returns "\r\n";

Specified by:

getLineDelimiter in interface ProtocolSession

Returns:

delimiter

popLineHandler

public void popLineHandler()

Description copied from interface: ProtocolSession

Pop the last command handler

Specified by:

popLineHandler in interface ProtocolSession

getPushedLineHandlerCount

public int getPushedLineHandlerCount()

Description copied from interface: ProtocolSession

Return the size of the pushed LineHandler

Specified by:

getPushedLineHandlerCount in interface ProtocolSession

Returns:

size of the pushed line handler

pushLineHandler

public <T extends ProtocolSession> void pushLineHandler(LineHandler<T> overrideCommandHandler)

Description copied from interface: ProtocolSession

Put a new line handler in the chain

Specified by:

pushLineHandler in interface ProtocolSession