View Javadoc
1   /**
2    * This file Copyright (c) 2003-2014 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.cms.gui.dialog;
35  
36  import info.magnolia.cms.beans.config.ObservedManager;
37  import info.magnolia.cms.core.Content;
38  import info.magnolia.cms.core.ItemType;
39  import info.magnolia.objectfactory.Classes;
40  import info.magnolia.objectfactory.Components;
41  
42  import java.util.Iterator;
43  
44  import javax.inject.Singleton;
45  
46  import org.apache.commons.lang.StringUtils;
47  
48  
49  /**
50   * @author Fabrizio Giustina
51   * @version $Revision$ ($Author$)
52   */
53  @Singleton
54  public final class ControlsManager extends ObservedManager {
55  
56      /**
57       * Node data name for control class.
58       */
59      private static final String DATA_CONTROL_CLASS = "class"; //$NON-NLS-1$
60  
61      /**
62       * Node data name for control name.
63       */
64      private static final String DATA_CONTROL_NAME = "name"; //$NON-NLS-1$
65  
66      /**
67       * Registers dialog controls.
68       */
69      @Override
70      protected void onRegister(Content configNode) {
71          log.info("Loading dialog controls configuration from {}", configNode.getHandle()); //$NON-NLS-1$
72  
73          Iterator iterator = configNode.getChildren(ItemType.CONTENTNODE).iterator();
74  
75          while (iterator.hasNext()) {
76              Content controlNode = (Content) iterator.next();
77  
78              log.debug("Initializing control [{}]", controlNode); //$NON-NLS-1$
79  
80              String classNodeData = controlNode.getNodeData(DATA_CONTROL_CLASS).getString();
81              String nameNodeData = controlNode.getNodeData(DATA_CONTROL_NAME).getString();
82  
83              if (StringUtils.isEmpty(nameNodeData)) {
84                  nameNodeData = controlNode.getName();
85              }
86  
87              if (StringUtils.isEmpty(classNodeData) || StringUtils.isEmpty(nameNodeData)) {
88                  log.warn("Can't add custom control with name [{}] and class [{}] specified in node [{}]", new Object[]{nameNodeData, classNodeData, controlNode.getName()});
89                  continue;
90              }
91              Class controlClass = null;
92  
93              try {
94                  controlClass = Classes.getClassFactory().forName(classNodeData);
95              }
96              catch (ClassNotFoundException e) {
97                  log.error("Failed to load dialog control with class [" + classNodeData + "]", e); //$NON-NLS-1$
98                  continue;
99              }
100 
101             if (!DialogControl.class.isAssignableFrom(controlClass)) {
102                 log.error("Invalid class specified for control [{}]: does not implement DialogControl", nameNodeData);
103                 continue;
104             }
105 
106             DialogFactory.registerDialog(nameNodeData, controlClass);
107 
108         }
109     }
110 
111     /**
112      * @return Returns the instance.
113      */
114     public static ControlsManager getInstance() {
115         return Components.getSingleton(ControlsManager.class);
116     }
117 
118     @Override
119     protected void onClear() {
120     }
121 
122 }