org.atmosphere.stomp.interceptor

Class FrameInterceptor

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

org.atmosphere.stomp.interceptor.FrameInterceptor

All Implemented Interfaces:

org.atmosphere.cpr.AtmosphereInterceptor, org.atmosphere.inject.AtmosphereConfigAware, org.atmosphere.interceptor.InvokationOrder, StompInterceptor

public class FrameInterceptor
extends org.atmosphere.cpr.AtmosphereInterceptorAdapter
implements StompInterceptor

This interceptor reads the frames and parse it thanks to the StompFormat. When the message is parsed, the interceptor delegates an appropriate treatment to a StompInterceptor.

This interceptor should be executed before the AtmosphereResourceLifecycleInterceptor to suspends the connection. Then it could add any AtmosphereResource to a Broadcaster if necessary.

Since:

0.1

Version:

1.0

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FrameInterceptor.PropertyClass This enum is dedicated to properties that represents a class to instantiate.
class	FrameInterceptor.StompAtmosphereResource Inner class that wraps the AtmosphereResource during inspection to write frame and check the nature of the operations.

Nested classes/interfaces inherited from interface org.atmosphere.interceptor.InvokationOrder

org.atmosphere.interceptor.InvokationOrder.PRIORITY

Field Summary

Fields

Modifier and Type	Field and Description
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.

Fields inherited from interface org.atmosphere.interceptor.InvokationOrder

AFTER_DEFAULT, BEFORE_DEFAULT, FIRST_BEFORE_DEFAULT

Constructor Summary

Constructors

Constructor and Description
FrameInterceptor()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(org.atmosphere.cpr.AtmosphereConfig config)
org.atmosphere.cpr.Action	inspect(org.atmosphere.cpr.AtmosphereFramework framework, Frame frame, FrameInterceptor.StompAtmosphereResource r) Inspects the AtmosphereResource with its extracted Frame.
org.atmosphere.cpr.Action	inspect(org.atmosphere.cpr.AtmosphereResource r)
void	postInspect(org.atmosphere.cpr.AtmosphereResource atmosphereResource)
void	setStompFormat(StompFormat stompFormat) Sets the StompFormat that wire frames.

Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorAdapter

destroy, priority, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.atmosphere.cpr.AtmosphereInterceptor

destroy

Field Detail

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

FrameInterceptor

public FrameInterceptor()

Method Detail

configure

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

Specified by:

configure in interface org.atmosphere.inject.AtmosphereConfigAware

Overrides:

configure in class org.atmosphere.cpr.AtmosphereInterceptorAdapter

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.cpr.AtmosphereInterceptorAdapter

postInspect

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

Specified by:

postInspect in interface org.atmosphere.cpr.AtmosphereInterceptor

Overrides:

postInspect in class org.atmosphere.cpr.AtmosphereInterceptorAdapter

inspect

public org.atmosphere.cpr.Action inspect(org.atmosphere.cpr.AtmosphereFramework framework,
                                Frame frame,
                                FrameInterceptor.StompAtmosphereResource r)
                                  throws IOException

Inspects the AtmosphereResource with its extracted Frame.

Specified by:

inspect in interface StompInterceptor

Parameters:

framework - the framework

frame - the frame

r - the resource

Throws:

IOException - if inspection fails

setStompFormat

public void setStompFormat(StompFormat stompFormat)

Sets the StompFormat that wire frames.

Parameters:

stompFormat - the new formatter