asia.stampy.server.listener.subscription

Class AbstractAcknowledgementListenerAndInterceptor<SVR extends AbstractStampyMessageGateway>

java.lang.Object

asia.stampy.common.message.interceptor.AbstractOutgoingMessageInterceptor<SVR>

asia.stampy.server.listener.subscription.AbstractAcknowledgementListenerAndInterceptor<SVR>

All Implemented Interfaces:

StampyMessageListener, StampyOutgoingMessageInterceptor

Direct Known Subclasses:

NettyAcknowledgementListenerAndInterceptor

@StampyLibrary(libraryName="stampy-client-server")
public abstract class AbstractAcknowledgementListenerAndInterceptor<SVR extends AbstractStampyMessageGateway>
extends AbstractOutgoingMessageInterceptor<SVR>
implements StampyMessageListener

This class assists in the publication of StompMessageType.MESSAGE messages for a subscription. If confirmation of the publication is requested a timer is created to await receipt of the confirmation, and the appropriate methods of the StampyAcknowledgementHandler implementation are invoked.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<HostPort,java.util.Queue<java.lang.String>>	messages The messages.

Constructor Summary

Constructors

Constructor and Description
AbstractAcknowledgementListenerAndInterceptor()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	ensureCleanup() Configure the gateway to clean up the map of expected acks on session termination.
long	getAckTimeoutMillis() Gets the ack timeout millis.
StampyAcknowledgementHandler	getHandler() Gets the handler.
StompMessageType[]	getMessageTypes() Gets the message types of which the implementation is interested.
void	interceptMessage(StampyMessage<?> message, HostPort hostPort) Intercepts the outgoing message for capturing state etc, invoked by the.
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	setAckTimeoutMillis(long ackTimeoutMillis) Sets the ack timeout millis.
void	setGateway(SVR gateway) Sets the gateway.
void	setHandler(StampyAcknowledgementHandler handler) Inject the StampyAcknowledgementHandler implementation on system startup.

Methods inherited from class asia.stampy.common.message.interceptor.AbstractOutgoingMessageInterceptor

getGateway, interceptMessage

Methods inherited from class java.lang.Object

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

Field Detail

messages

protected java.util.Map<HostPort,java.util.Queue<java.lang.String>> messages

The messages.

Constructor Detail

AbstractAcknowledgementListenerAndInterceptor

public AbstractAcknowledgementListenerAndInterceptor()

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

Specified by:

getMessageTypes in interface StampyOutgoingMessageInterceptor

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

Specified by:

isForMessage in interface StampyOutgoingMessageInterceptor

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

interceptMessage

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

Description copied from interface: StampyOutgoingMessageInterceptor

Intercepts the outgoing message for capturing state etc, invoked by the.

Specified by:

interceptMessage in interface StampyOutgoingMessageInterceptor

Parameters:

message - the message

hostPort - the host port

Throws:

InterceptException - if the outgoing message is to be aborted AbstractStampyMessageGateway

See Also:

AbstractStampyMessageGateway

getAckTimeoutMillis

public long getAckTimeoutMillis()

Gets the ack timeout millis.

Returns:

the ack timeout millis

setAckTimeoutMillis

public void setAckTimeoutMillis(long ackTimeoutMillis)

Sets the ack timeout millis. Initialize appropriately on system startup. Defaults to 60 seconds (60000).

Parameters:

ackTimeoutMillis - the new ack timeout millis

setGateway

public void setGateway(SVR gateway)

Sets the gateway.

Overrides:

setGateway in class AbstractOutgoingMessageInterceptor<SVR extends AbstractStampyMessageGateway>

Parameters:

gateway - the new gateway

ensureCleanup

protected abstract void ensureCleanup()

Configure the gateway to clean up the map of expected acks on session termination.

getHandler

public StampyAcknowledgementHandler getHandler()

Gets the handler.

Returns:

the handler

setHandler

public void setHandler(StampyAcknowledgementHandler handler)

Inject the StampyAcknowledgementHandler implementation on system startup.

Parameters:

handler - the new handler