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
AServletContextInitializerto registerEventListeners in a Servlet 3.0+ container. Similar to theregistrationfeatures provided byServletContextbut with a Spring Bean friendly design. This bean can be used to register the following types of listener:ServletContextAttributeListenerServletRequestListenerServletRequestAttributeListenerHttpSessionAttributeListenerHttpSessionListenerServletContextListener
- Since:
- 1.4.0
Constructor Summary
Constructors Constructor Description ServletListenerRegistrationBean()Create a newServletListenerRegistrationBeaninstance.ServletListenerRegistrationBean(T listener)Create a newServletListenerRegistrationBeaninstance.
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected StringgetDescription()Return a description of the registration.TgetListener()Return the listener to be registered.static Set<Class<?>>getSupportedTypes()Return the supported types for this registration.static booleanisSupportedType(EventListener listener)Returnstrueif the specified listener is one of the supported types.protected voidregister(String description, javax.servlet.ServletContext servletContext)Register this bean with the servlet context.voidsetListener(T listener)Set the listener that will be registered.Methods inherited from class org.springframework.boot.web.servlet.RegistrationBean
getOrder, isEnabled, onStartup, setEnabled, setOrder
Constructor Detail
ServletListenerRegistrationBean
public ServletListenerRegistrationBean()
Create a newServletListenerRegistrationBeaninstance.
ServletListenerRegistrationBean
public ServletListenerRegistrationBean(T listener)
Create a newServletListenerRegistrationBeaninstance.- Parameters:
listener- the listener to register
Method Detail
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:RegistrationBeanReturn a description of the registration. For example "Servlet resourceServlet"- Specified by:
getDescriptionin classRegistrationBean- Returns:
- a description of the registration
register
protected void register(String description, javax.servlet.ServletContext servletContext)
Description copied from class:RegistrationBeanRegister this bean with the servlet context.- Specified by:
registerin classRegistrationBean- Parameters:
description- a description of the item being registeredservletContext- the servlet context
isSupportedType
public static boolean isSupportedType(EventListener listener)
Returnstrueif 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