RegistrationBean (spring-boot 1.1.4.RELEASE)

java.lang.Object
- org.springframework.boot.context.embedded.RegistrationBean

All Implemented Interfaces:

ServletContextInitializer, org.springframework.core.Ordered

Direct Known Subclasses:

FilterRegistrationBean, ServletListenerRegistrationBean, ServletRegistrationBean
```
public abstract class RegistrationBean
extends Object
implements ServletContextInitializer, org.springframework.core.Ordered
```
Base class for Servlet 3.0+ based registration beans.

Author:

Phillip Webb

See Also:
ServletRegistrationBean, FilterRegistrationBean, ServletListenerRegistrationBean

Field Summary
- Fields inherited from interface org.springframework.core.Ordered
  HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors
Constructor and Description

RegistrationBean()

Constructors
Constructor and Description
`RegistrationBean()`

Method Summary

Methods
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(javax.servlet.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()`
`boolean`	`isAsyncSupported()` Returns if asynchronous operations are support for this registration.
`boolean`	`isEnabled()`
`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)`

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.context.embedded.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.
  - setAsyncSupported
```
public void setAsyncSupported(boolean asyncSupported)
```
    Sets if asynchronous operations are support for this registration. If not specified defaults to true.
  - isAsyncSupported
```
public boolean isAsyncSupported()
```
    Returns if asynchronous operations are support for this registration.
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Flag to indicate that the registration is enabled.
    
    Parameters:
    enabled - the enabled to set
  - isEnabled
```
public boolean isEnabled()
```
    Returns:
    the enabled flag (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.
    
    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.
  - 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
  - configure
```
protected void configure(javax.servlet.Registration.Dynamic registration)
```
    Configure registration base settings.
  - setOrder
```
public void setOrder(int order)
```
    Parameters:
    order - the order to set
  - getOrder
```
public int getOrder()
```
    Specified by:
    
    getOrder in interface org.springframework.core.Ordered
    
    Returns:
    the order

Class RegistrationBean

Field Summary

Fields inherited from interface org.springframework.core.Ordered

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.boot.context.embedded.ServletContextInitializer

Constructor Detail

RegistrationBean

Method Detail

setName

setAsyncSupported

isAsyncSupported

setEnabled

isEnabled

setInitParameters

getInitParameters

addInitParameter

getOrDeduceName

configure

setOrder

getOrder