asia.stampy.common.mina

Class StampyMinaHandler

java.lang.Object

org.apache.mina.core.service.IoHandlerAdapter

asia.stampy.common.mina.StampyMinaHandler

All Implemented Interfaces:

org.apache.mina.core.service.IoHandler

Direct Known Subclasses:

ClientMinaHandler, ServerMinaHandler, StampyRawStringHandler

@StampyLibrary(libraryName="stampy-MINA-client-server-RI")
public abstract class StampyMinaHandler
extends org.apache.mina.core.service.IoHandlerAdapter

This class is an abstract implementation of a MINA IoHandler for the receipt of STOMP messages. It uses a MINA prefixed message payload to determine message start and end, and as such violates the STOMP 1.2 specification. Subclasses must only be used in an all-Stampy environment.

As the MINA framework performs a much better job at parsing messages of which it understands, subclasses of this class are recommended to be used in an all-Stampy environment.

Subclasses are singletons, wire in appropriately.

See Also:

StampyRawStringHandler

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.charset.Charset	CHARSET The default encoding for STOMP is UTF-8.
protected StampyHandlerHelper	helper

Constructor Summary

Constructors

Constructor and Description
StampyMinaHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	asyncProcessing(HostPort hostPort, java.lang.String msg) Once simple validation has been performed on the received message a Runnable is executed by a single thread executor.
void	exceptionCaught(org.apache.mina.core.session.IoSession session, java.lang.Throwable cause)
java.util.concurrent.Executor	getExecutor() Gets the executor.
org.apache.mina.filter.codec.ProtocolCodecFactory	getFactory(int maxMessageSize) Returns a PrefixedStringCodecFactory allowing messages of maxMessageSize.
AbstractStampyMessageGateway	getGateway() Gets the message gateway.
StampyHeartbeatContainer	getHeartbeatContainer() Gets the heartbeat container.
StompMessageParser	getParser() Gets the parser.
UnparseableMessageHandler	getUnparseableMessageHandler() Returns the UnparseableMessageHandler, defaults to DefaultUnparseableMessageHandler.
protected void	illegalAccess(org.apache.mina.core.session.IoSession session) Writes a context-less error to the session and terminates the session.
void	messageReceived(org.apache.mina.core.session.IoSession session, java.lang.Object message)
void	setExecutor(java.util.concurrent.Executor executor) Sets the executor.
void	setGateway(AbstractStampyMessageGateway gateway) Sets the message gateway.
void	setHeartbeatContainer(StampyHeartbeatContainer heartbeatContainer) Sets the heartbeat container.
void	setParser(StompMessageParser parser) Sets the parser.
void	setUnparseableMessageHandler(UnparseableMessageHandler unparseableMessageHandler) Inject the appropriate UnparseableMessageHandler on system startup.

Methods inherited from class org.apache.mina.core.service.IoHandlerAdapter

messageSent, sessionClosed, sessionCreated, sessionIdle, sessionOpened

Methods inherited from class java.lang.Object

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

Field Detail

CHARSET

public static java.nio.charset.Charset CHARSET

The default encoding for STOMP is UTF-8.

helper

protected StampyHandlerHelper helper

Constructor Detail

StampyMinaHandler

public StampyMinaHandler()

Method Detail

messageReceived

public void messageReceived(org.apache.mina.core.session.IoSession session,
                   java.lang.Object message)
                     throws java.lang.Exception

Specified by:

messageReceived in interface org.apache.mina.core.service.IoHandler

Overrides:

messageReceived in class org.apache.mina.core.service.IoHandlerAdapter

Throws:

java.lang.Exception

getFactory

public org.apache.mina.filter.codec.ProtocolCodecFactory getFactory(int maxMessageSize)

Returns a PrefixedStringCodecFactory allowing messages of maxMessageSize.

Parameters:

maxMessageSize - the max message size

Returns:

the factory

asyncProcessing

protected void asyncProcessing(HostPort hostPort,
                   java.lang.String msg)

Once simple validation has been performed on the received message a Runnable is executed by a single thread executor. This pulls the messages off the thread MINA uses and ensures the messages are processed in the order they are received.

Parameters:

hostPort - the host port

msg - the msg

illegalAccess

protected void illegalAccess(org.apache.mina.core.session.IoSession session)

Writes a context-less error to the session and terminates the session.

Parameters:

session - the session

getParser

public StompMessageParser getParser()

Gets the parser.

Returns:

the parser

setParser

public void setParser(StompMessageParser parser)

Sets the parser.

Parameters:

parser - the new parser

getHeartbeatContainer

public StampyHeartbeatContainer getHeartbeatContainer()

Gets the heartbeat container.

Returns:

the heartbeat container

setHeartbeatContainer

public void setHeartbeatContainer(StampyHeartbeatContainer heartbeatContainer)

Sets the heartbeat container.

Parameters:

heartbeatContainer - the new heartbeat container

getGateway

public AbstractStampyMessageGateway getGateway()

Gets the message gateway.

Returns:

the message gateway

setGateway

public void setGateway(AbstractStampyMessageGateway gateway)

Sets the message gateway.

Parameters:

gateway - the new message gateway

getExecutor

public java.util.concurrent.Executor getExecutor()

Gets the executor.

Returns:

the executor

setExecutor

public void setExecutor(java.util.concurrent.Executor executor)

Sets the executor.

Parameters:

executor - the new executor

getUnparseableMessageHandler

public UnparseableMessageHandler getUnparseableMessageHandler()

Returns the UnparseableMessageHandler, defaults to DefaultUnparseableMessageHandler.

Returns:

the unparseable message handler

setUnparseableMessageHandler

public void setUnparseableMessageHandler(UnparseableMessageHandler unparseableMessageHandler)

Inject the appropriate UnparseableMessageHandler on system startup.

Parameters:

unparseableMessageHandler - the new unparseable message handler

exceptionCaught

public void exceptionCaught(org.apache.mina.core.session.IoSession session,
                   java.lang.Throwable cause)
                     throws java.lang.Exception

Specified by:

exceptionCaught in interface org.apache.mina.core.service.IoHandler

Overrides:

exceptionCaught in class org.apache.mina.core.service.IoHandlerAdapter

Throws:

java.lang.Exception