org.atmosphere.stomp.interceptor

Class SendInterceptor

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

org.atmosphere.stomp.interceptor.SendInterceptor

All Implemented Interfaces:

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

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

Invokes the method annotated with StompService inside any ManagedService that defines a destination that matched the destination String inside the specified Strings.

The result of the method invocation is dispatched by the Broadcaster identified with the path specified in the given Strings. If no annotated method matches the requested send, then the body is dispatched. Original body or result are sent in a Action.MESSAGE frame. Finally, if the method invocation throws an exception, then an Action.ERROR is sent only to the specified AtmosphereResource that sent the frame.

Note that Broadcaster must not do anything if a transaction has been started by the AtmosphereResource and if this transaction is referenced in frame's Strings.

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
SendInterceptor()

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

SendInterceptor

public SendInterceptor()

Method Detail

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