View Javadoc

1   /**
2    * This file Copyright (c) 2010 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.blossom.support;
35  
36  import java.util.List;
37  
38  import org.apache.commons.logging.Log;
39  import org.apache.commons.logging.LogFactory;
40  import org.springframework.beans.factory.DisposableBean;
41  import org.springframework.beans.factory.config.BeanPostProcessor;
42  import org.springframework.beans.factory.config.DestructionAwareBeanPostProcessor;
43  import org.springframework.beans.factory.support.AbstractBeanFactory;
44  
45  /**
46   * Utility methods for BeanFactory.
47   *
48   * @since 1.2
49   */
50  public class BeanFactoryUtils {
51  
52      private static final Log logger = LogFactory.getLog(BeanFactoryUtils.class);
53  
54      /**
55       * Destroys a bean by applying destruction aware post processors and invoking destroy methods.
56       */
57      public static void destroyBean(Object bean, String beanName, AbstractBeanFactory beanFactory) {
58          applyBeanPostProcessorsBeforeDestruction(bean, beanName, beanFactory);
59          disposeBean(bean, beanName);
60      }
61  
62      /**
63       * Invokes destroy method on the bean if it implements DisposableBean.
64       */
65      public static void disposeBean(Object bean, String beanName) {
66          if (bean instanceof DisposableBean) {
67              try {
68                  ((DisposableBean) bean).destroy();
69              } catch (Throwable ex) {
70                  String msg = "Invocation of destroy method failed on bean with name '" + beanName + "'";
71                  if (logger.isDebugEnabled()) {
72                      logger.warn(msg, ex);
73                  } else {
74                      logger.warn(msg + ": " + ex);
75                  }
76              }
77          }
78      }
79  
80      /**
81       * Applies destruction aware post processors on the supplied bean.
82       */
83      public static void applyBeanPostProcessorsBeforeDestruction(Object bean, String beanName, AbstractBeanFactory beanFactory) {
84          List<BeanPostProcessor> beanPostProcessors = beanFactory.getBeanPostProcessors();
85          if (beanPostProcessors != null && !beanPostProcessors.isEmpty()) {
86              for (int i = beanPostProcessors.size() - 1; i >= 0; i--) {
87                  Object postProcessor = beanPostProcessors.get(i);
88                  if (postProcessor instanceof DestructionAwareBeanPostProcessor)
89                      ((DestructionAwareBeanPostProcessor) postProcessor).postProcessBeforeDestruction(bean, beanName);
90              }
91          }
92      }
93  }