Package io.microsphere.spring.config.context.annotation

Class PropertySourceExtensionLoader<A extends java.lang.annotation.Annotation,EA extends PropertySourceExtensionAttributes<A>>

java.lang.Object

io.microsphere.spring.context.annotation.BeanCapableImportCandidate

io.microsphere.spring.config.context.annotation.AnnotatedPropertySourceLoader<A>

io.microsphere.spring.config.context.annotation.PropertySourceExtensionLoader<A,EA>

Type Parameters:

A - The type of Annotation must meta-annotate PropertySourceExtension

EA - The PropertySourceExtensionAttributes or its subtype

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.context.annotation.ImportSelector, org.springframework.context.ApplicationContextAware, org.springframework.context.EnvironmentAware, org.springframework.context.ResourceLoaderAware

Direct Known Subclasses:

ResourcePropertySourceLoader

public abstract class PropertySourceExtensionLoader<A extends java.lang.annotation.Annotation,EA extends PropertySourceExtensionAttributes<A>>
extends AnnotatedPropertySourceLoader<A>
implements org.springframework.context.ApplicationContextAware

Abstract ImportSelector class to load the PropertySource when the configuration annotated the Enable annotation that meta-annotates @PropertySourceExtension

Since:

1.0.0

Author:

Mercy

See Also:

PropertySourceExtension, PropertySourceExtensionAttributes, ImportSelector

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	PropertySourceExtensionLoader.PropertySourceResource	The resource of PropertySource
protected static interface	PropertySourceExtensionLoader.ResourcePropertySourcesRefresher	The Refresher of PropertySources' for Resource

Field Summary

Fields inherited from class io.microsphere.spring.config.context.annotation.AnnotatedPropertySourceLoader

logger, NAME_ATTRIBUTE_NAME

Fields inherited from class io.microsphere.spring.context.annotation.BeanCapableImportCandidate

beanFactory, classLoader, environment, resourceLoader

Constructor Summary

Constructors

Constructor	Description
PropertySourceExtensionLoader()

Method Summary

Modifier and Type	Method	Description
protected void	addPropertySource(EA extensionAttributes, org.springframework.core.env.MutablePropertySources propertySources, org.springframework.core.env.PropertySource<?> propertySource)	Add the PropertySource into PropertySources via PropertySourceExtensionLoader
protected EA	buildExtensionAttributes(java.lang.Class<A> annotationType, java.lang.Class<EA> extensionAttributesType, org.springframework.core.annotation.AnnotationAttributes attributes, org.springframework.core.env.ConfigurableEnvironment environment)	Builds an instance of PropertySourceExtensionLoader
protected void	configureResourcePropertySourcesRefresher(EA extensionAttributes, java.util.List<PropertySourceExtensionLoader.PropertySourceResource> propertySourceResources, org.springframework.core.env.CompositePropertySource propertySource, PropertySourceExtensionLoader.ResourcePropertySourcesRefresher refresher)	Configure the PropertySourceExtensionLoader.ResourcePropertySourcesRefresher of PropertySource Resources when PropertySourceExtension.autoRefreshed() is true
protected <T> T	createInstance(EA extensionAttributes, java.util.function.Function<EA,java.lang.Class<T>> classFunction)
protected org.springframework.core.io.support.PropertySourceFactory	createPropertySourceFactory(EA extensionAttributes)	Creates an instance of PropertySourceFactory
protected java.util.Comparator<org.springframework.core.io.Resource>	createResourceComparator(EA extensionAttributes, java.lang.String propertySourceName)	Creates an instance of Comparator for Resource
protected io.microsphere.spring.config.context.annotation.PropertySourceExtensionLoader.ResourcePropertySource	createResourcePropertySource(EA extensionAttributes, java.lang.String propertySourceName, org.springframework.core.io.support.PropertySourceFactory factory, PropertySourceExtensionLoader.PropertySourceResource propertySourceResource)	Create an instance of PropertySourceExtensionLoader.ResourcePropertySource for the specified resource
protected java.lang.String	createResourcePropertySourceName(java.lang.String propertySourceName, java.lang.String resourceValue, org.springframework.core.io.Resource resource)
java.lang.Class<EA>	getExtensionAttributesType()	Get the type of PropertySourceExtensionLoader
abstract boolean	isResourcePattern(java.lang.String resourceValue)	Test the resource value is pattern or not
protected org.springframework.core.env.PropertySource<?>	loadPropertySource(EA extensionAttributes, java.lang.String propertySourceName)
protected void	loadPropertySource(org.springframework.core.annotation.AnnotationAttributes attributes, org.springframework.core.type.AnnotationMetadata metadata, java.lang.String propertySourceName, org.springframework.core.env.MutablePropertySources propertySources)	Load the PropertySource
protected java.lang.Class<EA>	resolveExtensionAttributesType()
protected java.util.List<PropertySourceExtensionLoader.PropertySourceResource>	resolvePropertySourceResources(EA extensionAttributes, java.lang.String propertySourceName, java.lang.String resourceValue, java.util.Comparator<org.springframework.core.io.Resource> resourceComparator)
protected abstract org.springframework.core.io.Resource[]	resolveResources(EA extensionAttributes, java.lang.String propertySourceName, java.lang.String resourceValue)	Resolve the given resource value(s) to be PropertySourceExtensionLoader.PropertySourceResource array.
void	setApplicationContext(org.springframework.context.ApplicationContext context)

Methods inherited from class io.microsphere.spring.config.context.annotation.AnnotatedPropertySourceLoader

buildDefaultPropertySourceName, buildPropertySourceName, getAnnotationType, getPropertySourceName, resolveAnnotationType, resolvePropertySourceName, selectImports

Methods inherited from class io.microsphere.spring.context.annotation.BeanCapableImportCandidate

getBeanFactory, getClassLoader, getEnvironment, getResourceLoader, setBeanClassLoader, setBeanFactory, setEnvironment, setResourceLoader

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.annotation.ImportSelector

getExclusionFilter

Constructor Detail

PropertySourceExtensionLoader

public PropertySourceExtensionLoader()

Method Detail

resolveExtensionAttributesType

protected java.lang.Class<EA> resolveExtensionAttributesType()

isResourcePattern

public abstract boolean isResourcePattern(java.lang.String resourceValue)

Test the resource value is pattern or not

Parameters:

resourceValue - the String value presenting resource

Returns:

true if resourceValue is a pattern value

getExtensionAttributesType

public final java.lang.Class<EA> getExtensionAttributesType()

Get the type of PropertySourceExtensionLoader

Returns:

non-null

See Also:

PropertySourceExtensionAttributes

loadPropertySource

protected final void loadPropertySource(org.springframework.core.annotation.AnnotationAttributes attributes,
                                        org.springframework.core.type.AnnotationMetadata metadata,
                                        java.lang.String propertySourceName,
                                        org.springframework.core.env.MutablePropertySources propertySources)
                                 throws java.lang.Throwable

Description copied from class: AnnotatedPropertySourceLoader

Load the PropertySource

Specified by:

loadPropertySource in class AnnotatedPropertySourceLoader<A extends java.lang.annotation.Annotation>

Parameters:

attributes - AnnotationAttributes

metadata - AnnotationMetadata

propertySourceName - the name of PropertySource

propertySources - MutablePropertySources to be added

Throws:

java.lang.Throwable - the failure of the loading

addPropertySource

protected void addPropertySource(EA extensionAttributes,
                                 org.springframework.core.env.MutablePropertySources propertySources,
                                 org.springframework.core.env.PropertySource<?> propertySource)

Add the PropertySource into PropertySources via PropertySourceExtensionLoader

Parameters:

extensionAttributes - the annotation attributes of PropertySourceExtension

propertySources - the MutablePropertySources to be added

propertySource - the PropertySource is about to add

buildExtensionAttributes

protected EA buildExtensionAttributes(java.lang.Class<A> annotationType,
                                      java.lang.Class<EA> extensionAttributesType,
                                      org.springframework.core.annotation.AnnotationAttributes attributes,
                                      org.springframework.core.env.ConfigurableEnvironment environment)
                               throws java.lang.Throwable

Builds an instance of PropertySourceExtensionLoader

Parameters:

annotationType - the type of PropertySourceExtensionLoader

extensionAttributesType - the type of PropertySourceExtensionLoader

attributes - AnnotationAttributes

environment - ConfigurableEnvironment

Returns:

non-null

Throws:

java.lang.Throwable

loadPropertySource

protected final org.springframework.core.env.PropertySource<?> loadPropertySource(EA extensionAttributes,
                                                                                  java.lang.String propertySourceName)
                                                                           throws java.lang.Throwable

Throws:

java.lang.Throwable

resolvePropertySourceResources

protected java.util.List<PropertySourceExtensionLoader.PropertySourceResource> resolvePropertySourceResources(EA extensionAttributes,
                                                                                                              java.lang.String propertySourceName,
                                                                                                              java.lang.String resourceValue,
                                                                                                              java.util.Comparator<org.springframework.core.io.Resource> resourceComparator)
                                                                                                       throws java.lang.Throwable

Throws:

java.lang.Throwable

createPropertySourceFactory

@Nonnull
protected org.springframework.core.io.support.PropertySourceFactory createPropertySourceFactory(EA extensionAttributes)

Creates an instance of PropertySourceFactory

Parameters:

extensionAttributes - the annotation attributes of PropertySourceExtension

Returns:

See Also:

PropertySourceExtension.factory(), PropertySourceFactory

createResourceComparator

@Nonnull
protected java.util.Comparator<org.springframework.core.io.Resource> createResourceComparator(EA extensionAttributes,
                                                                                              java.lang.String propertySourceName)

Creates an instance of Comparator for Resource

Parameters:

extensionAttributes - the annotation attributes of PropertySourceExtension

propertySourceName - the name of {PropertySource} declared by PropertySourceExtension.name()

Returns:

an instance of Comparator for Resource

See Also:

PropertySourceExtension.resourceComparator(), Comparator

createResourcePropertySourceName

protected java.lang.String createResourcePropertySourceName(java.lang.String propertySourceName,
                                                            java.lang.String resourceValue,
                                                            org.springframework.core.io.Resource resource)

createResourcePropertySource

protected final io.microsphere.spring.config.context.annotation.PropertySourceExtensionLoader.ResourcePropertySource createResourcePropertySource(EA extensionAttributes,
                                                                                                                                                  java.lang.String propertySourceName,
                                                                                                                                                  org.springframework.core.io.support.PropertySourceFactory factory,
                                                                                                                                                  PropertySourceExtensionLoader.PropertySourceResource propertySourceResource)
                                                                                                                                           throws java.lang.Throwable

Create an instance of PropertySourceExtensionLoader.ResourcePropertySource for the specified resource

Parameters:

extensionAttributes - the annotation attributes of PropertySourceExtension

propertySourceName - the name of {PropertySource} declared by PropertySourceExtension.name()

factory - the factory to the PropertySource declared by PropertySourceExtension.factory()

propertySourceResource - the source of PropertySource

Returns:

an instance of PropertySourceExtensionLoader.ResourcePropertySource

Throws:

java.lang.Throwable

configureResourcePropertySourcesRefresher

protected void configureResourcePropertySourcesRefresher(EA extensionAttributes,
                                                         java.util.List<PropertySourceExtensionLoader.PropertySourceResource> propertySourceResources,
                                                         org.springframework.core.env.CompositePropertySource propertySource,
                                                         PropertySourceExtensionLoader.ResourcePropertySourcesRefresher refresher)
                                                  throws java.lang.Throwable

Configure the PropertySourceExtensionLoader.ResourcePropertySourcesRefresher of PropertySource Resources when PropertySourceExtension.autoRefreshed() is true

Parameters:

extensionAttributes - the annotation attributes of PropertySourceExtension

propertySourceResources - The sorted list of the resolved resources

propertySource - The property source of current loader to be added into the Spring's property sources

refresher - The Refresher of PropertySources' Resource

Throws:

java.lang.Throwable - any error

resolveResources

@Nullable
protected abstract org.springframework.core.io.Resource[] resolveResources(EA extensionAttributes,
                                                                           java.lang.String propertySourceName,
                                                                           java.lang.String resourceValue)
                                                                    throws java.lang.Throwable

Resolve the given resource value(s) to be PropertySourceExtensionLoader.PropertySourceResource array.

Parameters:

extensionAttributes - PropertySourceExtensionLoader

propertySourceName - PropertySourceExtension.name()

resourceValue - the resource value to resolve

Returns:

nullable

Throws:

java.lang.Throwable

createInstance

protected <T> T createInstance(EA extensionAttributes,
                               java.util.function.Function<EA,java.lang.Class<T>> classFunction)

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext context)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware