org.atmosphere.stomp

Interface StompInterceptor

All Superinterfaces:

org.atmosphere.inject.AtmosphereConfigAware, org.atmosphere.cpr.AtmosphereInterceptor

All Known Implementing Classes:

AbortInterceptor, BeginInterceptor, CommitInterceptor, ConnectInterceptor, DisconnectInterceptor, FrameInterceptor, SendInterceptor, SubscribeInterceptor, UnsubscribeInterceptor

public interface StompInterceptor
extends org.atmosphere.cpr.AtmosphereInterceptor

A StompInterceptor is an extension of AtmosphereInterceptor to inspect an AtmosphereResource that contains in its request body a Frame.

This interface adapts all the operations sent to atmosphere using the STOMP protocol. The purpose is to map existing Atmosphere features to the actions that could be performed with several STOMP frames.

Any method of this interface should be invoked when a frame has been validated. Consequently, implementation could assert that all mandatory headers will be specified in parameter when declared in method signature.

Since:

0.1

Version:

1.0

Author:

Guillaume DROUET

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 interface org.atmosphere.cpr.AtmosphereInterceptor

destroy, inspect, postInspect

Methods inherited from interface org.atmosphere.inject.AtmosphereConfigAware

configure

Method Detail

inspect

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

Inspects the AtmosphereResource with its extracted Frame.

Parameters:

framework - the framework

frame - the frame

r - the resource

Throws:

IOException - if inspection fails