asia.stampy.server.listener.login

Class AbstractLoginMessageListener<SVR extends AbstractStampyMessageGateway>

java.lang.Object

asia.stampy.server.listener.login.AbstractLoginMessageListener<SVR>

All Implemented Interfaces:

StampyMessageListener

Direct Known Subclasses:

NettyLoginMessageListener

@StampyLibrary(libraryName="stampy-client-server")
public abstract class AbstractLoginMessageListener<SVR extends AbstractStampyMessageGateway>
extends java.lang.Object
implements StampyMessageListener

This class enforces login functionality via the implementation of a. StampyLoginHandler. Should the login handler throw a TerminateSessionException this class will send an error to the client, close the session and throw a MessageListenerHaltException to prevent downstream processing of the message by the remaining StampyMessageListeners.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Queue<HostPort>	loggedInConnections The logged in connections.

Constructor Summary

Constructors

Constructor and Description
AbstractLoginMessageListener()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	ensureCleanup() Configure the gateway to clean up the queue of logged in connections on session termination.
SVR	getGateway() Gets the gateway.
StampyLoginHandler	getLoginHandler() Gets the login handler.
StompMessageType[]	getMessageTypes() Gets the message types of which the implementation is interested.
boolean	isForMessage(StampyMessage<?> message) Returns true if the message should be processed by the implementation.
void	messageReceived(StampyMessage<?> message, HostPort hostPort) Invoked when the type and the message are to be processed by the implementation.
void	setGateway(SVR gateway) Inject the AbstractStampyMessageGateway on system startup.
void	setLoginHandler(StampyLoginHandler loginHandler) Inject the implementation of StampyLoginHandler on system startup.

Methods inherited from class java.lang.Object

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

Field Detail

loggedInConnections

protected java.util.Queue<HostPort> loggedInConnections

The logged in connections.

Constructor Detail

AbstractLoginMessageListener

public AbstractLoginMessageListener()

Method Detail

getMessageTypes

public StompMessageType[] getMessageTypes()

Description copied from interface: StampyMessageListener

Gets the message types of which the implementation is interested.

Specified by:

getMessageTypes in interface StampyMessageListener

Returns:

the message types

isForMessage

public boolean isForMessage(StampyMessage<?> message)

Description copied from interface: StampyMessageListener

Returns true if the message should be processed by the implementation.

Specified by:

isForMessage in interface StampyMessageListener

Parameters:

message - the message

Returns:

true, if is for message

messageReceived

public void messageReceived(StampyMessage<?> message,
                   HostPort hostPort)
                     throws java.lang.Exception

Description copied from interface: StampyMessageListener

Invoked when the type and the message are to be processed by the implementation.

Specified by:

messageReceived in interface StampyMessageListener

Parameters:

message - the message

hostPort - the host port

Throws:

java.lang.Exception - the exception

getLoginHandler

public StampyLoginHandler getLoginHandler()

Gets the login handler.

Returns:

the login handler

setLoginHandler

public void setLoginHandler(StampyLoginHandler loginHandler)

Inject the implementation of StampyLoginHandler on system startup.

Parameters:

loginHandler - the new login handler

getGateway

public SVR getGateway()

Gets the gateway.

Returns:

the gateway

setGateway

public void setGateway(SVR gateway)

Inject the AbstractStampyMessageGateway on system startup.

Parameters:

gateway - the new gateway

ensureCleanup

protected abstract void ensureCleanup()

Configure the gateway to clean up the queue of logged in connections on session termination.