org.atmosphere.cpr
Interface PerRequestBroadcastFilter

All Superinterfaces:

BroadcastFilter

All Known Implementing Classes:

TrackMessageSizeFilter

public interface PerRequestBroadcastFilter
extends BroadcastFilter

A markable interface that can be used in conjonction with BroadcastFilter to filter message per request.

Nested Class Summary

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

BroadcastFilter.BroadcastAction

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.

Methods inherited from interface org.atmosphere.cpr.BroadcastFilter

filter

Method Detail

filter

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. Be careful when setting headers on the HttpServletResponse as the headers may have been already sent back to the browser.

Parameters:

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

response - The suspended HttpServletResponse.

message - Object a message

Returns:

a transformed message.