View Javadoc

1   /**
2    * This file Copyright (c) 2010-2011 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 org.springframework.context.ApplicationContext;
37  import org.springframework.context.ApplicationContextAware;
38  import org.springframework.context.ApplicationEvent;
39  import org.springframework.context.ApplicationListener;
40  
41  import info.magnolia.module.blossom.dispatcher.BlossomDispatcher;
42  import info.magnolia.module.blossom.dispatcher.BlossomDispatcherAware;
43  import info.magnolia.module.blossom.dispatcher.BlossomDispatcherInitializedEvent;
44  
45  /**
46   * Abstract base class for beans that want to inspect other beans configured in the same bean factory. Will detect
47   * lazy-init beans.
48   *
49   * @since 1.1.1
50   */
51  public abstract class AbstractBeanDetector implements ApplicationContextAware, ApplicationListener, BlossomDispatcherAware {
52  
53      private BlossomDispatcher dispatcher;
54      private ApplicationContext applicationContext;
55      private Class<?> type = Object.class;
56  
57      public ApplicationContext getApplicationContext() {
58          return applicationContext;
59      }
60  
61      @Override
62      public void setApplicationContext(ApplicationContext applicationContext) {
63          this.applicationContext = applicationContext;
64      }
65  
66      @Override
67      public void setBlossomDispatcher(BlossomDispatcher dispatcher) {
68          this.dispatcher = dispatcher;
69      }
70  
71      public Class<?> getType() {
72          return type;
73      }
74  
75      public void setType(Class<?> type) {
76          this.type = type;
77      }
78  
79      public void detectBeans() {
80          String[] beanNames = applicationContext.getBeanNamesForType(type, true, true);
81          for (String beanName : beanNames) {
82              Class<?> type = applicationContext.getType(beanName);
83              if (type != null && include(type, beanName)) {
84                  Object bean = applicationContext.getBean(beanName);
85                  onBeanDetection(bean, beanName);
86              }
87          }
88      }
89  
90      @Override
91      public void onApplicationEvent(ApplicationEvent event) {
92          if (event instanceof BlossomDispatcherInitializedEvent && event.getSource() == dispatcher) {
93              detectBeans();
94          }
95      }
96  
97      protected boolean include(Class<?> beanType, String beanName) {
98          return true;
99      }
100 
101     protected abstract void onBeanDetection(Object bean, String beanName);
102 }