程序包 org.springframework.boot.web.servlet

类 RegistrationBean

java.lang.Object

org.springframework.boot.web.servlet.RegistrationBean

所有已实现的接口:

ServletContextInitializer, Ordered

直接已知子类:

DynamicRegistrationBean, ServletListenerRegistrationBean

public abstract class RegistrationBean
extends Object
implements ServletContextInitializer, Ordered

Base class for Servlet 3.0+ based registration beans.

从以下版本开始:

1.4.0

作者:

Phillip Webb

另请参阅:

• ServletRegistrationBean
• FilterRegistrationBean
• DelegatingFilterProxyRegistrationBean
• ServletListenerRegistrationBean

字段概要

从接口继承的字段 org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

构造器概要

构造器

构造器	说明
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.
final 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.

从类继承的方法 java.lang.Object

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

构造器详细资料

RegistrationBean

public RegistrationBean()

方法详细资料

onStartup

public final void onStartup(ServletContext servletContext)
                     throws ServletException

从接口复制的说明: ServletContextInitializer

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

指定者:

onStartup 在接口中 ServletContextInitializer

参数:

servletContext - the ServletContext to initialize

抛出:

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"

返回:

a description of the registration

register

protected abstract void register(String description,
 ServletContext servletContext)

Register this bean with the servlet context.

参数:

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.

参数:

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 在接口中 Ordered

返回:

the order