Package org.springframework.boot.autoconfigure

Class AutoConfigurationImportSelector

java.lang.Object

org.springframework.boot.autoconfigure.AutoConfigurationImportSelector

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, DeferredImportSelector, ImportSelector, EnvironmentAware, ResourceLoaderAware, Ordered

public class AutoConfigurationImportSelector
extends Object
implements DeferredImportSelector, BeanClassLoaderAware, ResourceLoaderAware, BeanFactoryAware, EnvironmentAware, Ordered

DeferredImportSelector to handle auto-configuration. This class can also be subclassed if a custom variant of @EnableAutoConfiguration is needed.

Since:

1.3.0

Author:

Phillip Webb, Andy Wilkinson, Stephane Nicoll, Madhura Bhave, Moritz Halbritter

See Also:

• EnableAutoConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AutoConfigurationImportSelector.AutoConfigurationEntry

Nested classes/interfaces inherited from interface org.springframework.context.annotation.DeferredImportSelector

DeferredImportSelector.Group

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
AutoConfigurationImportSelector()

Method Summary

Modifier and Type	Method	Description
protected final List<String>	asList(AnnotationAttributes attributes, String name)
protected Class<?>	getAnnotationClass()	Return the source annotation class used by the selector.
protected AnnotationAttributes	getAttributes(AnnotationMetadata metadata)	Return the appropriate AnnotationAttributes from the AnnotationMetadata.
protected AutoConfigurationImportSelector.AutoConfigurationEntry	getAutoConfigurationEntry(AnnotationMetadata annotationMetadata)	Return the AutoConfigurationImportSelector.AutoConfigurationEntry based on the AnnotationMetadata of the importing @Configuration class.
protected List<AutoConfigurationImportFilter>	getAutoConfigurationImportFilters()
protected List<AutoConfigurationImportListener>	getAutoConfigurationImportListeners()
protected ClassLoader	getBeanClassLoader()
protected final ConfigurableListableBeanFactory	getBeanFactory()
protected List<String>	getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes)	Return the auto-configuration class names that should be considered.
protected final Environment	getEnvironment()
protected List<String>	getExcludeAutoConfigurationsProperty()	Returns the auto-configurations excluded by the spring.autoconfigure.exclude property.
Predicate<String>	getExclusionFilter()
protected Set<String>	getExclusions(AnnotationMetadata metadata, AnnotationAttributes attributes)	Return any exclusions that limit the candidate configurations.
Class<? extends DeferredImportSelector.Group>	getImportGroup()
int	getOrder()
protected final ResourceLoader	getResourceLoader()
protected Class<?>	getSpringFactoriesLoaderFactoryClass()	Return the class used by SpringFactoriesLoader to load configuration candidates.
protected void	handleInvalidExcludes(List<String> invalidExcludes)	Handle any invalid excludes that have been specified.
protected boolean	isEnabled(AnnotationMetadata metadata)
protected final <T> List<T>	removeDuplicates(List<T> list)
String[]	selectImports(AnnotationMetadata annotationMetadata)
void	setBeanClassLoader(ClassLoader classLoader)
void	setBeanFactory(BeanFactory beanFactory)
void	setEnvironment(Environment environment)
void	setResourceLoader(ResourceLoader resourceLoader)

Methods inherited from class java.lang.Object

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

Constructor Details

AutoConfigurationImportSelector

public AutoConfigurationImportSelector()

Method Details

selectImports

public String[] selectImports(AnnotationMetadata annotationMetadata)

Specified by:

selectImports in interface ImportSelector

getExclusionFilter

public Predicate<String> getExclusionFilter()

Specified by:

getExclusionFilter in interface ImportSelector

getAutoConfigurationEntry

protected AutoConfigurationImportSelector.AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata)

Return the AutoConfigurationImportSelector.AutoConfigurationEntry based on the AnnotationMetadata of the importing @Configuration class.

Parameters:

annotationMetadata - the annotation metadata of the configuration class

Returns:

the auto-configurations that should be imported

getImportGroup

public Class<? extends DeferredImportSelector.Group> getImportGroup()

Specified by:

getImportGroup in interface DeferredImportSelector

isEnabled

protected boolean isEnabled(AnnotationMetadata metadata)

getAttributes

protected AnnotationAttributes getAttributes(AnnotationMetadata metadata)

Return the appropriate AnnotationAttributes from the AnnotationMetadata. By default this method will return attributes for getAnnotationClass().

Parameters:

metadata - the annotation metadata

Returns:

annotation attributes

getAnnotationClass

protected Class<?> getAnnotationClass()

Return the source annotation class used by the selector.

Returns:

the annotation class

getCandidateConfigurations

protected List<String> getCandidateConfigurations(AnnotationMetadata metadata,
 AnnotationAttributes attributes)

Return the auto-configuration class names that should be considered. By default this method will load candidates using ImportCandidates with getSpringFactoriesLoaderFactoryClass(). For backward compatible reasons it will also consider SpringFactoriesLoader with getSpringFactoriesLoaderFactoryClass().

Parameters:

metadata - the source metadata

attributes - the annotation attributes

Returns:

a list of candidate configurations

getSpringFactoriesLoaderFactoryClass

protected Class<?> getSpringFactoriesLoaderFactoryClass()

Return the class used by SpringFactoriesLoader to load configuration candidates.

Returns:

the factory class

handleInvalidExcludes

protected void handleInvalidExcludes(List<String> invalidExcludes)

Handle any invalid excludes that have been specified.

Parameters:

invalidExcludes - the list of invalid excludes (will always have at least one element)

getExclusions

protected Set<String> getExclusions(AnnotationMetadata metadata,
 AnnotationAttributes attributes)

Return any exclusions that limit the candidate configurations.

Parameters:

metadata - the source metadata

attributes - the annotation attributes

Returns:

exclusions or an empty set

getExcludeAutoConfigurationsProperty

protected List<String> getExcludeAutoConfigurationsProperty()

Returns the auto-configurations excluded by the spring.autoconfigure.exclude property.

Returns:

excluded auto-configurations

Since:

2.3.2

getAutoConfigurationImportFilters

protected List<AutoConfigurationImportFilter> getAutoConfigurationImportFilters()

removeDuplicates

protected final <T> List<T> removeDuplicates(List<T> list)

asList

protected final List<String> asList(AnnotationAttributes attributes,
 String name)

getAutoConfigurationImportListeners

protected List<AutoConfigurationImportListener> getAutoConfigurationImportListeners()

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Specified by:

setBeanFactory in interface BeanFactoryAware

Throws:

BeansException

getBeanFactory

protected final ConfigurableListableBeanFactory getBeanFactory()

setBeanClassLoader

public void setBeanClassLoader(ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

getBeanClassLoader

protected ClassLoader getBeanClassLoader()

setEnvironment

public void setEnvironment(Environment environment)

Specified by:

setEnvironment in interface EnvironmentAware

getEnvironment

protected final Environment getEnvironment()

setResourceLoader

public void setResourceLoader(ResourceLoader resourceLoader)

Specified by:

setResourceLoader in interface ResourceLoaderAware

getResourceLoader

protected final ResourceLoader getResourceLoader()

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered