org.atmosphere.client
Class JSONPTransportFilter

java.lang.Object
  org.atmosphere.client.JSONPTransportFilter

All Implemented Interfaces:

BroadcastFilter, PerRequestBroadcastFilter

public class JSONPTransportFilter
extends Object
implements PerRequestBroadcastFilter

A BroadcastFilter that add support for jQuery.atmosphere.js JSONP_TRANSPORT support.

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested classes/interfaces inherited from interface org.atmosphere.cpr.BroadcastFilter

BroadcastFilter.BroadcastAction

Constructor Summary

JSONPTransportFilter()

Method Summary

BroadcastFilter.BroadcastAction	filter(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object message) Transform or Filter a message per request, with V as an indicator.
BroadcastFilter.BroadcastAction	filter(Object originalMessage, Object message) Transform or Filter a message.

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONPTransportFilter

public JSONPTransportFilter()

Method Detail

filter

public BroadcastFilter.BroadcastAction filter(javax.servlet.http.HttpServletRequest request,
                                              javax.servlet.http.HttpServletResponse response,
                                              Object message)

Description copied from interface: PerRequestBroadcastFilter

Transform or Filter a message per request, with V as an indicator. Be careful when setting headers on the HttpServletResponse as the headers may have been already sent back to the browser.

Specified by:

filter in interface PerRequestBroadcastFilter

Parameters:

request - The HttpServletRequest send before the response was suspended/upgraded.

response - The suspended HttpServletResponse.

message - Object a message

Returns:

a transformed message.

filter

public BroadcastFilter.BroadcastAction filter(Object originalMessage,
                                              Object message)

Description copied from interface: BroadcastFilter

Transform or Filter a message. Return null to tell the associated Broadcaster to discard the message, e.g to not broadcast it.

Specified by:

filter in interface BroadcastFilter

Parameters:

originalMessage - The original message which was Broadcaster.broadcast(Object);

message - Object a message

Returns:

a transformed message.