AnnotationConfigReactiveWebServerApplicationContext (Spring Boot Docs 2.0.5.RELEASE API)

java.lang.Object
- org.springframework.core.io.DefaultResourceLoader
- - org.springframework.context.support.AbstractApplicationContext
  - - org.springframework.context.support.GenericApplicationContext
    - - org.springframework.boot.web.reactive.context.GenericReactiveWebApplicationContext
      - org.springframework.boot.web.reactive.context.ReactiveWebServerApplicationContext
        
        org.springframework.boot.web.reactive.context.AnnotationConfigReactiveWebServerApplicationContext

All Implemented Interfaces:

Closeable, AutoCloseable, BeanFactory, HierarchicalBeanFactory, ListableBeanFactory, BeanDefinitionRegistry, ConfigurableWebServerApplicationContext, WebServerApplicationContext, ConfigurableReactiveWebApplicationContext, ReactiveWebApplicationContext, AnnotationConfigRegistry, ApplicationContext, ApplicationEventPublisher, ConfigurableApplicationContext, Lifecycle, MessageSource, AliasRegistry, EnvironmentCapable, ResourceLoader, ResourcePatternResolver
```
public class AnnotationConfigReactiveWebServerApplicationContext
extends ReactiveWebServerApplicationContext
implements AnnotationConfigRegistry
```
ReactiveWebServerApplicationContext that accepts annotated classes as input - in particular @Configuration-annotated classes, but also plain @Component classes and JSR-330 compliant classes using javax.inject annotations. Allows for registering classes one by one (specifying class names as config location) as well as for classpath scanning (specifying base packages as config location).
Note: In case of multiple @Configuration classes, later @Bean definitions will override ones defined in earlier loaded files. This can be leveraged to deliberately override certain bean definitions via an extra Configuration class.

Since:

2.0.0

Author:

Phillip Webb

See Also:

register(Class...), scan(String...), ReactiveWebServerApplicationContext, AnnotationConfigApplicationContext

Nested Class Summary
- Nested classes/interfaces inherited from class org.springframework.core.io.DefaultResourceLoader
  DefaultResourceLoader.ClassPathContextResource

Field Summary
- Fields inherited from class org.springframework.context.support.AbstractApplicationContext
  APPLICATION_EVENT_MULTICASTER_BEAN_NAME, LIFECYCLE_PROCESSOR_BEAN_NAME, logger, MESSAGE_SOURCE_BEAN_NAME
- Fields inherited from interface org.springframework.context.ConfigurableApplicationContext
  CONFIG_LOCATION_DELIMITERS, CONVERSION_SERVICE_BEAN_NAME, ENVIRONMENT_BEAN_NAME, LOAD_TIME_WEAVER_BEAN_NAME, SYSTEM_ENVIRONMENT_BEAN_NAME, SYSTEM_PROPERTIES_BEAN_NAME
- Fields inherited from interface org.springframework.beans.factory.BeanFactory
  FACTORY_BEAN_PREFIX
- Fields inherited from interface org.springframework.core.io.support.ResourcePatternResolver
  CLASSPATH_ALL_URL_PREFIX
- Fields inherited from interface org.springframework.core.io.ResourceLoader
  CLASSPATH_URL_PREFIX

Constructor Summary

Constructors
Constructor and Description
`AnnotationConfigReactiveWebServerApplicationContext()` Create a new `AnnotationConfigReactiveWebServerApplicationContext` that needs to be populated through `register(java.lang.Class<?>...)` calls and then manually refreshed.
`AnnotationConfigReactiveWebServerApplicationContext(Class<?>... annotatedClasses)` Create a new `AnnotationConfigReactiveWebServerApplicationContext`, deriving bean definitions from the given annotated classes and automatically refreshing the context.
`AnnotationConfigReactiveWebServerApplicationContext(DefaultListableBeanFactory beanFactory)` Create a new `AnnotationConfigReactiveWebServerApplicationContext` with the given `DefaultListableBeanFactory`.
`AnnotationConfigReactiveWebServerApplicationContext(String... basePackages)` Create a new `AnnotationConfigReactiveWebServerApplicationContext`, scanning for bean definitions in the given packages and automatically refreshing the context.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)`
`protected void`	`prepareRefresh()`
`void`	`register(Class<?>... annotatedClasses)` Register one or more annotated classes to be processed.
`void`	`scan(String... basePackages)` Perform a scan within the specified base packages.
`void`	`setBeanNameGenerator(BeanNameGenerator beanNameGenerator)` Provide a custom `BeanNameGenerator` for use with `AnnotatedBeanDefinitionReader` and/or `ClassPathBeanDefinitionScanner`, if any.
`void`	`setEnvironment(ConfigurableEnvironment environment)`
`void`	`setScopeMetadataResolver(ScopeMetadataResolver scopeMetadataResolver)` Set the `ScopeMetadataResolver` to use for detected bean classes.

Methods inherited from class org.springframework.boot.web.reactive.context.ReactiveWebServerApplicationContext
finishRefresh, getHttpHandler, getServerNamespace, getWebServer, getWebServerFactory, onClose, onRefresh, refresh, setServerNamespace

Methods inherited from class org.springframework.boot.web.reactive.context.GenericReactiveWebApplicationContext
createEnvironment, getResourceByPath

Methods inherited from class org.springframework.context.support.GenericApplicationContext
cancelRefresh, closeBeanFactory, getAutowireCapableBeanFactory, getBeanDefinition, getBeanFactory, getClassLoader, getDefaultListableBeanFactory, getResource, getResources, isAlias, isBeanNameInUse, refreshBeanFactory, registerAlias, registerBean, registerBean, registerBean, registerBean, registerBeanDefinition, removeAlias, removeBeanDefinition, setAllowBeanDefinitionOverriding, setAllowCircularReferences, setClassLoader, setParent, setResourceLoader

Methods inherited from class org.springframework.context.support.AbstractApplicationContext
addApplicationListener, addBeanFactoryPostProcessor, assertBeanFactoryActive, close, containsBean, containsBeanDefinition, containsLocalBean, destroy, destroyBeans, doClose, findAnnotationOnBean, finishBeanFactoryInitialization, getAliases, getApplicationListeners, getApplicationName, getBean, getBean, getBean, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanFactoryPostProcessors, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getBeansWithAnnotation, getDisplayName, getEnvironment, getId, getInternalParentBeanFactory, getInternalParentMessageSource, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getResourcePatternResolver, getStartupDate, getType, initApplicationEventMulticaster, initLifecycleProcessor, initMessageSource, initPropertySources, invokeBeanFactoryPostProcessors, isActive, isPrototype, isRunning, isSingleton, isTypeMatch, isTypeMatch, obtainFreshBeanFactory, prepareBeanFactory, publishEvent, publishEvent, publishEvent, registerBeanPostProcessors, registerListeners, registerShutdownHook, resetCommonCaches, setDisplayName, setId, start, stop, toString

Methods inherited from class org.springframework.core.io.DefaultResourceLoader
addProtocolResolver, clearResourceCaches, getProtocolResolvers, getResourceCache

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.context.ConfigurableApplicationContext
addApplicationListener, addBeanFactoryPostProcessor, addProtocolResolver, close, getBeanFactory, getEnvironment, isActive, registerShutdownHook, setId, setParent

Methods inherited from interface org.springframework.context.Lifecycle
isRunning, start, stop

Methods inherited from interface org.springframework.context.ApplicationContext
getApplicationName, getAutowireCapableBeanFactory, getDisplayName, getId, getParent, getStartupDate

Methods inherited from interface org.springframework.beans.factory.ListableBeanFactory
containsBeanDefinition, findAnnotationOnBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getBeansWithAnnotation

Methods inherited from interface org.springframework.beans.factory.HierarchicalBeanFactory
containsLocalBean, getParentBeanFactory

Methods inherited from interface org.springframework.beans.factory.BeanFactory
containsBean, getAliases, getBean, getBean, getBean, getBean, getBean, getType, isPrototype, isSingleton, isTypeMatch, isTypeMatch

Methods inherited from interface org.springframework.context.MessageSource
getMessage, getMessage, getMessage

Methods inherited from interface org.springframework.context.ApplicationEventPublisher
publishEvent, publishEvent

Methods inherited from interface org.springframework.core.io.support.ResourcePatternResolver
getResources

Methods inherited from interface org.springframework.core.io.ResourceLoader
getClassLoader, getResource

Methods inherited from interface org.springframework.beans.factory.support.BeanDefinitionRegistry
containsBeanDefinition, getBeanDefinitionCount, getBeanDefinitionNames

Methods inherited from interface org.springframework.core.AliasRegistry
getAliases

- Constructor Detail
  - AnnotationConfigReactiveWebServerApplicationContext
```
public AnnotationConfigReactiveWebServerApplicationContext()
```
    Create a new AnnotationConfigReactiveWebServerApplicationContext that needs to be populated through register(java.lang.Class<?>...) calls and then manually refreshed.
  - AnnotationConfigReactiveWebServerApplicationContext
```
public AnnotationConfigReactiveWebServerApplicationContext(DefaultListableBeanFactory beanFactory)
```
    Create a new AnnotationConfigReactiveWebServerApplicationContext with the given DefaultListableBeanFactory. The context needs to be populated through register(java.lang.Class<?>...) calls and then manually refreshed.
    
    Parameters:
    
    beanFactory - the DefaultListableBeanFactory instance to use for this context
  - AnnotationConfigReactiveWebServerApplicationContext
```
public AnnotationConfigReactiveWebServerApplicationContext(Class<?>... annotatedClasses)
```
    Create a new AnnotationConfigReactiveWebServerApplicationContext, deriving bean definitions from the given annotated classes and automatically refreshing the context.
    
    Parameters:
    
    annotatedClasses - one or more annotated classes, e.g. @Configuration classes
  - AnnotationConfigReactiveWebServerApplicationContext
```
public AnnotationConfigReactiveWebServerApplicationContext(String... basePackages)
```
    Create a new AnnotationConfigReactiveWebServerApplicationContext, scanning for bean definitions in the given packages and automatically refreshing the context.
    
    Parameters:
    
    basePackages - the packages to check for annotated classes
- Method Detail
  - setEnvironment
```
public void setEnvironment(ConfigurableEnvironment environment)
```
    Delegates given environment to underlying AnnotatedBeanDefinitionReader and ClassPathBeanDefinitionScanner members.
    
    Specified by:
    
    setEnvironment in interface ConfigurableApplicationContext
    
    Overrides:
    
    setEnvironment in class AbstractApplicationContext
  - setBeanNameGenerator
```
public void setBeanNameGenerator(BeanNameGenerator beanNameGenerator)
```
    Provide a custom BeanNameGenerator for use with AnnotatedBeanDefinitionReader and/or ClassPathBeanDefinitionScanner, if any.
    Default is AnnotationBeanNameGenerator.
    Any call to this method must occur prior to calls to register(Class...) and/or scan(String...).
    
    Parameters:
    
    beanNameGenerator - the bean name generator
    
    See Also:
    
    AnnotatedBeanDefinitionReader.setBeanNameGenerator(org.springframework.beans.factory.support.BeanNameGenerator), ClassPathBeanDefinitionScanner.setBeanNameGenerator(org.springframework.beans.factory.support.BeanNameGenerator)
  - setScopeMetadataResolver
```
public void setScopeMetadataResolver(ScopeMetadataResolver scopeMetadataResolver)
```
    Set the ScopeMetadataResolver to use for detected bean classes.
    The default is an AnnotationScopeMetadataResolver.
    Any call to this method must occur prior to calls to register(Class...) and/or scan(String...).
    
    Parameters:
    
    scopeMetadataResolver - the scope metadata resolver
  - register
```
public final void register(Class<?>... annotatedClasses)
```
    Register one or more annotated classes to be processed. Note that ReactiveWebServerApplicationContext.refresh() must be called in order for the context to fully process the new class.
    Calls to #register are idempotent; adding the same annotated class more than once has no additional effect.
    
    Specified by:
    
    register in interface AnnotationConfigRegistry
    
    Parameters:
    
    annotatedClasses - one or more annotated classes, e.g. @Configuration classes
    
    See Also:
    
    scan(String...), ReactiveWebServerApplicationContext.refresh()
  - scan
```
public final void scan(String... basePackages)
```
    Perform a scan within the specified base packages. Note that ReactiveWebServerApplicationContext.refresh() must be called in order for the context to fully process the new class.
    
    Specified by:
    
    scan in interface AnnotationConfigRegistry
    
    Parameters:
    
    basePackages - the packages to check for annotated classes
    
    See Also:
    
    register(Class...), ReactiveWebServerApplicationContext.refresh()
  - prepareRefresh
```
protected void prepareRefresh()
```
    Overrides:
    
    prepareRefresh in class AbstractApplicationContext
  - postProcessBeanFactory
```
protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
```
    Overrides:
    
    postProcessBeanFactory in class AbstractApplicationContext

Class AnnotationConfigReactiveWebServerApplicationContext

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.core.io.DefaultResourceLoader

Field Summary

Fields inherited from class org.springframework.context.support.AbstractApplicationContext

Fields inherited from interface org.springframework.context.ConfigurableApplicationContext

Fields inherited from interface org.springframework.beans.factory.BeanFactory

Fields inherited from interface org.springframework.core.io.support.ResourcePatternResolver

Fields inherited from interface org.springframework.core.io.ResourceLoader

Constructor Summary

Method Summary

Methods inherited from class org.springframework.boot.web.reactive.context.ReactiveWebServerApplicationContext

Methods inherited from class org.springframework.boot.web.reactive.context.GenericReactiveWebApplicationContext

Methods inherited from class org.springframework.context.support.GenericApplicationContext

Methods inherited from class org.springframework.context.support.AbstractApplicationContext

Methods inherited from class org.springframework.core.io.DefaultResourceLoader

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.context.ConfigurableApplicationContext

Methods inherited from interface org.springframework.context.Lifecycle

Methods inherited from interface org.springframework.context.ApplicationContext

Methods inherited from interface org.springframework.beans.factory.ListableBeanFactory

Methods inherited from interface org.springframework.beans.factory.HierarchicalBeanFactory

Methods inherited from interface org.springframework.beans.factory.BeanFactory

Methods inherited from interface org.springframework.context.MessageSource

Methods inherited from interface org.springframework.context.ApplicationEventPublisher

Methods inherited from interface org.springframework.core.io.support.ResourcePatternResolver

Methods inherited from interface org.springframework.core.io.ResourceLoader

Methods inherited from interface org.springframework.beans.factory.support.BeanDefinitionRegistry

Methods inherited from interface org.springframework.core.AliasRegistry

Constructor Detail

AnnotationConfigReactiveWebServerApplicationContext

AnnotationConfigReactiveWebServerApplicationContext

AnnotationConfigReactiveWebServerApplicationContext

AnnotationConfigReactiveWebServerApplicationContext

Method Detail

setEnvironment

setBeanNameGenerator

setScopeMetadataResolver

register

scan

prepareRefresh

postProcessBeanFactory