asia.stampy.common.gateway

Class AbstractStampyMessageGateway

java.lang.Object

asia.stampy.common.gateway.AbstractStampyMessageGateway

Direct Known Subclasses:

AbstractStampyNettyMessageGateway

@StampyLibrary(libraryName="stampy-client-server")
public abstract class AbstractStampyMessageGateway
extends java.lang.Object

A StampyMessageGateway is the interface between the technology used to connect to a STOMP implementation and the Stampy library. It is the class through which STOMP messages are sent and received.

Subclasses are singletons; wire into the system appropriately.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Queue<StampyOutgoingMessageInterceptor>	interceptors The interceptors.
protected java.util.Queue<StampyOutgoingTextInterceptor>	textInterceptors The text interceptors.

Constructor Summary

Constructors

Constructor and Description
AbstractStampyMessageGateway()

Method Summary

Methods

Modifier and Type	Method and Description
void	addMessageListener(StampyMessageListener listener) Adds the message listener.
void	addMessageListener(StampyMessageListener listener, int idx)
void	addOutgoingMessageInterceptor(StampyOutgoingMessageInterceptor interceptor) Adds the specified outgoing message interceptor.
void	addOutgoingTextInterceptor(StampyOutgoingTextInterceptor interceptor) Adds the specified outgoing message interceptor.
void	broadcastMessage(StampyMessage<?> message) Broadcasts a StampyMessage to all connected clients from the server or to the server from a client.
abstract void	broadcastMessage(java.lang.String stompMessage) Broadcasts the specified String to all connections.
void	clearMessageListeners() Clear message listeners.
abstract void	closeConnection(HostPort hostPort) Closes the connection to the STOMP server or client.
abstract void	connect() Connects to a STOMP server or client as specified by configuration.
abstract java.util.Set<HostPort>	getConnectedHostPorts() Gets the connected host ports.
int	getHeartbeat() Gets the heartbeat.
int	getMaxMessageSize()
int	getPort()
UnparseableMessageHandler	getUnparseableMessageHandler() Returns the UnparseableMessageHandler, defaults to.
protected void	interceptOutgoingMessage(StampyMessage<?> message) Intercept outgoing message.
protected void	interceptOutgoingMessage(StampyMessage<?> message, HostPort hostPort) Intercept outgoing message.
protected void	interceptOutgoingMessage(java.lang.String message) Intercept outgoing message.
boolean	isAutoShutdown() If true the gateway will shut down when all sessions are terminated.
abstract boolean	isConnected(HostPort hostPort) Returns true if a connection exists and is active.
protected boolean	isForType(StompMessageType[] messageTypes, StompMessageType messageType) Checks if is for type.
void	notifyMessageListeners(StampyMessage<?> sm, HostPort hostPort) Notify listeners of received StampyMessages.
void	removeMessageListener(StampyMessageListener listener) Removes the message listener.
void	removeOutgoingMessageInterceptor(StampyOutgoingMessageInterceptor interceptor) Removes the specified outgoing message interceptor.
void	removeOutgoingTextInterceptor(StampyOutgoingTextInterceptor interceptor) Removes the specified outgoing message interceptor.
void	sendMessage(StampyMessage<?> message, HostPort hostPort) Sends a StampyMessage to the specified HostPort.
abstract void	sendMessage(java.lang.String stompMessage, HostPort hostPort) Sends the specified String to the specified HostPort.
void	setAutoShutdown(boolean autoShutdown) Sets the auto shutdown.
void	setHeartbeat(int heartbeat) Sets the heartbeat.
void	setListeners(java.util.Collection<StampyMessageListener> listeners) Sets the listeners.
void	setMaxMessageSize(int maxMessageSize)
void	setOutgoingMessageInterceptors(java.util.Collection<StampyOutgoingMessageInterceptor> interceptors) Adds the specified outgoing message interceptors.
void	setOutgoingTextInterceptors(java.util.Collection<StampyOutgoingTextInterceptor> interceptors) Adds the specified outgoing message interceptors.
void	setPort(int port)
void	setUnparseableMessageHandler(UnparseableMessageHandler unparseableMessageHandler) Inject the appropriate UnparseableMessageHandler on system startup.
abstract void	shutdown() Shuts down the underlying connection technology.

Methods inherited from class java.lang.Object

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

Field Detail

interceptors

protected java.util.Queue<StampyOutgoingMessageInterceptor> interceptors

The interceptors.

textInterceptors

protected java.util.Queue<StampyOutgoingTextInterceptor> textInterceptors

The text interceptors.

Constructor Detail

AbstractStampyMessageGateway

public AbstractStampyMessageGateway()

Method Detail

broadcastMessage

public void broadcastMessage(StampyMessage<?> message)
                      throws InterceptException

Broadcasts a StampyMessage to all connected clients from the server or to the server from a client. Use this method for all STOMP messages.

Parameters:

message - the message

Throws:

InterceptException - the intercept exception

addOutgoingMessageInterceptor

public void addOutgoingMessageInterceptor(StampyOutgoingMessageInterceptor interceptor)

Adds the specified outgoing message interceptor.

Parameters:

interceptor - the interceptor

See Also:

StampyOutgoingMessageInterceptor

removeOutgoingMessageInterceptor

public void removeOutgoingMessageInterceptor(StampyOutgoingMessageInterceptor interceptor)

Removes the specified outgoing message interceptor.

Parameters:

interceptor - the interceptor

See Also:

StampyOutgoingMessageInterceptor

setOutgoingMessageInterceptors

public void setOutgoingMessageInterceptors(java.util.Collection<StampyOutgoingMessageInterceptor> interceptors)

Adds the specified outgoing message interceptors. For use by DI frameworks.

Parameters:

interceptors - the new outgoing message interceptors

See Also:

StampyOutgoingMessageInterceptor

addOutgoingTextInterceptor

public void addOutgoingTextInterceptor(StampyOutgoingTextInterceptor interceptor)

Adds the specified outgoing message interceptor.

Parameters:

interceptor - the interceptor

See Also:

StampyOutgoingMessageInterceptor

removeOutgoingTextInterceptor

public void removeOutgoingTextInterceptor(StampyOutgoingTextInterceptor interceptor)

Removes the specified outgoing message interceptor.

Parameters:

interceptor - the interceptor

See Also:

StampyOutgoingMessageInterceptor

setOutgoingTextInterceptors

public void setOutgoingTextInterceptors(java.util.Collection<StampyOutgoingTextInterceptor> interceptors)

Adds the specified outgoing message interceptors. For use by DI frameworks.

Parameters:

interceptors - the new outgoing text interceptors

See Also:

StampyOutgoingMessageInterceptor

sendMessage

public void sendMessage(StampyMessage<?> message,
               HostPort hostPort)
                 throws InterceptException

Sends a StampyMessage to the specified HostPort. Use this method for all STOMP messages.

Parameters:

message - the message

hostPort - the host port

Throws:

InterceptException - the intercept exception

interceptOutgoingMessage

protected final void interceptOutgoingMessage(StampyMessage<?> message)
                                       throws InterceptException

Intercept outgoing message.

Parameters:

message - the message

Throws:

InterceptException - the intercept exception

interceptOutgoingMessage

protected final void interceptOutgoingMessage(StampyMessage<?> message,
                            HostPort hostPort)
                                       throws InterceptException

Intercept outgoing message.

Parameters:

message - the message

hostPort - the host port

Throws:

InterceptException - the intercept exception

interceptOutgoingMessage

protected final void interceptOutgoingMessage(java.lang.String message)
                                       throws InterceptException

Intercept outgoing message.

Parameters:

message - the message

Throws:

InterceptException - the intercept exception

isForType

protected boolean isForType(StompMessageType[] messageTypes,
                StompMessageType messageType)

Checks if is for type.

Parameters:

messageTypes - the message types

messageType - the message type

Returns:

true, if is for type

notifyMessageListeners

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

Notify listeners of received StampyMessages.

Parameters:

sm - the sm

hostPort - the host port

Throws:

java.lang.Exception - the exception

addMessageListener

public final void addMessageListener(StampyMessageListener listener)

Adds the message listener.

Parameters:

listener - the listener

addMessageListener

public final void addMessageListener(StampyMessageListener listener,
                      int idx)

removeMessageListener

public void removeMessageListener(StampyMessageListener listener)

Removes the message listener.

Parameters:

listener - the listener

clearMessageListeners

public void clearMessageListeners()

Clear message listeners.

setListeners

public void setListeners(java.util.Collection<StampyMessageListener> listeners)

Sets the listeners.

Parameters:

listeners - the new listeners

broadcastMessage

public abstract void broadcastMessage(java.lang.String stompMessage)
                               throws InterceptException

Broadcasts the specified String to all connections. Included for STOMP implementations which accept custom message types. Use for all non-STOMP messages.

Parameters:

stompMessage - the stomp message

Throws:

InterceptException - the intercept exception

sendMessage

public abstract void sendMessage(java.lang.String stompMessage,
               HostPort hostPort)
                          throws InterceptException

Sends the specified String to the specified HostPort. Included for STOMP implementations which accept custom message types. Use for all non-STOMP messages.

Parameters:

stompMessage - the stomp message

hostPort - the host port

Throws:

InterceptException - the intercept exception

closeConnection

public abstract void closeConnection(HostPort hostPort)

Closes the connection to the STOMP server or client.

Parameters:

hostPort - the host port

connect

public abstract void connect()
                      throws java.lang.Exception

Connects to a STOMP server or client as specified by configuration.

Throws:

java.lang.Exception - the exception

shutdown

public abstract void shutdown()
                       throws java.lang.Exception

Shuts down the underlying connection technology.

Throws:

java.lang.Exception - the exception

isConnected

public abstract boolean isConnected(HostPort hostPort)

Returns true if a connection exists and is active.

Parameters:

hostPort - the host port

Returns:

true, if is connected

getConnectedHostPorts

public abstract java.util.Set<HostPort> getConnectedHostPorts()

Gets the connected host ports.

Returns:

the connected host ports

isAutoShutdown

public boolean isAutoShutdown()

If true the gateway will shut down when all sessions are terminated. Typically clients will be set to true, servers to false (the default).

Returns:

true, if is auto shutdown

setAutoShutdown

public void setAutoShutdown(boolean autoShutdown)

Sets the auto shutdown.

Parameters:

autoShutdown - the new auto shutdown

getHeartbeat

public int getHeartbeat()

Gets the heartbeat.

Returns:

the heartbeat

setHeartbeat

public void setHeartbeat(int heartbeat)

Sets the heartbeat.

Parameters:

heartbeat - the new heartbeat

getUnparseableMessageHandler

public UnparseableMessageHandler getUnparseableMessageHandler()

Returns the UnparseableMessageHandler, defaults to.

Returns:

the unparseable message handler DefaultUnparseableMessageHandler.

setUnparseableMessageHandler

public void setUnparseableMessageHandler(UnparseableMessageHandler unparseableMessageHandler)

Inject the appropriate UnparseableMessageHandler on system startup.

Parameters:

unparseableMessageHandler - the new unparseable message handler

getPort

public int getPort()

setPort

public void setPort(int port)

getMaxMessageSize

public int getMaxMessageSize()

setMaxMessageSize

public void setMaxMessageSize(int maxMessageSize)