spring-boot/org.springframework.boot.web.servlet/ServletListenerRegistrationBean

ServletListenerRegistrationBean

open class ServletListenerRegistrationBean<T : EventListener?> : 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

Author

Dave Syer

Phillip Webb

Since

1.4.0

Parameters

<T>

the type of listener

Constructors

ServletListenerRegistrationBean

constructor()

Create a new ServletListenerRegistrationBean instance.

constructor(listener: T)

Create a new ServletListenerRegistrationBean instance.

Properties

HIGHEST_PRECEDENCE

val HIGHEST_PRECEDENCE: Int = -2147483648

open var listener: T

LOWEST_PRECEDENCE

val LOWEST_PRECEDENCE: Int = 2147483647

open var order: Int

Functions

getSupportedTypes

open fun getSupportedTypes(): Set<Class<out Any>>

Return the supported types for this registration.

open fun isEnabled(): Boolean

Return if the registration is enabled.

isSupportedType

open fun isSupportedType(listener: EventListener): Boolean

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

fun onStartup(servletContext: ServletContext)

Configure the given ServletContext with any servlets, filters, listeners context-params and attributes necessary for initialization.

open fun setEnabled(enabled: Boolean)

Flag to indicate that the registration is enabled.