Package org.atmosphere.interceptor

Class CorsInterceptor

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

org.atmosphere.interceptor.CorsInterceptor

All Implemented Interfaces:

AtmosphereInterceptor, AtmosphereConfigAware, InvokationOrder

public class CorsInterceptor
extends AtmosphereInterceptorAdapter

CORS support with origin allowlist.

Configure allowed origins via "org.atmosphere.cpr.cors.allowedOrigins" (comma-separated). When not configured, the interceptor echoes the request Origin header for backward compatibility but logs a warning.

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
CorsInterceptor()

Method Summary

Modifier and Type	Method	Description
void	configure(AtmosphereConfig config)	Configure an AtmosphereFramework object.
boolean	enableAccessControl()
CorsInterceptor	enableAccessControl(boolean enableAccessControl)
Action	inspect(AtmosphereResource r)	Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.
InvokationOrder.PRIORITY	priority()	Return the priority an AtmosphereInterceptor must be executed.
String	toString()

Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorAdapter

destroy, postInspect

Methods inherited from class java.lang.Object

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

Constructor Details

CorsInterceptor

public CorsInterceptor()

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.

enableAccessControl

public boolean enableAccessControl()

enableAccessControl

public CorsInterceptor enableAccessControl(boolean enableAccessControl)

priority

public InvokationOrder.PRIORITY priority()

Description copied from interface: InvokationOrder

Return the priority an AtmosphereInterceptor must be executed.

Specified by:

priority in interface InvokationOrder

Overrides:

priority in class AtmosphereInterceptorAdapter

Returns:

PRIORITY

toString

public String toString()

Overrides:

toString in class AtmosphereInterceptorAdapter