org.springframework.boot.context.embedded

Class AnnotationConfigEmbeddedWebApplicationContext

java.lang.Object

GenericWebApplicationContext

org.springframework.boot.context.embedded.EmbeddedWebApplicationContext

org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext

public class AnnotationConfigEmbeddedWebApplicationContext
extends EmbeddedWebApplicationContext

EmbeddedWebApplicationContext 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.

Author:

Phillip Webb

See Also:

register(Class...), scan(String...), EmbeddedWebApplicationContext, AnnotationConfigWebApplicationContext

Field Summary

Fields inherited from class org.springframework.boot.context.embedded.EmbeddedWebApplicationContext

DISPATCHER_SERVLET_NAME

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	postProcessBeanFactory(org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory) Register ServletContextAwareProcessor.
protected void	prepareRefresh()
void	refresh()
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(org.springframework.beans.factory.support.BeanNameGenerator beanNameGenerator) Provide a custom BeanNameGenerator for use with AnnotatedBeanDefinitionReader and/or ClassPathBeanDefinitionScanner , if any.
void	setEnvironment(org.springframework.core.env.ConfigurableEnvironment environment)
void	setScopeMetadataResolver(org.springframework.context.annotation.ScopeMetadataResolver scopeMetadataResolver) Set the ScopeMetadataResolver to use for detected bean classes.

Methods inherited from class org.springframework.boot.context.embedded.EmbeddedWebApplicationContext

doClose, finishRefresh, getEmbeddedServletContainer, getEmbeddedServletContainerFactory, getNamespace, getResourceByPath, getServletConfig, getServletContextInitializerBeans, onRefresh, prepareEmbeddedWebApplicationContext, setNamespace, setServletConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationConfigEmbeddedWebApplicationContext

public AnnotationConfigEmbeddedWebApplicationContext()

Create a new AnnotationConfigEmbeddedWebApplicationContext that needs to be populated through register(java.lang.Class<?>...) calls and then manually refreshed.

AnnotationConfigEmbeddedWebApplicationContext

public AnnotationConfigEmbeddedWebApplicationContext(Class<?>... annotatedClasses)

Create a new AnnotationConfigEmbeddedWebApplicationContext, deriving bean definitions from the given annotated classes and automatically refreshing the context.

Parameters:

annotatedClasses - one or more annotated classes, e.g. @Configuration classes

AnnotationConfigEmbeddedWebApplicationContext

public AnnotationConfigEmbeddedWebApplicationContext(String... basePackages)

Create a new AnnotationConfigEmbeddedWebApplicationContext, 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(org.springframework.core.env.ConfigurableEnvironment environment)

Delegates given environment to underlying AnnotatedBeanDefinitionReader and ClassPathBeanDefinitionScanner members.

setBeanNameGenerator

public void setBeanNameGenerator(org.springframework.beans.factory.support.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...).

See Also:

AnnotatedBeanDefinitionReader.setBeanNameGenerator(org.springframework.beans.factory.support.BeanNameGenerator), ClassPathBeanDefinitionScanner.setBeanNameGenerator(org.springframework.beans.factory.support.BeanNameGenerator)

setScopeMetadataResolver

public void setScopeMetadataResolver(org.springframework.context.annotation.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...).

register

public final void register(Class<?>... annotatedClasses)

Register one or more annotated classes to be processed. Note that refresh() must be called in order for the context to fully process the new class.

Calls to register(java.lang.Class<?>...) are idempotent; adding the same annotated class more than once has no additional effect.

Parameters:

annotatedClasses - one or more annotated classes, e.g. @Configuration classes

See Also:

scan(String...), refresh()

scan

public final void scan(String... basePackages)

Perform a scan within the specified base packages. Note that refresh() must be called in order for the context to fully process the new class.

Parameters:

basePackages - the packages to check for annotated classes

See Also:

register(Class...), refresh()

prepareRefresh

protected void prepareRefresh()

postProcessBeanFactory

protected void postProcessBeanFactory(org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory)

Description copied from class: EmbeddedWebApplicationContext

Register ServletContextAwareProcessor.

Overrides:

postProcessBeanFactory in class EmbeddedWebApplicationContext

See Also:

ServletContextAwareProcessor

refresh

public final void refresh()
                   throws org.springframework.beans.BeansException,
                          IllegalStateException

Throws:

org.springframework.beans.BeansException

IllegalStateException