org.atmosphere.interceptor

Class TrackMessageSizeB64Interceptor

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

org.atmosphere.interceptor.TrackMessageSizeB64Interceptor

All Implemented Interfaces:

AtmosphereInterceptor, AtmosphereConfigAware, InvokationOrder

public class TrackMessageSizeB64Interceptor
extends AtmosphereInterceptorAdapter

An AtmosphereInterceptor that adds message size and delimiter, and encodes the message in Base64. This allows for broadcasting of messages containing the delimiter character.

You can configure this class to exclude some response's content-type by using the ApplicationConfig.EXCLUDED_CONTENT_TYPES

Author:

Jeanfrancois Arcand, Martin Mačura

Nested Class Summary

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

InvokationOrder.PRIORITY

Field Summary

Fields

Modifier and Type	Field and Description
static String	SKIP_INTERCEPTOR

Fields inherited from interface org.atmosphere.interceptor.InvokationOrder

AFTER_DEFAULT, BEFORE_DEFAULT, FIRST_BEFORE_DEFAULT

Constructor Summary

Constructors

Constructor and Description
TrackMessageSizeB64Interceptor()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(AtmosphereConfig config) Configure an AtmosphereFramework object.
TrackMessageSizeB64Interceptor	excludedContentType(String excludedContentType) Excluse response's content-type from being processed by this class.
Action	inspect(AtmosphereResource r) Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.
String	toString()

Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorAdapter

destroy, postInspect, priority

Methods inherited from class java.lang.Object

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

Field Detail

SKIP_INTERCEPTOR

public static final String SKIP_INTERCEPTOR

Constructor Detail

TrackMessageSizeB64Interceptor

public TrackMessageSizeB64Interceptor()

Method Detail

configure

public void configure(AtmosphereConfig config)

Description copied from interface: AtmosphereConfigAware

Configure an AtmosphereFramework object.

Specified by:

configure in interface AtmosphereConfigAware

Overrides:

configure in class AtmosphereInterceptorAdapter

Parameters:

config - AtmosphereConfig

excludedContentType

public TrackMessageSizeB64Interceptor excludedContentType(String excludedContentType)

Excluse response's content-type from being processed by this class.

Parameters:

excludedContentType - the value of AtmosphereResponseImpl.getContentType()

Returns:

this

inspect

public Action inspect(AtmosphereResource r)

Description copied from interface: AtmosphereInterceptor

Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.

Specified by:

inspect in interface AtmosphereInterceptor

Overrides:

inspect in class AtmosphereInterceptorAdapter

Parameters:

r - a AtmosphereResource

Returns:

Action.CONTINUE or Action.SUSPEND to dispatch the AtmosphereResource to other AtmosphereInterceptor or AtmosphereHandler. Return Action.TYPE.CANCELLED to stop the processing.

toString

public String toString()

Overrides:

toString in class AtmosphereInterceptorAdapter