org.springframework.boot.web.servlet

Class RegistrationBean

java.lang.Object

org.springframework.boot.web.servlet.RegistrationBean

All Implemented Interfaces:

ServletContextInitializer, Ordered

Direct Known Subclasses:

DelegatingFilterProxyRegistrationBean, FilterRegistrationBean, ServletListenerRegistrationBean, ServletRegistrationBean

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
void	addInitParameter(String name, String value) Add a single init-parameter, replacing any existing parameter with the same name.
protected void	configure(Registration.Dynamic registration) Configure registration base settings.
Map<String,String>	getInitParameters() Returns a mutable Map of the registration init-parameters.
protected String	getOrDeduceName(Object value) Deduces the name for this registration.
int	getOrder() Get the order of the registration bean.
boolean	isAsyncSupported() Returns if asynchronous operations are support for this registration.
boolean	isEnabled() Return if the registration is enabled.
void	setAsyncSupported(boolean asyncSupported) Sets if asynchronous operations are support for this registration.
void	setEnabled(boolean enabled) Flag to indicate that the registration is enabled.
void	setInitParameters(Map<String,String> initParameters) Set init-parameters for this registration.
void	setName(String name) Set the name of this registration.
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

Methods inherited from interface org.springframework.boot.web.servlet.ServletContextInitializer

onStartup

Constructor Detail

RegistrationBean

public RegistrationBean()

Method Detail

setName

public void setName(String name)

Set the name of this registration. If not specified the bean name will be used.

Parameters:

name - the name of the registration

setAsyncSupported

public void setAsyncSupported(boolean asyncSupported)

Sets if asynchronous operations are support for this registration. If not specified defaults to true.

Parameters:

asyncSupported - if async is supported

isAsyncSupported

public boolean isAsyncSupported()

Returns if asynchronous operations are support for this registration.

Returns:

if async is supported

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)

setInitParameters

public void setInitParameters(Map<String,String> initParameters)

Set init-parameters for this registration. Calling this method will replace any existing init-parameters.

Parameters:

initParameters - the init parameters

See Also:

getInitParameters(), addInitParameter(java.lang.String, java.lang.String)

getInitParameters

public Map<String,String> getInitParameters()

Returns a mutable Map of the registration init-parameters.

Returns:

the init parameters

addInitParameter

public void addInitParameter(String name,
                             String value)

Add a single init-parameter, replacing any existing parameter with the same name.

Parameters:

name - the init-parameter name

value - the init-parameter value

getOrDeduceName

protected final String getOrDeduceName(Object value)

Deduces the name for this registration. Will return user specified name or fallback to convention based naming.

Parameters:

value - the object used for convention based names

Returns:

the deduced name

configure

protected void configure(Registration.Dynamic registration)

Configure registration base settings.

Parameters:

registration - the registration

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