org.springframework.scheduling.annotation

Class ScheduledAnnotationBeanPostProcessor

java.lang.Object

org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor

All Implemented Interfaces:

java.util.EventListener, Aware, BeanFactoryAware, BeanPostProcessor, DisposableBean, SmartInitializingSingleton, ApplicationContextAware, ApplicationListener<ContextRefreshedEvent>, EmbeddedValueResolverAware, Ordered

public class ScheduledAnnotationBeanPostProcessor
extends java.lang.Object
implements BeanPostProcessor, Ordered, EmbeddedValueResolverAware, BeanFactoryAware, ApplicationContextAware, SmartInitializingSingleton, ApplicationListener<ContextRefreshedEvent>, DisposableBean

Bean post-processor that registers methods annotated with @Scheduled to be invoked by a TaskScheduler according to the "fixedRate", "fixedDelay", or "cron" expression provided via the annotation.

This post-processor is automatically registered by Spring's <task:annotation-driven> XML element, and also by the

Since:

3.0

Author:

Mark Fisher, Juergen Hoeller, Chris Beams, Elizabeth Chatman

See Also:

Scheduled, EnableScheduling, SchedulingConfigurer, TaskScheduler, ScheduledTaskRegistrar

Field Summary

Fields

Modifier and Type	Field and Description
private ApplicationContext	applicationContext
private BeanFactory	beanFactory
private StringValueResolver	embeddedValueResolver
protected Log	logger
private java.util.Set<java.lang.Class<?>>	nonAnnotatedClasses
private ScheduledTaskRegistrar	registrar
private java.lang.Object	scheduler

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ScheduledAnnotationBeanPostProcessor()

Method Summary

Modifier and Type	Method and Description
void	afterSingletonsInstantiated() Invoked right at the end of the singleton pre-instantiation phase, with a guarantee that all regular singleton beans have been created already.
void	destroy() Invoked by a BeanFactory on destruction of a singleton.
private void	finishRegistration()
int	getOrder() Return the order value of this object, with a higher value meaning greater in terms of sorting.
void	onApplicationEvent(ContextRefreshedEvent event) Handle an application event.
java.lang.Object	postProcessAfterInitialization(java.lang.Object bean, java.lang.String beanName) Apply this BeanPostProcessor to the given new bean instance after any bean initialization callbacks (like InitializingBean's afterPropertiesSet or a custom init-method).
java.lang.Object	postProcessBeforeInitialization(java.lang.Object bean, java.lang.String beanName) Apply this BeanPostProcessor to the given new bean instance before any bean initialization callbacks (like InitializingBean's afterPropertiesSet or a custom init-method).
protected void	processScheduled(Scheduled scheduled, java.lang.reflect.Method method, java.lang.Object bean)
void	setApplicationContext(ApplicationContext applicationContext) Setting an ApplicationContext is optional: If set, registered tasks will be activated in the ContextRefreshedEvent phase; if not set, it will happen at afterSingletonsInstantiated() time.
void	setBeanFactory(BeanFactory beanFactory) Making a BeanFactory available is optional; if not set, SchedulingConfigurer beans won't get autodetected and a scheduler has to be explicitly configured.
void	setEmbeddedValueResolver(StringValueResolver resolver) Set the StringValueResolver to use for resolving embedded definition values.
void	setScheduler(java.lang.Object scheduler) Set the TaskScheduler that will invoke the scheduled methods, or a ScheduledExecutorService to be wrapped as a TaskScheduler.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final Log logger

scheduler

private java.lang.Object scheduler

embeddedValueResolver

private StringValueResolver embeddedValueResolver

beanFactory

private BeanFactory beanFactory

applicationContext

private ApplicationContext applicationContext

registrar

private final ScheduledTaskRegistrar registrar

nonAnnotatedClasses

private final java.util.Set<java.lang.Class<?>> nonAnnotatedClasses

Constructor Detail

ScheduledAnnotationBeanPostProcessor

public ScheduledAnnotationBeanPostProcessor()

Method Detail

getOrder

public int getOrder()

Description copied from interface: Ordered

Return the order value of this object, with a higher value meaning greater in terms of sorting.

Normally starting with 0, with Integer.MAX_VALUE indicating the greatest value. Same order values will result in arbitrary positions for the affected objects.

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

Specified by:

getOrder in interface Ordered

Returns:

the order value

setScheduler

public void setScheduler(java.lang.Object scheduler)

Set the TaskScheduler that will invoke the scheduled methods, or a ScheduledExecutorService to be wrapped as a TaskScheduler.

setEmbeddedValueResolver

public void setEmbeddedValueResolver(StringValueResolver resolver)

Description copied from interface: EmbeddedValueResolverAware

Set the StringValueResolver to use for resolving embedded definition values.

Specified by:

setEmbeddedValueResolver in interface EmbeddedValueResolverAware

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)

Making a BeanFactory available is optional; if not set, SchedulingConfigurer beans won't get autodetected and a scheduler has to be explicitly configured.

Specified by:

setBeanFactory in interface BeanFactoryAware

Parameters:

beanFactory - owning BeanFactory (never null). The bean can immediately call methods on the factory.

See Also:

BeanInitializationException

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)

Setting an ApplicationContext is optional: If set, registered tasks will be activated in the ContextRefreshedEvent phase; if not set, it will happen at afterSingletonsInstantiated() time.

Specified by:

setApplicationContext in interface ApplicationContextAware

Parameters:

applicationContext - the ApplicationContext object to be used by this object

See Also:

BeanInitializationException

afterSingletonsInstantiated

public void afterSingletonsInstantiated()

Description copied from interface: SmartInitializingSingleton

Invoked right at the end of the singleton pre-instantiation phase, with a guarantee that all regular singleton beans have been created already. ListableBeanFactory.getBeansOfType(java.lang.Class<T>) calls within this method won't trigger accidental side effects during bootstrap.

NOTE: This callback won't be triggered for singleton beans lazily initialized on demand after BeanFactory bootstrap, and not for any other bean scope either. Carefully use it for beans with the intended bootstrap semantics only.

Specified by:

afterSingletonsInstantiated in interface SmartInitializingSingleton

onApplicationEvent

public void onApplicationEvent(ContextRefreshedEvent event)

Description copied from interface: ApplicationListener

Handle an application event.

Specified by:

onApplicationEvent in interface ApplicationListener<ContextRefreshedEvent>

Parameters:

event - the event to respond to

finishRegistration

private void finishRegistration()

postProcessBeforeInitialization

public java.lang.Object postProcessBeforeInitialization(java.lang.Object bean,
                                                        java.lang.String beanName)

Description copied from interface: BeanPostProcessor

Apply this BeanPostProcessor to the given new bean instance before any bean initialization callbacks (like InitializingBean's afterPropertiesSet or a custom init-method). The bean will already be populated with property values. The returned bean instance may be a wrapper around the original.

Specified by:

postProcessBeforeInitialization in interface BeanPostProcessor

Parameters:

bean - the new bean instance

beanName - the name of the bean

Returns:

the bean instance to use, either the original or a wrapped one; if null, no subsequent BeanPostProcessors will be invoked

See Also:

InitializingBean.afterPropertiesSet()

postProcessAfterInitialization

public java.lang.Object postProcessAfterInitialization(java.lang.Object bean,
                                                       java.lang.String beanName)

Description copied from interface: BeanPostProcessor

Apply this BeanPostProcessor to the given new bean instance after any bean initialization callbacks (like InitializingBean's afterPropertiesSet or a custom init-method). The bean will already be populated with property values. The returned bean instance may be a wrapper around the original.

In case of a FactoryBean, this callback will be invoked for both the FactoryBean instance and the objects created by the FactoryBean (as of Spring 2.0). The post-processor can decide whether to apply to either the FactoryBean or created objects or both through corresponding bean instanceof FactoryBean checks.

This callback will also be invoked after a short-circuiting triggered by a InstantiationAwareBeanPostProcessor.postProcessBeforeInstantiation(java.lang.Class<?>, java.lang.String) method, in contrast to all other BeanPostProcessor callbacks.

Specified by:

postProcessAfterInitialization in interface BeanPostProcessor

Parameters:

bean - the new bean instance

beanName - the name of the bean

Returns:

the bean instance to use, either the original or a wrapped one; if null, no subsequent BeanPostProcessors will be invoked

See Also:

InitializingBean.afterPropertiesSet(), FactoryBean

processScheduled

protected void processScheduled(Scheduled scheduled,
                                java.lang.reflect.Method method,
                                java.lang.Object bean)

destroy

public void destroy()

Description copied from interface: DisposableBean

Invoked by a BeanFactory on destruction of a singleton.

Specified by:

destroy in interface DisposableBean