|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.beans.factory.annotation.InitDestroyAnnotationBeanPostProcessor
public class InitDestroyAnnotationBeanPostProcessor
BeanPostProcessor
implementation
that invokes annotated init and destroy methods. Allows for an annotation
alternative to Spring's InitializingBean
and DisposableBean
callback interfaces.
The actual annotation types that this post-processor checks for can be
configured through the "initAnnotationType"
and "destroyAnnotationType"
properties.
Any custom annotation can be used, since there are no required annotation
attributes.
Init and destroy annotations may be applied to methods of any visibility: public, package-protected, protected, or private. Multiple such methods may be annotated, but it is recommended to only annotate one single init method and destroy method, respectively.
Spring's CommonAnnotationBeanPostProcessor
supports the JSR-250 PostConstruct
and PreDestroy
annotations out of the box, as init annotation and destroy annotation, respectively.
Furthermore, it also supports the Resource
annotation
for annotation-driven injection of named beans.
setInitAnnotationType(java.lang.Class extends java.lang.annotation.Annotation>)
,
setDestroyAnnotationType(java.lang.Class extends java.lang.annotation.Annotation>)
,
Serialized FormNested Class Summary | |
---|---|
private static class |
InitDestroyAnnotationBeanPostProcessor.LifecycleElement
Class representing injection information about an annotated method. |
private class |
InitDestroyAnnotationBeanPostProcessor.LifecycleMetadata
Class representing information about annotated init and destroy methods. |
Field Summary | |
---|---|
private java.lang.Class<? extends java.lang.annotation.Annotation> |
destroyAnnotationType
|
private java.lang.Class<? extends java.lang.annotation.Annotation> |
initAnnotationType
|
private java.util.Map<java.lang.Class<?>,InitDestroyAnnotationBeanPostProcessor.LifecycleMetadata> |
lifecycleMetadataCache
|
protected Log |
logger
|
private int |
order
|
Fields inherited from interface org.springframework.core.Ordered |
---|
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE |
Constructor Summary | |
---|---|
InitDestroyAnnotationBeanPostProcessor()
|
Method Summary | |
---|---|
private InitDestroyAnnotationBeanPostProcessor.LifecycleMetadata |
buildLifecycleMetadata(java.lang.Class clazz)
|
private InitDestroyAnnotationBeanPostProcessor.LifecycleMetadata |
findLifecycleMetadata(java.lang.Class clazz)
|
int |
getOrder()
Return the order value of this object, with a higher value meaning greater in terms of sorting. |
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). |
void |
postProcessBeforeDestruction(java.lang.Object bean,
java.lang.String beanName)
Apply this BeanPostProcessor to the given bean instance before its destruction. |
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). |
void |
postProcessMergedBeanDefinition(RootBeanDefinition beanDefinition,
java.lang.Class beanType,
java.lang.String beanName)
Post-process the given merged bean definition for the specified bean. |
private void |
readObject(java.io.ObjectInputStream ois)
|
void |
setDestroyAnnotationType(java.lang.Class<? extends java.lang.annotation.Annotation> destroyAnnotationType)
Specify the destroy annotation to check for, indicating destruction methods to call when the context is shutting down. |
void |
setInitAnnotationType(java.lang.Class<? extends java.lang.annotation.Annotation> initAnnotationType)
Specify the init annotation to check for, indicating initialization methods to call after configuration of a bean. |
void |
setOrder(int order)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected transient Log logger
private java.lang.Class<? extends java.lang.annotation.Annotation> initAnnotationType
private java.lang.Class<? extends java.lang.annotation.Annotation> destroyAnnotationType
private int order
private final transient java.util.Map<java.lang.Class<?>,InitDestroyAnnotationBeanPostProcessor.LifecycleMetadata> lifecycleMetadataCache
Constructor Detail |
---|
public InitDestroyAnnotationBeanPostProcessor()
Method Detail |
---|
public void setInitAnnotationType(java.lang.Class<? extends java.lang.annotation.Annotation> initAnnotationType)
Any custom annotation can be used, since there are no required
annotation attributes. There is no default, although a typical choice
is the JSR-250 PostConstruct
annotation.
public void setDestroyAnnotationType(java.lang.Class<? extends java.lang.annotation.Annotation> destroyAnnotationType)
Any custom annotation can be used, since there are no required
annotation attributes. There is no default, although a typical choice
is the JSR-250 PreDestroy
annotation.
public void setOrder(int order)
public int getOrder()
Ordered
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).
getOrder
in interface Ordered
public void postProcessMergedBeanDefinition(RootBeanDefinition beanDefinition, java.lang.Class beanType, java.lang.String beanName)
MergedBeanDefinitionPostProcessor
postProcessMergedBeanDefinition
in interface MergedBeanDefinitionPostProcessor
beanDefinition
- the merged bean definition for the beanbeanType
- the actual type of the managed bean instancebeanName
- the name of the beanpublic java.lang.Object postProcessBeforeInitialization(java.lang.Object bean, java.lang.String beanName) throws BeansException
BeanPostProcessor
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.
postProcessBeforeInitialization
in interface BeanPostProcessor
bean
- the new bean instancebeanName
- the name of the bean
null
, no subsequent BeanPostProcessors will be invoked
BeansException
- in case of errorsInitializingBean.afterPropertiesSet()
public java.lang.Object postProcessAfterInitialization(java.lang.Object bean, java.lang.String beanName) throws BeansException
BeanPostProcessor
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.
postProcessAfterInitialization
in interface BeanPostProcessor
bean
- the new bean instancebeanName
- the name of the bean
null
, no subsequent BeanPostProcessors will be invoked
BeansException
- in case of errorsInitializingBean.afterPropertiesSet()
,
FactoryBean
public void postProcessBeforeDestruction(java.lang.Object bean, java.lang.String beanName) throws BeansException
DestructionAwareBeanPostProcessor
Like DisposableBean's destroy
and a custom destroy method,
this callback just applies to singleton beans in the factory (including
inner beans).
postProcessBeforeDestruction
in interface DestructionAwareBeanPostProcessor
bean
- the bean instance to be destroyedbeanName
- the name of the bean
BeansException
- in case of errorsDisposableBean
,
AbstractBeanDefinition.setDestroyMethodName(java.lang.String)
private InitDestroyAnnotationBeanPostProcessor.LifecycleMetadata findLifecycleMetadata(java.lang.Class clazz)
private InitDestroyAnnotationBeanPostProcessor.LifecycleMetadata buildLifecycleMetadata(java.lang.Class clazz)
private void readObject(java.io.ObjectInputStream ois) throws java.io.IOException, java.lang.ClassNotFoundException
java.io.IOException
java.lang.ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |