Class DynamicRegistrationBean<D extends Registration.Dynamic>

java.lang.Object

org.springframework.boot.web.servlet.RegistrationBean

org.springframework.boot.web.servlet.DynamicRegistrationBean<D>

Type Parameters:

D - the dynamic registration result

All Implemented Interfaces:

Aware, BeanNameAware, ServletContextInitializer, Ordered

Direct Known Subclasses:

AbstractFilterRegistrationBean, ServletRegistrationBean

public abstract class DynamicRegistrationBean<D extends Registration.Dynamic>
extends RegistrationBean
implements BeanNameAware

Base class for Servlet 3.0+ dynamic based registration beans.

Since:

2.0.0

Author:

Phillip Webb, Moritz Halbritter

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
DynamicRegistrationBean()

Method Summary

Modifier and Type	Method	Description
void	addInitParameter(String name, String value)	Add a single init-parameter, replacing any existing parameter with the same name.
protected abstract @Nullable D	addRegistration(String description, ServletContext servletContext)
protected void	configure(D registration)
Map<String,String>	getInitParameters()	Returns a mutable Map of the registration init-parameters.
protected final String	getOrDeduceName(@Nullable Object value)	Deduces the name for this registration.
boolean	isAsyncSupported()	Returns if asynchronous operations are supported for this registration.
protected final void	register(String description, ServletContext servletContext)	Register this bean with the servlet context.
void	setAsyncSupported(boolean asyncSupported)	Sets if asynchronous operations are supported for this registration.
void	setBeanName(String name)
void	setIgnoreRegistrationFailure(boolean ignoreRegistrationFailure)	Sets whether registration failures should be ignored.
void	setInitParameters(Map<String,String> initParameters)	Set init-parameters for this registration.
void	setName(String name)	Set the name of this registration.

Methods inherited from class org.springframework.boot.web.servlet.RegistrationBean

getDescription, getOrder, isEnabled, onStartup, setEnabled, setOrder

Methods inherited from class java.lang.Object

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

Constructor Details

DynamicRegistrationBean

public DynamicRegistrationBean()

Method Details

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 supported for this registration. If not specified defaults to true.

Parameters:

asyncSupported - if async is supported

isAsyncSupported

public boolean isAsyncSupported()

Returns if asynchronous operations are supported for this registration.

Returns:

if async is supported

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

register

protected final void register(String description,
 ServletContext servletContext)

Description copied from class: RegistrationBean

Register this bean with the servlet context.

Specified by:

register in class RegistrationBean

Parameters:

description - a description of the item being registered

servletContext - the servlet context

setIgnoreRegistrationFailure

public void setIgnoreRegistrationFailure(boolean ignoreRegistrationFailure)

Sets whether registration failures should be ignored. If set to true, a failure will be logged. If set to false, an IllegalStateException will be thrown.

Parameters:

ignoreRegistrationFailure - whether to ignore registration failures

Since:

3.1.0

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface BeanNameAware

addRegistration

protected abstract @Nullable D addRegistration(String description,
 ServletContext servletContext)

configure

protected void configure(D registration)

getOrDeduceName

protected final String getOrDeduceName(@Nullable Object value)

Deduces the name for this registration. Will return user specified name or fallback to the bean name. If the bean name is not available, convention based naming is used.

Parameters:

value - the object used for convention based names

Returns:

the deduced name