org.atmosphere.interceptor

Class SimpleRestInterceptor

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

org.atmosphere.interceptor.SimpleRestInterceptor

All Implemented Interfaces:

AtmosphereInterceptor, AtmosphereConfigAware, InvokationOrder

public class SimpleRestInterceptor
extends AtmosphereInterceptorAdapter

An Atmosphere interceptor to enable a simple rest binding protocol. This protocol is a simplified version of SwaggerSocket with some new features https://github.com/swagger-api/swaggersocket This interceptor currently handles both Websocket and SSE protocols. It was originally developed for enabling atmosphere for kafka-rest at https://github.com/elakito/kafka-rest-atmosphere

Author:

elakito

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 java.lang.String	PROTOCOL_DETACHED_KEY Deprecated. always use detached mode
protected static java.lang.String	REQUEST_DISPATCHED
protected static java.lang.String	REQUEST_ID
static java.lang.String	X_ATMOSPHERE_SIMPLE_REST_PROTOCOL_DETACHED Deprecated. always use detached mode
static java.lang.String	X_REQUEST_KEY The internal header consisting of the {tracking-id}#{request-id}

Fields inherited from interface org.atmosphere.interceptor.InvokationOrder

AFTER_DEFAULT, BEFORE_DEFAULT, FIRST_BEFORE_DEFAULT

Constructor Summary

Constructors

Constructor and Description
SimpleRestInterceptor()

Method Summary

Modifier and Type	Method and Description
void	configure(AtmosphereConfig config) Configure an AtmosphereFramework object.
protected AtmosphereRequest	createAtmosphereRequest(AtmosphereRequest request, java.lang.String body)
protected byte[]	createResponse(AtmosphereResponse response, byte[] payload)
protected static boolean	getBoolean(org.json.JSONObject obj, java.lang.String key)
protected java.lang.String	getHeartbeatBroadcasterName()
protected java.lang.String	getHeartbeatTemplate()
protected java.lang.Object[]	getHeartbeatTemplateArguments()
protected static java.lang.String	getString(org.json.JSONObject obj, java.lang.String key)
Action	inspect(AtmosphereResource r) Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.
protected static boolean	isJSONObject(byte[] b)
protected static boolean	isLastResponse(AtmosphereRequest request, AtmosphereResponse response)
protected static org.json.JSONObject	parseJsonPart(java.io.Reader reader)
protected static byte[]	quote(byte[] b)

Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorAdapter

destroy, postInspect, priority, toString

Methods inherited from class java.lang.Object

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

Field Detail

PROTOCOL_DETACHED_KEY

public static final java.lang.String PROTOCOL_DETACHED_KEY

Deprecated. always use detached mode

Servlet init property to enable the detached mode in the response

See Also:

Constant Field Values

X_ATMOSPHERE_SIMPLE_REST_PROTOCOL_DETACHED

public static final java.lang.String X_ATMOSPHERE_SIMPLE_REST_PROTOCOL_DETACHED

Deprecated. always use detached mode

Connection request property to enable the detached mode in the response

See Also:

Constant Field Values

X_REQUEST_KEY

public static final java.lang.String X_REQUEST_KEY

The internal header consisting of the {tracking-id}#{request-id}

See Also:

Constant Field Values

REQUEST_DISPATCHED

protected static final java.lang.String REQUEST_DISPATCHED

See Also:

Constant Field Values

REQUEST_ID

protected static final java.lang.String REQUEST_ID

See Also:

Constant Field Values

Constructor Detail

SimpleRestInterceptor

public SimpleRestInterceptor()

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

getHeartbeatBroadcasterName

protected java.lang.String getHeartbeatBroadcasterName()

getHeartbeatTemplate

protected java.lang.String getHeartbeatTemplate()

getHeartbeatTemplateArguments

protected java.lang.Object[] getHeartbeatTemplateArguments()

createAtmosphereRequest

protected AtmosphereRequest createAtmosphereRequest(AtmosphereRequest request,
                                                    java.lang.String body)
                                             throws java.io.IOException

Throws:

java.io.IOException

createResponse

protected byte[] createResponse(AtmosphereResponse response,
                                byte[] payload)

isLastResponse

protected static boolean isLastResponse(AtmosphereRequest request,
                                        AtmosphereResponse response)

isJSONObject

protected static boolean isJSONObject(byte[] b)

quote

protected static byte[] quote(byte[] b)

parseJsonPart

protected static org.json.JSONObject parseJsonPart(java.io.Reader reader)
                                            throws org.json.JSONException

Throws:

org.json.JSONException

getString

protected static java.lang.String getString(org.json.JSONObject obj,
                                            java.lang.String key)

getBoolean

protected static boolean getBoolean(org.json.JSONObject obj,
                                    java.lang.String key)