org.atmosphere.stomp.interceptor

Class BeginInterceptor

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

org.atmosphere.stomp.interceptor.BeginInterceptor

All Implemented Interfaces:

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

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

Begins a transaction for the given AtmosphereResource.

A transaction ID is generated that could be specified in future Action.SEND to include their result in the transaction.

In that case, all SendInterceptor operation results won't be dispatched by the Broadcaster until the AtmosphereResource sends a commit frame for the associated transaction ID.

Since:

0.2

Version:

1.0

Author:

Guillaume DROUET

Nested Class Summary

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

org.atmosphere.interceptor.InvokationOrder.PRIORITY

Field Summary

Fields inherited from interface org.atmosphere.interceptor.InvokationOrder

AFTER_DEFAULT, BEFORE_DEFAULT, FIRST_BEFORE_DEFAULT

Constructor Summary

Constructors

Constructor and Description
BeginInterceptor()

Method Summary

Methods

Modifier and Type	Method and Description
org.atmosphere.cpr.Action	inspect(org.atmosphere.cpr.AtmosphereFramework framework, Frame frame, FrameInterceptor.StompAtmosphereResource r) Inspects the AtmosphereResource with its extracted Frame.

Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorAdapter

configure, destroy, inspect, postInspect, 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, inspect, postInspect

Methods inherited from interface org.atmosphere.inject.AtmosphereConfigAware

configure

Constructor Detail

BeginInterceptor

public BeginInterceptor()

Method Detail

inspect

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

Inspects the AtmosphereResource with its extracted Frame.

Specified by:

inspect in interface StompInterceptor

Parameters:

framework - the framework

frame - the frame

r - the resource