Package org.springframework.boot.web.servlet

Class ServletListenerRegistrationBean<T extends EventListener>

java.lang.Object

org.springframework.boot.web.servlet.RegistrationBean

org.springframework.boot.web.servlet.ServletListenerRegistrationBean<T>

Type Parameters:

T - the type of listener

All Implemented Interfaces:

ServletContextInitializer, org.springframework.core.Ordered

public class ServletListenerRegistrationBean<T extends EventListener>
extends RegistrationBean

A ServletContextInitializer to register EventListeners in a Servlet 3.0+ container. Similar to the registration features provided by ServletContext but with a Spring Bean friendly design. This bean can be used to register the following types of listener:

• ServletContextAttributeListener
• ServletRequestListener
• ServletRequestAttributeListener
• HttpSessionAttributeListener
• HttpSessionIdListener
• HttpSessionListener
• ServletContextListener

Since:

1.4.0

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
ServletListenerRegistrationBean()	Create a new ServletListenerRegistrationBean instance.
ServletListenerRegistrationBean(T listener)	Create a new ServletListenerRegistrationBean instance.

Method Summary

Modifier and Type	Method	Description
protected String	getDescription()	Return a description of the registration.
T	getListener()	Return the listener to be registered.
static Set<Class<?>>	getSupportedTypes()	Return the supported types for this registration.
static boolean	isSupportedType(EventListener listener)	Returns true if the specified listener is one of the supported types.
protected void	register(String description, jakarta.servlet.ServletContext servletContext)	Register this bean with the servlet context.
void	setListener(T listener)	Set the listener that will be registered.

Methods inherited from class org.springframework.boot.web.servlet.RegistrationBean

getOrder, isEnabled, onStartup, setEnabled, setOrder

Methods inherited from class java.lang.Object

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

Constructor Details

ServletListenerRegistrationBean

public ServletListenerRegistrationBean()

Create a new ServletListenerRegistrationBean instance.

ServletListenerRegistrationBean

public ServletListenerRegistrationBean(T listener)

Create a new ServletListenerRegistrationBean instance.

Parameters:

listener - the listener to register

Method Details

setListener

public void setListener(T listener)

Set the listener that will be registered.

Parameters:

listener - the listener to register

getListener

public T getListener()

Return the listener to be registered.

Returns:

the listener to be registered

getDescription

protected String getDescription()

Description copied from class: RegistrationBean

Return a description of the registration. For example "Servlet resourceServlet"

Specified by:

getDescription in class RegistrationBean

Returns:

a description of the registration

register

protected void register(String description,
 jakarta.servlet.ServletContext servletContext)

Description copied from class: RegistrationBean

Register this bean with the servlet context.

Specified by:

register in class RegistrationBean

Parameters:

description - a description of the item being registered

servletContext - the servlet context

isSupportedType

public static boolean isSupportedType(EventListener listener)

Returns true if the specified listener is one of the supported types.

Parameters:

listener - the listener to test

Returns:

if the listener is of a supported type

getSupportedTypes

public static Set<Class<?>> getSupportedTypes()

Return the supported types for this registration.

Returns:

the supported types