/*
 * Copyright 2002-2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.beans.factory.config;

import org.springframework.beans.BeansException;

Subinterface of BeanPostProcessor that adds a before-destruction callback.

The typical usage will be to invoke custom destruction callbacks on specific bean types, matching corresponding initialization callbacks.

Author:Juergen Hoeller
Since:1.0.1
/** * Subinterface of {@link BeanPostProcessor} that adds a before-destruction callback. * * <p>The typical usage will be to invoke custom destruction callbacks on * specific bean types, matching corresponding initialization callbacks. * * @author Juergen Hoeller * @since 1.0.1 */
public interface DestructionAwareBeanPostProcessor extends BeanPostProcessor {
Apply this BeanPostProcessor to the given bean instance before its destruction, e.g. invoking custom destruction callbacks.

Like DisposableBean's destroy and a custom destroy method, this callback will only apply to beans which the container fully manages the lifecycle for. This is usually the case for singletons and scoped beans.

Params:
  • bean – the bean instance to be destroyed
  • beanName – the name of the bean
Throws:
See Also:
/** * Apply this BeanPostProcessor to the given bean instance before its * destruction, e.g. invoking custom destruction callbacks. * <p>Like DisposableBean's {@code destroy} and a custom destroy method, this * callback will only apply to beans which the container fully manages the * lifecycle for. This is usually the case for singletons and scoped beans. * @param bean the bean instance to be destroyed * @param beanName the name of the bean * @throws org.springframework.beans.BeansException in case of errors * @see org.springframework.beans.factory.DisposableBean#destroy() * @see org.springframework.beans.factory.support.AbstractBeanDefinition#setDestroyMethodName(String) */
void postProcessBeforeDestruction(Object bean, String beanName) throws BeansException;
Determine whether the given bean instance requires destruction by this post-processor.

The default implementation returns true. If a pre-5 implementation of DestructionAwareBeanPostProcessor does not provide a concrete implementation of this method, Spring silently assumes true as well.

Params:
  • bean – the bean instance to check
Returns:true if postProcessBeforeDestruction is supposed to be called for this bean instance eventually, or false if not needed
Since:4.3
/** * Determine whether the given bean instance requires destruction by this * post-processor. * <p>The default implementation returns {@code true}. If a pre-5 implementation * of {@code DestructionAwareBeanPostProcessor} does not provide a concrete * implementation of this method, Spring silently assumes {@code true} as well. * @param bean the bean instance to check * @return {@code true} if {@link #postProcessBeforeDestruction} is supposed to * be called for this bean instance eventually, or {@code false} if not needed * @since 4.3 */
default boolean requiresDestruction(Object bean) { return true; } }