Spring Framework 6.1.4 · org.springframework.beans.factory.config.CustomScopeConfigurer

Simple BeanFactoryPostProcessor implementation that registers custom Scope(s) with the containing ConfigurableBeanFactory.

Will register all of the supplied scopes with the ConfigurableListableBeanFactory that is passed to the postProcessBeanFactory(ConfigurableListableBeanFactory) method.

This class allows for declarative registration of custom scopes. Alternatively, consider implementing a custom BeanFactoryPostProcessor that calls ConfigurableBeanFactory#registerScope programmatically.

Modifier and Type	Field and Description
private ClassLoader	beanClassLoader
private int	order
private Map<String, Object>	scopes

Constructor Summary

Access	Constructor and Description
public	CustomScopeConfigurer()

Method Summary

Modifier and Type	Method and Description
public void	addScope(String the name of the scope scopeName, Scope the scope implementation scope) Add the given scope to this configurer's map of scopes.
public int	getOrder() Implements org.springframework.core.Ordered.getOrder. Get the order value of this object.
public void	postProcessBeanFactory(ConfigurableListableBeanFactory the bean factory used by the application context beanFactory) Implements org.springframework.beans.factory.config.BeanFactoryPostProcessor.postProcessBeanFactory. Modify the application context's internal bean factory after its standard initialization.
public void	setBeanClassLoader(ClassLoader the owning class loader beanClassLoader) Implements org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader. Callback that supplies the bean `class loader` to a bean instance.
public void	setOrder(int order)
public void	setScopes(Map<String, Object> scopes) Specify the custom scopes that are to be registered.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

beanClassLoader	back to summary
private ClassLoader beanClassLoader Annotations @Nullable

order	back to summary
private int order

scopes	back to summary
private Map<String, Object> scopes Annotations @Nullable

Constructor Detail

CustomScopeConfigurer	back to summary
public CustomScopeConfigurer()

Method Detail

addScope	back to summary
public void addScope(String scopeName, Scope scope) Add the given scope to this configurer's map of scopes. Parameters scopeName:String the name of the scope scope:Scope the scope implementation Since 4.1.1

addScope

back to summary

public void addScope(String scopeName, Scope scope)

Add the given scope to this configurer's map of scopes.

Parameters

scopeName:String: the name of the scope
scope:Scope: the scope implementation

Since

4.1.1

getOrder back to summary

getOrder	back to summary
public int getOrder() Implements org.springframework.core.Ordered.getOrder. Doc from org.springframework.core.Ordered.getOrder. Get the order value of this object. Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet `load-on-startup` values). Same order values will result in arbitrary sort positions for the affected objects. Returns:int the order value Annotations @Override

public int getOrder()

Implements org.springframework.core.Ordered.getOrder.

Doc from org.springframework.core.Ordered.getOrder.

Get the order value of this object.

Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet load-on-startup values).

Same order values will result in arbitrary sort positions for the affected objects.

Returns:int

the order value

Annotations

@Override

postProcessBeanFactory	back to summary
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException Implements org.springframework.beans.factory.config.BeanFactoryPostProcessor.postProcessBeanFactory. Doc from org.springframework.beans.factory.config.BeanFactoryPostProcessor.postProcessBeanFactory. Modify the application context's internal bean factory after its standard initialization. All bean definitions will have been loaded, but no beans will have been instantiated yet. This allows for overriding or adding properties even to eager-initializing beans. Parameters beanFactory:ConfigurableListableBeanFactory the bean factory used by the application context Annotations @Override Exceptions BeansException: in case of errors

postProcessBeanFactory

back to summary

public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException

Implements org.springframework.beans.factory.config.BeanFactoryPostProcessor.postProcessBeanFactory.

Doc from org.springframework.beans.factory.config.BeanFactoryPostProcessor.postProcessBeanFactory.

Modify the application context's internal bean factory after its standard initialization. All bean definitions will have been loaded, but no beans will have been instantiated yet. This allows for overriding or adding properties even to eager-initializing beans.

Parameters

beanFactory:ConfigurableListableBeanFactory: the bean factory used by the application context

Annotations

@Override

Exceptions

BeansException:: in case of errors

setBeanClassLoader back to summary

setBeanClassLoader	back to summary
public void setBeanClassLoader(ClassLoader beanClassLoader) Implements org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader. Doc from org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader. Callback that supplies the bean `class loader` to a bean instance. Invoked after the population of normal bean properties but before an initialization callback such as `InitializingBean's` `InitializingBean#afterPropertiesSet()` method or a custom init-method. Parameters beanClassLoader:ClassLoader the owning class loader Annotations @Override

public void setBeanClassLoader(ClassLoader beanClassLoader)

Implements org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader.

Doc from org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader.

Callback that supplies the bean class loader to a bean instance.

Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean's InitializingBean#afterPropertiesSet() method or a custom init-method.

Parameters

beanClassLoader:ClassLoader: the owning class loader

Annotations

@Override

setOrder	back to summary
public void setOrder(int order)

setScopes back to summary

setScopes	back to summary
public void setScopes(Map<String, Object> scopes) Specify the custom scopes that are to be registered. The keys indicate the scope names (of type String); each value is expected to be the corresponding custom `Scope` instance or class name.

public void setScopes(Map<String, Object> scopes)

Specify the custom scopes that are to be registered.

The keys indicate the scope names (of type String); each value is expected to be the corresponding custom Scope instance or class name.

public Class CustomScopeConfigurer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail