Package org.atmosphere.interceptor

Class MDCInterceptor

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

org.atmosphere.interceptor.MDCInterceptor

All Implemented Interfaces:

AtmosphereInterceptor, AtmosphereConfigAware, InvokationOrder

public class MDCInterceptor
extends AtmosphereInterceptorAdapter

Interceptor that populates the SLF4J MDC with Atmosphere-specific context for structured logging. Values are set on request entry and cleared after processing to avoid leaking into unrelated threads.

MDC keys

• atmosphere.uuid — the unique resource identifier
• atmosphere.transport — the transport type (websocket, long-polling, sse, etc.)
• atmosphere.broadcaster — the broadcaster ID this resource is attached to

Logback pattern example

 %d{HH:mm:ss.SSS} [%thread] %-5level [uuid=%X{atmosphere.uuid} transport=%X{atmosphere.transport}] %logger{36} - %msg%n
 

JSON layout (logback-contrib or logstash-logback-encoder)

MDC keys are automatically included as top-level fields in JSON output.

Since:

4.0

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	MDC_BROADCASTER
static final String	MDC_TRANSPORT
static final String	MDC_UUID

Fields inherited from interface org.atmosphere.interceptor.InvokationOrder

AFTER_DEFAULT, BEFORE_DEFAULT, FIRST_BEFORE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
MDCInterceptor()

Method Summary

Modifier and Type	Method	Description
Action	inspect(AtmosphereResource r)	Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.
void	postInspect(AtmosphereResource r)	Invoked after an AtmosphereResource gets dispatched to AtmosphereHandler.
String	toString()

Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorAdapter

configure, destroy, priority

Methods inherited from class java.lang.Object

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

Field Details

MDC_UUID

public static final String MDC_UUID

See Also:

• Constant Field Values

MDC_TRANSPORT

public static final String MDC_TRANSPORT

See Also:

• Constant Field Values

MDC_BROADCASTER

public static final String MDC_BROADCASTER

See Also:

• Constant Field Values

Constructor Details

MDCInterceptor

public MDCInterceptor()

Method Details

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.

postInspect

public void postInspect(AtmosphereResource r)

Description copied from interface: AtmosphereInterceptor

Invoked after an AtmosphereResource gets dispatched to AtmosphereHandler.

Specified by:

postInspect in interface AtmosphereInterceptor

Overrides:

postInspect in class AtmosphereInterceptorAdapter

Parameters:

r - a AtmosphereResource

toString

public String toString()

Overrides:

toString in class AtmosphereInterceptorAdapter