asia.stampy.client.listener.disconnect

Class AbstractDisconnectListenerAndInterceptor<CLNT extends AbstractStampyMessageGateway>

java.lang.Object

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

asia.stampy.client.listener.disconnect.AbstractDisconnectListenerAndInterceptor<CLNT>

All Implemented Interfaces:

StampyMessageListener, StampyOutgoingMessageInterceptor

Direct Known Subclasses:

NettyDisconnectListenerAndInterceptor

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

This class intercepts an outgoing StompMessageType.DISCONNECT message if a receipt has been requested. When the receipt from the server arrives the isCloseOnDisconnectMessage() is evaluated and if true the session is closed.

To do a graceful shutdown, where the client is assured that all previous frames have been received by the server, the client SHOULD: send a DISCONNECT frame with a receipt header set. Example: DISCONNECT receipt:77 ^@ wait for the RECEIPT frame response to the DISCONNECT. Example: RECEIPT receipt-id:77 ^@ close the socket session.

Constructor Summary

Constructors

Constructor and Description
AbstractDisconnectListenerAndInterceptor()

Method Summary

Methods

Modifier and Type	Method and Description
StompMessageType[]	getMessageTypes() Gets the message types of which the implementation is interested.
java.lang.String	getReceiptId() Gets the receipt id.
void	interceptMessage(StampyMessage<?> message, HostPort hostPort) Intercepts the outgoing message for capturing state etc, invoked by the.
boolean	isCloseOnDisconnectMessage() Checks if is close on disconnect message.
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	setCloseOnDisconnectMessage(boolean closeOnDisconnectMessage) Inject the desired behaviour on system startup.
void	setReceiptId(java.lang.String receiptId) Sets the receipt id.

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

getGateway, interceptMessage, setGateway

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDisconnectListenerAndInterceptor

public AbstractDisconnectListenerAndInterceptor()

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

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

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

isCloseOnDisconnectMessage

public boolean isCloseOnDisconnectMessage()

Checks if is close on disconnect message.

Returns:

true, if is close on disconnect message

setCloseOnDisconnectMessage

public void setCloseOnDisconnectMessage(boolean closeOnDisconnectMessage)

Inject the desired behaviour on system startup.

Parameters:

closeOnDisconnectMessage - the new close on disconnect message

getReceiptId

public java.lang.String getReceiptId()

Gets the receipt id.

Returns:

the receipt id

setReceiptId

public void setReceiptId(java.lang.String receiptId)

Sets the receipt id.

Parameters:

receiptId - the new receipt id