org.springframework.session.web.context

Class AbstractHttpSessionApplicationInitializer

java.lang.Object

org.springframework.session.web.context.AbstractHttpSessionApplicationInitializer

All Implemented Interfaces:

org.springframework.web.WebApplicationInitializer

@Order(value=100)
public abstract class AbstractHttpSessionApplicationInitializer
extends java.lang.Object
implements org.springframework.web.WebApplicationInitializer

Registers the DelegatingFilterProxy to use the springSessionRepositoryFilter before any other registered Filter. When used with AbstractHttpSessionApplicationInitializer(Class...), it will also register a ContextLoaderListener. When used with AbstractHttpSessionApplicationInitializer(), this class is typically used in addition to a subclass of AbstractContextLoaderInitializer.

By default the DelegatingFilterProxy is registered with support for asynchronous requests, but can be enabled by overriding isAsyncSessionSupported() and getSessionDispatcherTypes().

Additional configuration before and after the springSecurityFilterChain can be added by overriding afterSessionRepositoryFilter(ServletContext).

Caveats

Subclasses of AbstractDispatcherServletInitializer will register their filters before any other Filter. This means that you will typically want to ensure subclasses of AbstractDispatcherServletInitializer are invoked first. This can be done by ensuring the Order or Ordered of AbstractDispatcherServletInitializer are sooner than subclasses of AbstractSecurityWebApplicationInitializer.

Author:

Rob Winch

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_FILTER_NAME The default name for Spring Session's repository filter.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHttpSessionApplicationInitializer() Creates a new instance that assumes the Spring Session configuration is loaded by some other means than this class.
protected	AbstractHttpSessionApplicationInitializer(java.lang.Class<?>... configurationClasses) Creates a new instance that will instantiate the ContextLoaderListener with the specified classes.

Method Summary

Modifier and Type	Method and Description
protected void	afterSessionRepositoryFilter(ServletContext servletContext) Invoked after the springSessionRepositoryFilter is added.
protected void	appendFilters(ServletContext servletContext, Filter... filters) Inserts the provided Filters after existing Filters using default generated names, getSessionDispatcherTypes(), and isAsyncSessionSupported().
protected void	beforeSessionRepositoryFilter(ServletContext servletContext) Invoked before the springSessionRepositoryFilter is added.
protected java.lang.String	getDispatcherWebApplicationContextSuffix() Return the <servlet-name> to use the DispatcherServlet's WebApplicationContext to find the DelegatingFilterProxy or null to use the parent ApplicationContext.
protected java.util.EnumSet<DispatcherType>	getSessionDispatcherTypes() Get the DispatcherType for the springSessionRepositoryFilter.
protected void	insertFilters(ServletContext servletContext, Filter... filters) Inserts the provided Filters before existing Filters using default generated names, getSessionDispatcherTypes(), and isAsyncSessionSupported().
protected boolean	isAsyncSessionSupported() Determine if the springSessionRepositoryFilter should be marked as supporting asynch.
void	onStartup(ServletContext servletContext)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FILTER_NAME

public static final java.lang.String DEFAULT_FILTER_NAME

The default name for Spring Session's repository filter.

See Also:

Constant Field Values

Constructor Detail

AbstractHttpSessionApplicationInitializer

protected AbstractHttpSessionApplicationInitializer()

Creates a new instance that assumes the Spring Session configuration is loaded by some other means than this class. For example, a user might create a ContextLoaderListener using a subclass of AbstractContextLoaderInitializer.

See Also:

ContextLoaderListener

AbstractHttpSessionApplicationInitializer

protected AbstractHttpSessionApplicationInitializer(java.lang.Class<?>... configurationClasses)

Creates a new instance that will instantiate the ContextLoaderListener with the specified classes.

Parameters:

configurationClasses - @Configuration classes that will be used to configure the context

Method Detail

onStartup

public void onStartup(ServletContext servletContext)
               throws ServletException

Specified by:

onStartup in interface org.springframework.web.WebApplicationInitializer

Throws:

ServletException

insertFilters

protected final void insertFilters(ServletContext servletContext,
                                   Filter... filters)

Inserts the provided Filters before existing Filters using default generated names, getSessionDispatcherTypes(), and isAsyncSessionSupported().

Parameters:

servletContext - the ServletContext to use

filters - the Filters to register

appendFilters

protected final void appendFilters(ServletContext servletContext,
                                   Filter... filters)

Inserts the provided Filters after existing Filters using default generated names, getSessionDispatcherTypes(), and isAsyncSessionSupported().

Parameters:

servletContext - the ServletContext to use

filters - the Filters to register

getDispatcherWebApplicationContextSuffix

protected java.lang.String getDispatcherWebApplicationContextSuffix()

Return the <servlet-name> to use the DispatcherServlet's WebApplicationContext to find the DelegatingFilterProxy or null to use the parent ApplicationContext.

For example, if you are using AbstractDispatcherServletInitializer or AbstractAnnotationConfigDispatcherServletInitializer and using the provided Servlet name, you can return "dispatcher" from this method to use the DispatcherServlet's WebApplicationContext.

Returns:

the <servlet-name> of the DispatcherServlet to use its WebApplicationContext or null (default) to use the parent ApplicationContext.

beforeSessionRepositoryFilter

protected void beforeSessionRepositoryFilter(ServletContext servletContext)

Invoked before the springSessionRepositoryFilter is added.

Parameters:

servletContext - the ServletContext

afterSessionRepositoryFilter

protected void afterSessionRepositoryFilter(ServletContext servletContext)

Invoked after the springSessionRepositoryFilter is added.

Parameters:

servletContext - the ServletContext

getSessionDispatcherTypes

protected java.util.EnumSet<DispatcherType> getSessionDispatcherTypes()

Get the DispatcherType for the springSessionRepositoryFilter.

Returns:

the DispatcherType for the filter

isAsyncSessionSupported

protected boolean isAsyncSessionSupported()

Determine if the springSessionRepositoryFilter should be marked as supporting asynch. Default is true.

Returns:

true if springSessionRepositoryFilter should be marked as supporting asynch