类 RegistrationBean
- java.lang.Object
- org.springframework.boot.web.servlet.RegistrationBean
- 所有已实现的接口:
ServletContextInitializer
,org.springframework.core.Ordered
public abstract class RegistrationBean extends Object implements ServletContextInitializer, org.springframework.core.Ordered
Base class for Servlet 3.0+ based registration beans.
构造器概要
构造器 构造器 说明 RegistrationBean()
方法概要
所有方法 实例方法 抽象方法 具体方法 修饰符和类型 方法 说明 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.
构造器详细资料
RegistrationBean
public RegistrationBean()
方法详细资料
onStartup
public final void onStartup(javax.servlet.ServletContext servletContext) throws javax.servlet.ServletException
从接口复制的说明:ServletContextInitializer
Configure the givenServletContext
with any servlets, filters, listeners context-params and attributes necessary for initialization.- 指定者:
onStartup
在接口中ServletContextInitializer
- 参数:
servletContext
- theServletContext
to initialize- 抛出:
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"- 返回:
- a description of the registration
register
protected abstract void register(String description, javax.servlet.ServletContext servletContext)
Register this bean with the servlet context.- 参数:
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.- 参数:
enabled
- the enabled to set
isEnabled
public boolean isEnabled()
Return if the registration is enabled.- 返回:
- if enabled (default
true
)
setOrder
public void setOrder(int order)
Set the order of the registration bean.- 参数:
order
- the order
getOrder
public int getOrder()
Get the order of the registration bean.- 指定者:
getOrder
在接口中org.springframework.core.Ordered
- 返回:
- the order