Spring Framework 6.1.4 · org.springframework.scheduling.config.TaskExecutorFactoryBean

Modifier and Type	Field and Description
private String	beanName
private Integer	keepAliveSeconds
private String	poolSize
private Integer	queueCapacity
private RejectedExecutionHandler	rejectedExecutionHandler
private ThreadPoolTaskExecutor	target References Deprecated `ThreadPoolTaskExecutor` is deprecated or references (maybe indirectly) at least one deprecated element.

Access	Constructor and Description
public	TaskExecutorFactoryBean()

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
public void	destroy() Implements org.springframework.beans.factory.DisposableBean.destroy. Invoked by the containing `BeanFactory` on destruction of a bean.
private void	determinePoolSizeRange(ThreadPoolTaskExecutor executor) References Deprecated `ThreadPoolTaskExecutor` is deprecated or references (maybe indirectly) at least one deprecated element.
public TaskExecutor	getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory.
public Class<? extends TaskExecutor>	getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `null` if not known in advance.
public boolean	isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton?
public void	setBeanName(String the name of the bean in the factory. Note that this name is the actual bean name used in the factory, which may differ from the originally specified name: in particular for inner bean names, the actual bean name might have been made unique through appending "#..." suffixes. Use the `BeanFactoryUtils#originalBeanName(String)` method to extract the original bean name (without suffix), if desired. beanName) Implements org.springframework.beans.factory.BeanNameAware.setBeanName. Set the name of the bean in the bean factory that created this bean.
public void	setKeepAliveSeconds(int keepAliveSeconds)
public void	setPoolSize(String poolSize)
public void	setQueueCapacity(int queueCapacity)
public void	setRejectedExecutionHandler(RejectedExecutionHandler rejectedExecutionHandler)

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

beanName	back to summary
private String beanName Annotations @Nullable

keepAliveSeconds	back to summary
private Integer keepAliveSeconds Annotations @Nullable

poolSize	back to summary
private String poolSize Annotations @Nullable

queueCapacity	back to summary
private Integer queueCapacity Annotations @Nullable

rejectedExecutionHandler	back to summary
private RejectedExecutionHandler rejectedExecutionHandler Annotations @Nullable

target	back to summary
private ThreadPoolTaskExecutor target References Deprecated `ThreadPoolTaskExecutor` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Annotations @Nullable

TaskExecutorFactoryBean	back to summary
public TaskExecutorFactoryBean()

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set. Annotations @Override

public void afterPropertiesSet()

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

Annotations

@Override

destroy back to summary

destroy	back to summary
public void destroy() Implements org.springframework.beans.factory.DisposableBean.destroy. Doc from org.springframework.beans.factory.DisposableBean.destroy. Invoked by the containing `BeanFactory` on destruction of a bean. Annotations @Override

public void destroy()

Implements org.springframework.beans.factory.DisposableBean.destroy.

Doc from org.springframework.beans.factory.DisposableBean.destroy.

Invoked by the containing BeanFactory on destruction of a bean.

Annotations

@Override

determinePoolSizeRange	back to summary
private void determinePoolSizeRange(ThreadPoolTaskExecutor executor) References Deprecated `ThreadPoolTaskExecutor` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

getObject back to summary

getObject	back to summary
public TaskExecutor getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Doc from org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory. As with a `BeanFactory`, this allows support for both the Singleton and Prototype design pattern. If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding `FactoryBeanNotInitializedException`. As of Spring 2.0, FactoryBeans are allowed to return `null` objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate. Returns:TaskExecutor an instance of the bean (can be `null`) Annotations @Override @Nullable

public TaskExecutor getObject()

Implements org.springframework.beans.factory.FactoryBean.getObject.

Doc from org.springframework.beans.factory.FactoryBean.getObject.

Return an instance (possibly shared or independent) of the object managed by this factory.

As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding FactoryBeanNotInitializedException.

As of Spring 2.0, FactoryBeans are allowed to return null objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.

Returns:TaskExecutor

an instance of the bean (can be null)

Annotations

@Override
@Nullable

getObjectType back to summary

getObjectType	back to summary
public Class<? extends TaskExecutor> getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Doc from org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `null` if not known in advance. This allows one to check for specific types of beans without instantiating objects, for example on autowiring. In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too. This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available. Note Autowiring will simply ignore FactoryBeans that return `null` here. Therefore, it is highly recommended to implement this method properly, using the current state of the FactoryBean. Returns:Class<? extends TaskExecutor> the type of object that this FactoryBean creates, or `null` if not known at the time of the call Annotations @Override

public Class<? extends TaskExecutor> getObjectType()

Implements org.springframework.beans.factory.FactoryBean.getObjectType.

Doc from org.springframework.beans.factory.FactoryBean.getObjectType.

Return the type of object that this FactoryBean creates, or null if not known in advance.

This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

Note

Autowiring will simply ignore FactoryBeans that return null here. Therefore, it is highly recommended to implement this method properly, using the current state of the FactoryBean.

Returns:Class<? extends TaskExecutor>

the type of object that this FactoryBean creates, or null if not known at the time of the call

Annotations

@Override

isSingleton back to summary

isSingleton	back to summary
public boolean isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Doc from org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton? That is, will `getObject()` always return the same object (a reference that can be cached)? Note If a FactoryBean indicates to hold a singleton object, the object returned from `getObject()` might get cached by the owning BeanFactory. Hence, do not return `true` unless the FactoryBean always exposes the same reference. The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there. Note This method returning `false` does not necessarily indicate that returned objects are independent instances. An implementation of the extended `SmartFactoryBean` interface may explicitly indicate independent instances through its `SmartFactoryBean#isPrototype()` method. Plain `FactoryBean` implementations which do not implement this extended interface are simply assumed to always return independent instances if the `isSingleton()` implementation returns `false`. The default implementation returns `true`, since a `FactoryBean` typically manages a singleton instance. Returns:boolean whether the exposed object is a singleton Annotations @Override

public boolean isSingleton()

Overrides default org.springframework.beans.factory.FactoryBean.isSingleton.

Doc from org.springframework.beans.factory.FactoryBean.isSingleton.

Is the object managed by this factory a singleton? That is, will getObject() always return the same object (a reference that can be cached)?

Note

If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory. Hence, do not return true unless the FactoryBean always exposes the same reference.

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

Note

This method returning false does not necessarily indicate that returned objects are independent instances. An implementation of the extended SmartFactoryBean interface may explicitly indicate independent instances through its SmartFactoryBean#isPrototype() method. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if the isSingleton() implementation returns false.

The default implementation returns true, since a FactoryBean typically manages a singleton instance.

Returns:boolean

whether the exposed object is a singleton

Annotations

@Override

setBeanName back to summary

setBeanName	back to summary
public void setBeanName(String beanName) Implements org.springframework.beans.factory.BeanNameAware.setBeanName. Doc from org.springframework.beans.factory.BeanNameAware.setBeanName. Set the name of the bean in the bean factory that created this bean. Invoked after population of normal bean properties but before an init callback such as `InitializingBean#afterPropertiesSet()` or a custom init-method. Parameters beanName:String the name of the bean in the factory. Note that this name is the actual bean name used in the factory, which may differ from the originally specified name: in particular for inner bean names, the actual bean name might have been made unique through appending "#..." suffixes. Use the `BeanFactoryUtils#originalBeanName(String)` method to extract the original bean name (without suffix), if desired. Annotations @Override

public void setBeanName(String beanName)

Implements org.springframework.beans.factory.BeanNameAware.setBeanName.

Doc from org.springframework.beans.factory.BeanNameAware.setBeanName.

Set the name of the bean in the bean factory that created this bean.

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

Parameters

beanName:String: the name of the bean in the factory. Note that this name is the actual bean name used in the factory, which may differ from the originally specified name: in particular for inner bean names, the actual bean name might have been made unique through appending "#..." suffixes. Use the BeanFactoryUtils#originalBeanName(String) method to extract the original bean name (without suffix), if desired.

Annotations

@Override

setKeepAliveSeconds	back to summary
public void setKeepAliveSeconds(int keepAliveSeconds)

setPoolSize	back to summary
public void setPoolSize(String poolSize)

setQueueCapacity	back to summary
public void setQueueCapacity(int queueCapacity)

setRejectedExecutionHandler	back to summary
public void setRejectedExecutionHandler(RejectedExecutionHandler rejectedExecutionHandler)

public Class TaskExecutorFactoryBean

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail