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.dialog;
35  
36  import javax.jcr.RepositoryException;
37  
38  import org.slf4j.Logger;
39  import org.slf4j.LoggerFactory;
40  import org.springframework.beans.factory.InitializingBean;
41  
42  import info.magnolia.module.blossom.annotation.DialogFactory;
43  import info.magnolia.module.blossom.support.AbstractBeanDetector;
44  import info.magnolia.objectfactory.Components;
45  
46  /**
47   * Detects class level dialog factories by scanning beans in the local application context and registers them with the
48   * dialog registry.
49   *
50   * @see info.magnolia.module.blossom.annotation.DialogFactory
51   * @see info.magnolia.module.blossom.dialog.BlossomDialogRegistry
52   * @since 1.1.1
53   */
54  public class DialogExporter extends AbstractBeanDetector implements InitializingBean {
55  
56      private final Logger logger = LoggerFactory.getLogger(getClass());
57  
58      private DialogDescriptionBuilder dialogDescriptionBuilder;
59  
60      public void setDialogDescriptionBuilder(DialogDescriptionBuilder dialogDescriptionBuilder) {
61          this.dialogDescriptionBuilder = dialogDescriptionBuilder;
62      }
63  
64      @Override
65      protected boolean include(Class<?> beanType, String beanName) {
66          return beanType.isAnnotationPresent(DialogFactory.class);
67      }
68  
69      @Override
70      protected void onBeanDetection(Object bean, String beanName) {
71          try {
72  
73              BlossomDialogDescription description = dialogDescriptionBuilder.buildDescription(bean);
74  
75              Components.getComponent(BlossomDialogRegistry.class).addDialogDescription(description);
76  
77              if (logger.isDebugEnabled()) {
78                  logger.debug("Registered dialog [" + description.getId() + "]");
79              }
80  
81          } catch (RepositoryException e) {
82              logger.error("Unable to register dialog factory [" + bean.getClass().getName() + "] with bean name [" + beanName + "]", e);
83          }
84      }
85  
86      @Override
87      public void afterPropertiesSet() throws Exception {
88          if (dialogDescriptionBuilder == null) {
89              dialogDescriptionBuilder = new DialogDescriptionBuilder();
90          }
91      }
92  }