Package org.atmosphere.interceptor

Class JavaScriptProtocol

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

org.atmosphere.interceptor.JavaScriptProtocol

All Implemented Interfaces:

AtmosphereInterceptor, AtmosphereConfigAware, InvokationOrder

public class JavaScriptProtocol
extends AtmosphereInterceptorAdapter

An Interceptor that send back to a websocket and http client the value of HeaderConfig.X_ATMOSPHERE_TRACKING_ID.

Moreover, if any HeartbeatInterceptor is installed, it provides the configured heartbeat interval in seconds and the value to be sent for each heartbeat by the client. If not interceptor is installed, then "0" is sent to tell he client to not send any heartbeat.

Author:

Jeanfrancois Arcand

Nested Class Summary

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

InvokationOrder.PRIORITY

Field Summary

Fields inherited from interface org.atmosphere.interceptor.InvokationOrder

AFTER_DEFAULT, BEFORE_DEFAULT, FIRST_BEFORE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
JavaScriptProtocol()

Method Summary

Modifier and Type	Method	Description
void	configure(AtmosphereConfig config)	Configure an AtmosphereFramework object.
boolean	enforceAtmosphereVersion()
JavaScriptProtocol	enforceAtmosphereVersion(boolean enforceAtmosphereVersion)
Action	inspect(AtmosphereResource ar)	Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.
java.lang.String	toString()
java.lang.String	wsDelimiter()
JavaScriptProtocol	wsDelimiter(java.lang.String wsDelimiter)

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

Constructor Detail

JavaScriptProtocol

public JavaScriptProtocol()

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

inspect

public Action inspect(AtmosphereResource ar)

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:

ar - 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.

wsDelimiter

public java.lang.String wsDelimiter()

wsDelimiter

public JavaScriptProtocol wsDelimiter(java.lang.String wsDelimiter)

enforceAtmosphereVersion

public boolean enforceAtmosphereVersion()

enforceAtmosphereVersion

public JavaScriptProtocol enforceAtmosphereVersion(boolean enforceAtmosphereVersion)

toString

public java.lang.String toString()

Overrides:

toString in class AtmosphereInterceptorAdapter