View Javadoc

1   /**
2    * This file Copyright (c) 2013 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.ui.form.fieldtype.registry;
35  
36  import info.magnolia.cms.util.ModuleConfigurationObservingManager;
37  import info.magnolia.jcr.predicate.NodeTypePredicate;
38  import info.magnolia.jcr.util.NodeTypes;
39  import info.magnolia.jcr.util.NodeUtil;
40  import info.magnolia.jcr.util.NodeVisitor;
41  import info.magnolia.module.ModuleRegistry;
42  
43  import java.util.ArrayList;
44  import java.util.HashSet;
45  import java.util.List;
46  import java.util.Set;
47  
48  import javax.inject.Inject;
49  import javax.jcr.Node;
50  import javax.jcr.RepositoryException;
51  
52  import org.slf4j.Logger;
53  import org.slf4j.LoggerFactory;
54  
55  /**
56   * ConfiguredFieldTypeDefinitionManager.
57   */
58  public class ConfiguredFieldTypeDefinitionManager extends ModuleConfigurationObservingManager {
59  
60      public static final String FIELD_CONFIG_NODE_NAME = "fieldTypes";
61  
62      private final Logger log = LoggerFactory.getLogger(getClass());
63  
64      private Set<String> registeredIds = new HashSet<String>();
65      private final FieldTypeDefinitionRegistry fieldTypeDefinitionRegistry;
66  
67      @Inject
68      public ConfiguredFieldTypeDefinitionManager(ModuleRegistry moduleRegistry, FieldTypeDefinitionRegistry fieldTypeDefinitionRegistry) {
69          super(FIELD_CONFIG_NODE_NAME, moduleRegistry);
70          this.fieldTypeDefinitionRegistry = fieldTypeDefinitionRegistry;
71      }
72  
73      @Override
74      protected void reload(List<Node> nodes) throws RepositoryException {
75  
76          final List<FieldTypeDefinitionProvider> providers = new ArrayList<FieldTypeDefinitionProvider>();
77  
78          for (Node node : nodes) {
79  
80              NodeUtil.visit(node, new NodeVisitor() {
81  
82                  @Override
83                  public void visit(Node current) throws RepositoryException {
84                      for (Node fieldTypeNode : NodeUtil.getNodes(current, NodeTypes.ContentNode.NAME)) {
85                          if (isFieldType(fieldTypeNode)) {
86                              // Handle as fieldType only if it has sub nodes indicating that it is actually representing a fieldType.
87                              // This will filter the fields in fieldTypes used by the extends mechanism.
88                              FieldTypeDefinitionProvider provider = createProvider(fieldTypeNode);
89                              if (provider != null) {
90                                  providers.add(provider);
91                              }
92                          } else {
93                              log.warn("node " + fieldTypeNode.getName() + " will not be handled as Field.");
94                          }
95                      }
96                  }
97              }, new NodeTypePredicate(NodeTypes.Content.NAME));
98          }
99  
100         this.registeredIds = fieldTypeDefinitionRegistry.unregisterAndRegister(registeredIds, providers);
101     }
102 
103     /**
104      * Check if this node can be handle as a ConfiguredFieldDefinition.
105      */
106     private boolean isFieldType(Node fieldTypeNode) throws RepositoryException {
107         return true;
108     }
109 
110     protected FieldTypeDefinitionProvider createProvider(Node fieldTypeNode) throws RepositoryException {
111 
112         final String id = fieldTypeNode.getName();
113 
114         try {
115             return new ConfiguredFieldTypeDefinitionProvider(id, fieldTypeNode);
116         } catch (IllegalArgumentException e) {
117             log.error("Unable to create provider for fieldType [" + id + "]: " + e);
118         } catch (Exception e) {
119             log.error("Unable to create provider for fieldType [" + id + "]", e);
120         }
121         return null;
122     }
123 
124 }