org.apache.james.protocols.api

Interface ProtocolSession

All Known Subinterfaces:

IMAPSession, POP3Session, SMTPSession

All Known Implementing Classes:

POP3SessionImpl, ProtocolSessionImpl, SMTPSessionImpl

public interface ProtocolSession

Session for a protocol. Every new connection generates a new session

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ProtocolSession.State

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() Return the Charset which is used by the ProtocolSession
ProtocolConfiguration	getConfiguration() Return the ProtocolConfiguration
Map<String,Object>	getConnectionState() Deprecated. use getAttachment(String, State)
String	getLineDelimiter() Return the line delimiter which is used
InetSocketAddress	getLocalAddress() Return the InetSocketAddress of the local bound address
Logger	getLogger() Gets the context sensitive log for this session.
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() Deprecated. use setAttachment(String, Object, State)
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() Define a response object to be used as reply during a fatal error.
Response	newLineTooLongResponse() Define a response object to be used as reply for a too long input line
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() Reset the 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.

Method Detail

getLogger

Logger getLogger()

Gets the context sensitive log for this session.

Returns:

log, not null

setAttachment

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

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

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

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.

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

getState

@Deprecated
Map<String,Object> getState()

Deprecated. use setAttachment(String, Object, State)

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

Returns:

state

getConnectionState

@Deprecated
Map<String,Object> getConnectionState()

Deprecated. use getAttachment(String, State)

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

Returns:

map of the current ProtocolSession state per connection

resetState

void resetState()

Reset the state

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

getSessionID

String getSessionID()

Return the ID for the session

Returns:

id

newLineTooLongResponse

Response newLineTooLongResponse()

Define a response object to be used as reply for a too long input line

Returns:

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

newFatalErrorResponse

Response newFatalErrorResponse()

Define a response object to be used as reply during a fatal error. Connection will be closed after this response.

Returns:

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

getUser

String getUser()

Returns the user name associated with this interaction.

Returns:

the user name

setUser

void setUser(String user)

Sets the user name associated with this interaction.

Parameters:

user - the user name

isStartTLSSupported

boolean isStartTLSSupported()

Return true if StartTLS is supported by the configuration

Returns:

supported

isTLSStarted

boolean isTLSStarted()

Return true if the starttls was started

Returns:

true

getConfiguration

ProtocolConfiguration getConfiguration()

Return the ProtocolConfiguration

Returns:

config

getCharset

Charset getCharset()

Return the Charset which is used by the ProtocolSession

Returns:

charset

getLineDelimiter

String getLineDelimiter()

Return the line delimiter which is used

Returns:

delimiter

pushLineHandler

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

Put a new line handler in the chain

Parameters:

overrideCommandHandler -

popLineHandler

void popLineHandler()

Pop the last command handler

getPushedLineHandlerCount

int getPushedLineHandlerCount()

Return the size of the pushed LineHandler

Returns:

size of the pushed line handler