org.atmosphere.stomp

Class StompInterceptor

java.lang.Object

org.atmosphere.interceptor.AtmosphereResourceLifecycleInterceptor

org.atmosphere.stomp.StompInterceptor

All Implemented Interfaces:

org.atmosphere.cpr.AtmosphereInterceptor

public class StompInterceptor
extends org.atmosphere.interceptor.AtmosphereResourceLifecycleInterceptor

This interceptor reads the messages and parse it thanks to the Parser. When the message is parsed, the interceptor invokes a method provided by an AtmosphereInterceptorAdapter according to the Action specified inside the message.

This interceptor inherits from the AtmosphereResourceLifecycleInterceptor to suspends the connection. Then it could add any AtmosphereResource to a Broadcaster if necessary.

This interceptor expects by default that all messages respect the STOMP protocol. It could be fault tolerant for messages not respecting STOMP by setting the IGNORE_ERROR setting in atmosphere.xml or web.xml file.

By default the interceptor uses by default AtmosphereStompAdapterImpl to delegate the frame processing. User can set its own implementation by specifying the class name in StompInterceptor.PropertyClass.ADAPTER_CLASS setting in atmosphere.xml or web.xml file.

Since:

0.1

Version:

1.0

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StompInterceptor.PropertyClass This enum is dedicated to properties that represents a class to instantiate.

Field Summary

Fields

Modifier and Type	Field and Description
static String	IGNORE_ERROR Setting that specifies if the interceptor ignores messages that don't respect STOMP protocol.
static String	STOMP_MESSAGE_BODY The attribute name this interceptor uses to inject a parsed body in the request when it is extracted from the frame.

Constructor Summary

Constructors

Constructor and Description
StompInterceptor()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(org.atmosphere.cpr.AtmosphereConfig config)
org.atmosphere.cpr.Action	inspect(org.atmosphere.cpr.AtmosphereResource r)
void	postInspect(org.atmosphere.cpr.AtmosphereResource atmosphereResource)

Methods inherited from class org.atmosphere.interceptor.AtmosphereResourceLifecycleInterceptor

method, method, timeoutInSeconds, timeoutInSeconds, toString

Methods inherited from class java.lang.Object

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

Field Detail

IGNORE_ERROR

public static final String IGNORE_ERROR

Setting that specifies if the interceptor ignores messages that don't respect STOMP protocol.

See Also:

Constant Field Values

STOMP_MESSAGE_BODY

public static final String STOMP_MESSAGE_BODY

The attribute name this interceptor uses to inject a parsed body in the request when it is extracted from the frame.

See Also:

Constant Field Values

Constructor Detail

StompInterceptor

public StompInterceptor()

Method Detail

configure

public void configure(org.atmosphere.cpr.AtmosphereConfig config)

Specified by:

configure in interface org.atmosphere.cpr.AtmosphereInterceptor

Overrides:

configure in class org.atmosphere.interceptor.AtmosphereResourceLifecycleInterceptor

inspect

public org.atmosphere.cpr.Action inspect(org.atmosphere.cpr.AtmosphereResource r)

Specified by:

inspect in interface org.atmosphere.cpr.AtmosphereInterceptor

Overrides:

inspect in class org.atmosphere.interceptor.AtmosphereResourceLifecycleInterceptor

postInspect

public void postInspect(org.atmosphere.cpr.AtmosphereResource atmosphereResource)

Specified by:

postInspect in interface org.atmosphere.cpr.AtmosphereInterceptor

Overrides:

postInspect in class org.atmosphere.interceptor.AtmosphereResourceLifecycleInterceptor