Package org.atmosphere.client

Class TrackMessageSizeInterceptor

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

org.atmosphere.client.TrackMessageSizeInterceptor

All Implemented Interfaces:

AtmosphereInterceptor, AtmosphereConfigAware, InvokationOrder

public class TrackMessageSizeInterceptor
extends AtmosphereInterceptorAdapter

An AtmosphereInterceptor that add a message size and delimiter.

The special String is configurable using ApplicationConfig.MESSAGE_DELIMITER and you can configure this class to exclude some response's content-type by using the ApplicationConfig.EXCLUDED_CONTENT_TYPES

Author:

Jeanfrancois Arcand

Nested Class Summary

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

InvokationOrder.PRIORITY

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SKIP_INTERCEPTOR

Fields inherited from interface org.atmosphere.interceptor.InvokationOrder

AFTER_DEFAULT, BEFORE_DEFAULT, FIRST_BEFORE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
TrackMessageSizeInterceptor()

Method Summary

Modifier and Type	Method	Description
void	configure(AtmosphereConfig config)	Configure an AtmosphereFramework object.
TrackMessageSizeInterceptor	excludedContentType(String excludedContentType)	Exclude response's content-type from being processed by this class.
HashSet<String>	excludedContentTypes()
Action	inspect(AtmosphereResource r)	Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.
TrackMessageSizeInterceptor	messageDelimiter(String endString)	Set the character delimiter used by this class to separate message.
InvokationOrder.PRIORITY	priority()	Return the priority an AtmosphereInterceptor must be executed.
String	toString()

Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorAdapter

destroy, postInspect

Methods inherited from class java.lang.Object

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

Field Details

SKIP_INTERCEPTOR

public static final String SKIP_INTERCEPTOR

Constructor Details

TrackMessageSizeInterceptor

public TrackMessageSizeInterceptor()

Method Details

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

messageDelimiter

public TrackMessageSizeInterceptor messageDelimiter(String endString)

Set the character delimiter used by this class to separate message.

Returns:

this

excludedContentType

public TrackMessageSizeInterceptor excludedContentType(String excludedContentType)

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

Parameters:

excludedContentType - the value of AtmosphereResponseImpl.getContentType()

Returns:

this

excludedContentTypes

public HashSet<String> excludedContentTypes()

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

priority

public InvokationOrder.PRIORITY priority()

Description copied from interface: InvokationOrder

Return the priority an AtmosphereInterceptor must be executed.

Specified by:

priority in interface InvokationOrder

Overrides:

priority in class AtmosphereInterceptorAdapter

Returns:

PRIORITY