org.springframework.beans.factory.support

Class DisposableBeanAdapter

java.lang.Object

org.springframework.beans.factory.support.DisposableBeanAdapter

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, DisposableBean

class DisposableBeanAdapter
extends java.lang.Object
implements DisposableBean, java.lang.Runnable, java.io.Serializable

Adapter that implements the DisposableBean and Runnable interfaces performing various destruction steps on a given bean instance:

• DestructionAwareBeanPostProcessors;
• the bean implementing DisposableBean itself;
• a custom destroy method specified on the bean definition.

Since:

2.0

Author:

Juergen Hoeller, Costin Leau, Stephane Nicoll

See Also:

AbstractBeanFactory, DisposableBean, DestructionAwareBeanPostProcessor, AbstractBeanDefinition.getDestroyMethodName()

Field Summary

Fields

Modifier and Type	Field and Description
private java.security.AccessControlContext	acc
private java.lang.Object	bean
private java.lang.String	beanName
private java.util.List<DestructionAwareBeanPostProcessor>	beanPostProcessors
private static java.lang.String	CLOSE_METHOD_NAME
private java.lang.reflect.Method	destroyMethod
private java.lang.String	destroyMethodName
private boolean	invokeDisposableBean
private static Log	logger
private boolean	nonPublicAccessAllowed
private static java.lang.String	SHUTDOWN_METHOD_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
	DisposableBeanAdapter(java.lang.Object bean, java.util.List<BeanPostProcessor> postProcessors, java.security.AccessControlContext acc) Create a new DisposableBeanAdapter for the given bean.
private	DisposableBeanAdapter(java.lang.Object bean, java.lang.String beanName, boolean invokeDisposableBean, boolean nonPublicAccessAllowed, java.lang.String destroyMethodName, java.util.List<DestructionAwareBeanPostProcessor> postProcessors) Create a new DisposableBeanAdapter for the given bean.
	DisposableBeanAdapter(java.lang.Object bean, java.lang.String beanName, RootBeanDefinition beanDefinition, java.util.List<BeanPostProcessor> postProcessors, java.security.AccessControlContext acc) Create a new DisposableBeanAdapter for the given bean.

Method Summary

Modifier and Type	Method and Description
void	destroy() Invoked by a BeanFactory on destruction of a singleton.
private java.lang.reflect.Method	determineDestroyMethod()
private java.util.List<DestructionAwareBeanPostProcessor>	filterPostProcessors(java.util.List<BeanPostProcessor> processors, java.lang.Object bean) Search for all DestructionAwareBeanPostProcessors in the List.
private java.lang.reflect.Method	findDestroyMethod()
static boolean	hasApplicableProcessors(java.lang.Object bean, java.util.List<BeanPostProcessor> postProcessors) Check whether the given bean has destruction-aware post-processors applying to it.
static boolean	hasDestroyMethod(java.lang.Object bean, RootBeanDefinition beanDefinition) Check whether the given bean has any kind of destroy method to call.
private java.lang.String	inferDestroyMethodIfNecessary(java.lang.Object bean, RootBeanDefinition beanDefinition) If the current value of the given beanDefinition's "destroyMethodName" property is AbstractBeanDefinition.INFER_METHOD, then attempt to infer a destroy method.
private void	invokeCustomDestroyMethod(java.lang.reflect.Method destroyMethod) Invoke the specified custom destroy method on the given bean.
void	run()
protected java.lang.Object	writeReplace() Serializes a copy of the state of this class, filtering out non-serializable BeanPostProcessors.

Methods inherited from class java.lang.Object

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

Field Detail

CLOSE_METHOD_NAME

private static final java.lang.String CLOSE_METHOD_NAME

See Also:

Constant Field Values

SHUTDOWN_METHOD_NAME

private static final java.lang.String SHUTDOWN_METHOD_NAME

See Also:

Constant Field Values

logger

private static final Log logger

bean

private final java.lang.Object bean

beanName

private final java.lang.String beanName

invokeDisposableBean

private final boolean invokeDisposableBean

nonPublicAccessAllowed

private final boolean nonPublicAccessAllowed

acc

private final java.security.AccessControlContext acc

destroyMethodName

private java.lang.String destroyMethodName

destroyMethod

private transient java.lang.reflect.Method destroyMethod

beanPostProcessors

private java.util.List<DestructionAwareBeanPostProcessor> beanPostProcessors

Constructor Detail

DisposableBeanAdapter

public DisposableBeanAdapter(java.lang.Object bean,
                             java.lang.String beanName,
                             RootBeanDefinition beanDefinition,
                             java.util.List<BeanPostProcessor> postProcessors,
                             java.security.AccessControlContext acc)

Create a new DisposableBeanAdapter for the given bean.

Parameters:

bean - the bean instance (never null)

beanName - the name of the bean

beanDefinition - the merged bean definition

postProcessors - the List of BeanPostProcessors (potentially DestructionAwareBeanPostProcessor), if any

DisposableBeanAdapter

public DisposableBeanAdapter(java.lang.Object bean,
                             java.util.List<BeanPostProcessor> postProcessors,
                             java.security.AccessControlContext acc)

Create a new DisposableBeanAdapter for the given bean.

Parameters:

bean - the bean instance (never null)

postProcessors - the List of BeanPostProcessors (potentially DestructionAwareBeanPostProcessor), if any

DisposableBeanAdapter

private DisposableBeanAdapter(java.lang.Object bean,
                              java.lang.String beanName,
                              boolean invokeDisposableBean,
                              boolean nonPublicAccessAllowed,
                              java.lang.String destroyMethodName,
                              java.util.List<DestructionAwareBeanPostProcessor> postProcessors)

Create a new DisposableBeanAdapter for the given bean.

Method Detail

inferDestroyMethodIfNecessary

private java.lang.String inferDestroyMethodIfNecessary(java.lang.Object bean,
                                                       RootBeanDefinition beanDefinition)

If the current value of the given beanDefinition's "destroyMethodName" property is AbstractBeanDefinition.INFER_METHOD, then attempt to infer a destroy method. Candidate methods are currently limited to public, no-arg methods named "close" or "shutdown" (whether declared locally or inherited). The given BeanDefinition's "destroyMethodName" is updated to be null if no such method is found, otherwise set to the name of the inferred method. This constant serves as the default for the @Bean#destroyMethod attribute and the value of the constant may also be used in XML within the <bean destroy-method=""> or <beans default-destroy-method=""> attributes.

Also processes the Closeable and AutoCloseable interfaces, reflectively calling the "close" method on implementing beans as well.

filterPostProcessors

private java.util.List<DestructionAwareBeanPostProcessor> filterPostProcessors(java.util.List<BeanPostProcessor> processors,
                                                                               java.lang.Object bean)

Search for all DestructionAwareBeanPostProcessors in the List.

Parameters:

processors - the List to search

Returns:

the filtered List of DestructionAwareBeanPostProcessors

run

public void run()

Specified by:

run in interface java.lang.Runnable

destroy

public void destroy()

Description copied from interface: DisposableBean

Invoked by a BeanFactory on destruction of a singleton.

Specified by:

destroy in interface DisposableBean

determineDestroyMethod

private java.lang.reflect.Method determineDestroyMethod()

findDestroyMethod

private java.lang.reflect.Method findDestroyMethod()

invokeCustomDestroyMethod

private void invokeCustomDestroyMethod(java.lang.reflect.Method destroyMethod)

Invoke the specified custom destroy method on the given bean.

This implementation invokes a no-arg method if found, else checking for a method with a single boolean argument (passing in "true", assuming a "force" parameter), else logging an error.

writeReplace

protected java.lang.Object writeReplace()

Serializes a copy of the state of this class, filtering out non-serializable BeanPostProcessors.

hasDestroyMethod

public static boolean hasDestroyMethod(java.lang.Object bean,
                                       RootBeanDefinition beanDefinition)

Check whether the given bean has any kind of destroy method to call.

Parameters:

bean - the bean instance

beanDefinition - the corresponding bean definition

hasApplicableProcessors

public static boolean hasApplicableProcessors(java.lang.Object bean,
                                              java.util.List<BeanPostProcessor> postProcessors)

Check whether the given bean has destruction-aware post-processors applying to it.

Parameters:

bean - the bean instance

postProcessors - the post-processor candidates