Package 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

Nested Class Summary

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

InvokationOrder.PRIORITY

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	REQUEST_DISPATCHED
protected static final String	REQUEST_ID
static final 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	Description
SimpleRestInterceptor()

Method Summary

Modifier and Type	Method	Description
void	configure(AtmosphereConfig config)	Configure an AtmosphereFramework object.
protected AtmosphereRequest	createAtmosphereRequest(AtmosphereRequest request, String body)
protected byte[]	createResponse(AtmosphereResponse response, byte[] payload)
protected static boolean	getBoolean(tools.jackson.databind.JsonNode obj, String key)	Read a boolean field from the parsed JSON header.
protected String	getHeartbeatBroadcasterName()
protected String	getHeartbeatTemplate()
protected Object[]	getHeartbeatTemplateArguments()
protected static String	getString(tools.jackson.databind.JsonNode obj, String key)	Read a string field from the parsed JSON header.
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 tools.jackson.databind.JsonNode	parseJsonPart(Reader reader)	Parse the JSON header part of a SwaggerSocket-style request body into a Jackson tree.
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 Details

X_REQUEST_KEY

public static final String X_REQUEST_KEY

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

See Also:

• Constant Field Values

REQUEST_DISPATCHED

protected static final String REQUEST_DISPATCHED

See Also:

• Constant Field Values

REQUEST_ID

protected static final String REQUEST_ID

See Also:

• Constant Field Values

Constructor Details

SimpleRestInterceptor

public SimpleRestInterceptor()

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

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 String getHeartbeatBroadcasterName()

getHeartbeatTemplate

protected String getHeartbeatTemplate()

getHeartbeatTemplateArguments

protected Object[] getHeartbeatTemplateArguments()

createAtmosphereRequest

protected AtmosphereRequest createAtmosphereRequest(AtmosphereRequest request,
 String body)
                                             throws IOException

Throws:

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 tools.jackson.databind.JsonNode parseJsonPart(Reader reader)
                                                        throws IOException

Parse the JSON header part of a SwaggerSocket-style request body into a Jackson tree.

API change in 4.0.42: the return type changed from a legacy third-party JSONObject to Jackson's JsonNode when that legacy JSON dependency was dropped (CVE hygiene). External subclasses that read the parsed JSON should migrate to JsonNode or ObjectMapper.convertValue(java.lang.Object, java.lang.Class<T>) for a typed shape.

Throws:

IOException - when the input is not parseable JSON.

getString

protected static String getString(tools.jackson.databind.JsonNode obj,
 String key)

Read a string field from the parsed JSON header. Returns null when the field is absent, null-valued, or non-textual — matching the legacy getString swallow-on-miss semantic.

getBoolean

protected static boolean getBoolean(tools.jackson.databind.JsonNode obj,
 String key)

Read a boolean field from the parsed JSON header. Returns false when the field is absent, null-valued, or non-boolean — matching the legacy getBoolean swallow-on-miss semantic.