Package org.atmosphere.cpr

Class InterceptorRegistry

java.lang.Object

org.atmosphere.cpr.InterceptorRegistry

public class InterceptorRegistry
extends Object

Manages AtmosphereInterceptor registration, configuration, and lifecycle.

Field Summary

Fields

Modifier and Type	Field	Description
static final List<Class<? extends AtmosphereInterceptor>>	DEFAULT_ATMOSPHERE_INTERCEPTORS

Constructor Summary

Constructors

Constructor	Description
InterceptorRegistry(AtmosphereConfig config)

Method Summary

Modifier and Type	Method	Description
void	addDefaultOrAppInterceptors()	Add all interceptors to all handler wrappers.
boolean	addInterceptor(AtmosphereInterceptor c, boolean initialized)	Add an AtmosphereInterceptor.
void	addInterceptorToAllWrappers(AtmosphereInterceptor c)	Add an interceptor to all registered handler wrappers.
void	addInterceptorToWrapper(AtmosphereHandlerWrapper wrapper, List<AtmosphereInterceptor> handlerInterceptors)	Add framework interceptors and handler-specific interceptors to a wrapper.
void	addInterceptorToWrapper(AtmosphereHandlerWrapper wrapper, AtmosphereInterceptor c)	Add an interceptor to a specific wrapper.
void	clear()	Clear all interceptors and excluded interceptors.
void	configure(ServletConfig sc)	Configure interceptors from servlet init parameters and default list.
Class<? extends AtmosphereInterceptor>[]	defaultInterceptors()	Return the default interceptor classes.
void	destroyInterceptors(Map<String,AtmosphereHandlerWrapper> handlers)	Destroy all interceptors in all handler wrappers.
List<String>	excludedInterceptors()	Return the list of excluded interceptor class names.
void	excludeInterceptor(String interceptor)	Exclude an AtmosphereInterceptor from being added at startup.
<T extends AtmosphereInterceptor> Optional<T>	findInterceptor(Class<T> c)	Find an AtmosphereInterceptor of the given type.
<T extends AtmosphereInterceptor> T	interceptor(Class<T> c)	Deprecated. Use findInterceptor(Class) which returns Optional instead of null.
LinkedList<AtmosphereInterceptor>	interceptors()	Return the list of AtmosphereInterceptors.
AtmosphereInterceptor	newInterceptor(Class<? extends AtmosphereInterceptor> a)	Create a new interceptor instance.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_ATMOSPHERE_INTERCEPTORS

public static final List<Class<? extends AtmosphereInterceptor>> DEFAULT_ATMOSPHERE_INTERCEPTORS

Constructor Details

InterceptorRegistry

public InterceptorRegistry(AtmosphereConfig config)

Method Details

addInterceptor

public boolean addInterceptor(AtmosphereInterceptor c,
 boolean initialized)

Add an AtmosphereInterceptor. The adding order will be used for invocation.

interceptors

public LinkedList<AtmosphereInterceptor> interceptors()

Return the list of AtmosphereInterceptors.

interceptor

@Deprecated(since="4.0.0",
            forRemoval=false)
public <T extends AtmosphereInterceptor> T interceptor(Class<T> c)

Deprecated.

Use findInterceptor(Class) which returns Optional instead of null.

Find an AtmosphereInterceptor of the given type.

findInterceptor

public <T extends AtmosphereInterceptor>
Optional<T> findInterceptor(Class<T> c)

Find an AtmosphereInterceptor of the given type.

excludeInterceptor

public void excludeInterceptor(String interceptor)

Exclude an AtmosphereInterceptor from being added at startup.

excludedInterceptors

public List<String> excludedInterceptors()

Return the list of excluded interceptor class names.

defaultInterceptors

public Class<? extends AtmosphereInterceptor>[] defaultInterceptors()

Return the default interceptor classes.

configure

public void configure(ServletConfig sc)

Configure interceptors from servlet init parameters and default list.

newInterceptor

public AtmosphereInterceptor newInterceptor(Class<? extends AtmosphereInterceptor> a)

Create a new interceptor instance.

addDefaultOrAppInterceptors

public void addDefaultOrAppInterceptors()

Add all interceptors to all handler wrappers.

addInterceptorToAllWrappers

public void addInterceptorToAllWrappers(AtmosphereInterceptor c)

Add an interceptor to all registered handler wrappers.

addInterceptorToWrapper

public void addInterceptorToWrapper(AtmosphereHandlerWrapper wrapper,
 AtmosphereInterceptor c)

Add an interceptor to a specific wrapper.

addInterceptorToWrapper

public void addInterceptorToWrapper(AtmosphereHandlerWrapper wrapper,
 List<AtmosphereInterceptor> handlerInterceptors)

Add framework interceptors and handler-specific interceptors to a wrapper.

destroyInterceptors

public void destroyInterceptors(Map<String,AtmosphereHandlerWrapper> handlers)

Destroy all interceptors in all handler wrappers.

clear

public void clear()

Clear all interceptors and excluded interceptors.