org.atmosphere.stomp.interceptor

Class ConnectInterceptor

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

org.atmosphere.interceptor.HeartbeatInterceptor

org.atmosphere.stomp.interceptor.ConnectInterceptor

All Implemented Interfaces:

org.atmosphere.cpr.AtmosphereInterceptor, org.atmosphere.inject.AtmosphereConfigAware, org.atmosphere.interceptor.InvokationOrder, StompInterceptor

public class ConnectInterceptor
extends org.atmosphere.interceptor.HeartbeatInterceptor
implements StompInterceptor

Evaluates the connection frame.

Key features are the heartbeat negotiation and the user authentication when associated headers are specified in the frame.

Since:

0.2

Version:

1.0

Author:

Guillaume DROUET

Nested Class Summary

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

org.atmosphere.interceptor.InvokationOrder.PRIORITY

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_VERSION The default supported version.
static float	HIGHEST_VERSION The highest version we currently support.
static byte[]	STOMP_HEARTBEAT_DATA The padding data for STOMP heartbeat.
static String	VERSIONS Supported versions.

Fields inherited from class org.atmosphere.interceptor.HeartbeatInterceptor

HEARTBEAT_FUTURE, INTERCEPTOR_ADDED

Fields inherited from interface org.atmosphere.interceptor.InvokationOrder

AFTER_DEFAULT, BEFORE_DEFAULT, FIRST_BEFORE_DEFAULT

Constructor Summary

Constructors

Constructor and Description
ConnectInterceptor()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(org.atmosphere.cpr.AtmosphereConfig config)
protected int	extractHeartbeatInterval(org.atmosphere.cpr.AtmosphereResourceImpl resource)
org.atmosphere.cpr.Action	inspect(org.atmosphere.cpr.AtmosphereFramework framework, Frame frame, FrameInterceptor.StompAtmosphereResource r) Inspects the AtmosphereResource with its extracted Frame.

Methods inherited from class org.atmosphere.interceptor.HeartbeatInterceptor

clientHeartbeatFrequencyInSeconds, clientHeartbeatFrequencyInSeconds, clock, destroy, getPaddingBytes, heartbeatFrequencyInSeconds, heartbeatFrequencyInSeconds, inspect, paddingText, resumeOnHeartbeat, resumeOnHeartbeat, toString

Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorAdapter

postInspect, priority

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.atmosphere.cpr.AtmosphereInterceptor

destroy, inspect, postInspect

Field Detail

STOMP_HEARTBEAT_DATA

public static final byte[] STOMP_HEARTBEAT_DATA

The padding data for STOMP heartbeat.

DEFAULT_VERSION

public static final float DEFAULT_VERSION

The default supported version.

See Also:

Constant Field Values

HIGHEST_VERSION

public static final float HIGHEST_VERSION

The highest version we currently support.

See Also:

Constant Field Values

VERSIONS

public static final String VERSIONS

Supported versions.

Constructor Detail

ConnectInterceptor

public ConnectInterceptor()

Method Detail

configure

public void configure(org.atmosphere.cpr.AtmosphereConfig config)

Specified by:

configure in interface org.atmosphere.inject.AtmosphereConfigAware

Overrides:

configure in class org.atmosphere.interceptor.HeartbeatInterceptor

extractHeartbeatInterval

protected int extractHeartbeatInterval(org.atmosphere.cpr.AtmosphereResourceImpl resource)

Overrides:

extractHeartbeatInterval in class org.atmosphere.interceptor.HeartbeatInterceptor

inspect

public org.atmosphere.cpr.Action inspect(org.atmosphere.cpr.AtmosphereFramework framework,
                                Frame frame,
                                FrameInterceptor.StompAtmosphereResource r)

Inspects the AtmosphereResource with its extracted Frame.

Specified by:

inspect in interface StompInterceptor

Parameters:

framework - the framework

frame - the frame

r - the resource