org.springframework.boot.web.servlet

Class RegistrationBean

java.lang.Object

org.springframework.boot.web.servlet.RegistrationBean

All Implemented Interfaces:

ServletContextInitializer, Ordered

Direct Known Subclasses:

DynamicRegistrationBean, ServletListenerRegistrationBean

public abstract class RegistrationBean
extends Object
implements ServletContextInitializer, Ordered

Base class for Servlet 3.0+ based registration beans.

Since:

1.4.0

Author:

Phillip Webb

See Also:

ServletRegistrationBean, FilterRegistrationBean, DelegatingFilterProxyRegistrationBean, ServletListenerRegistrationBean

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
RegistrationBean()

Method Summary

Modifier and Type	Method and Description
protected abstract String	getDescription() Return a description of the registration.
int	getOrder() Get the order of the registration bean.
boolean	isEnabled() Return if the registration is enabled.
void	onStartup(ServletContext servletContext) Configure the given ServletContext with any servlets, filters, listeners context-params and attributes necessary for initialization.
protected abstract void	register(String description, ServletContext servletContext) Register this bean with the servlet context.
void	setEnabled(boolean enabled) Flag to indicate that the registration is enabled.
void	setOrder(int order) Set the order of the registration bean.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistrationBean

public RegistrationBean()

Method Detail

onStartup

public final void onStartup(ServletContext servletContext)
                     throws ServletException

Description copied from interface: ServletContextInitializer

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

Specified by:

onStartup in interface ServletContextInitializer

Parameters:

servletContext - the ServletContext to initialize

Throws:

ServletException - if any call against the given ServletContext throws a ServletException

getDescription

protected abstract String getDescription()

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

Returns:

a description of the registration

register

protected abstract void register(String description,
                                 ServletContext servletContext)

Register this bean with the servlet context.

Parameters:

description - a description of the item being registered

servletContext - the servlet context

setEnabled

public void setEnabled(boolean enabled)

Flag to indicate that the registration is enabled.

Parameters:

enabled - the enabled to set

isEnabled

public boolean isEnabled()

Return if the registration is enabled.

Returns:

if enabled (default true)

setOrder

public void setOrder(int order)

Set the order of the registration bean.

Parameters:

order - the order

getOrder

public int getOrder()

Get the order of the registration bean.

Specified by:

getOrder in interface Ordered

Returns:

the order