Package org.atmosphere.config.managed

Class ServiceInterceptor

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

org.atmosphere.config.managed.ServiceInterceptor

All Implemented Interfaces:

AtmosphereInterceptor, AtmosphereConfigAware, InvokationOrder

Direct Known Subclasses:

AtmosphereHandlerServiceInterceptor, ManagedServiceInterceptor

public abstract sealed class ServiceInterceptor
extends AtmosphereInterceptorAdapter
permits AtmosphereHandlerServiceInterceptor, ManagedServiceInterceptor

Abstract sealed base class for service interceptors that handle wildcard path routing and path parameter injection for annotated Atmosphere services. Subclasses inspect incoming requests and map them to the appropriate annotated handler.

Nested Class Summary

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

InvokationOrder.PRIORITY

Field Summary

Fields

Modifier and Type	Field	Description
protected AtmosphereConfig	config

Fields inherited from interface org.atmosphere.interceptor.InvokationOrder

AFTER_DEFAULT, BEFORE_DEFAULT, FIRST_BEFORE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
ServiceInterceptor()

Method Summary

Modifier and Type	Method	Description
void	configure(AtmosphereConfig config)	Configure an AtmosphereFramework object.
Action	inspect(AtmosphereResource r)	Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.
protected abstract void	mapAnnotatedService(boolean reMap, String path, AtmosphereRequest request, AtmosphereHandlerWrapper w)
protected void	mapAnnotatedService(AtmosphereRequest request, AtmosphereHandlerWrapper w)	Inspect the request and its mapped AtmosphereHandler to determine if the '{}' was used when defined the annotation's path value.
InvokationOrder.PRIORITY	priority()	Return the priority an AtmosphereInterceptor must be executed.

Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorAdapter

destroy, postInspect, toString

Methods inherited from class java.lang.Object

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

Field Details

config

protected AtmosphereConfig config

Constructor Details

ServiceInterceptor

public ServiceInterceptor()

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.

mapAnnotatedService

protected void mapAnnotatedService(AtmosphereRequest request,
 AtmosphereHandlerWrapper w)

Inspect the request and its mapped AtmosphereHandler to determine if the '{}' was used when defined the annotation's path value. It will create a new AtmosphereHandler in case {} is detected .

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

mapAnnotatedService

protected abstract void mapAnnotatedService(boolean reMap,
 String path,
 AtmosphereRequest request,
 AtmosphereHandlerWrapper w)