Class RegistrationBean
- java.lang.Object
- org.springframework.boot.web.servlet.RegistrationBean
- All Implemented Interfaces:
ServletContextInitializer
,org.springframework.core.Ordered
- Direct Known Subclasses:
DynamicRegistrationBean
,ServletListenerRegistrationBean
public abstract class RegistrationBean extends Object implements ServletContextInitializer, org.springframework.core.Ordered
Base class for Servlet 3.0+ based registration beans.
Constructor Summary
Constructors Constructor Description RegistrationBean()
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method 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(javax.servlet.ServletContext servletContext)
Configure the givenServletContext
with any servlets, filters, listeners context-params and attributes necessary for initialization.protected abstract void
register(String description, javax.servlet.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.
Constructor Detail
RegistrationBean
public RegistrationBean()
Method Detail
onStartup
public final void onStartup(javax.servlet.ServletContext servletContext) throws javax.servlet.ServletException
Description copied from interface:ServletContextInitializer
Configure the givenServletContext
with any servlets, filters, listeners context-params and attributes necessary for initialization.- Specified by:
onStartup
in interfaceServletContextInitializer
- Parameters:
servletContext
- theServletContext
to initialize- Throws:
javax.servlet.ServletException
- if any call against the givenServletContext
throws aServletException
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, javax.servlet.ServletContext servletContext)
Register this bean with the servlet context.- Parameters:
description
- a description of the item being registeredservletContext
- 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 interfaceorg.springframework.core.Ordered
- Returns:
- the order