View Javadoc

1   /**
2    * This file Copyright (c) 2003-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.delta;
35  
36  import info.magnolia.cms.core.Content;
37  import info.magnolia.cms.core.ItemType;
38  import info.magnolia.cms.core.Path;
39  import info.magnolia.cms.util.NodeDataUtil;
40  import info.magnolia.module.InstallContext;
41  import info.magnolia.module.model.ServletDefinition;
42  import info.magnolia.module.model.ServletParameterDefinition;
43  
44  import javax.jcr.RepositoryException;
45  
46  import org.apache.commons.lang.StringUtils;
47  
48  /**
49   * @author philipp
50   * @version $Id: RegisterServletTask.java 35042 2010-06-15 10:00:37Z ochytil $
51   */
52  public class RegisterServletTask extends AbstractTask {
53      private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(RegisterServletTask.class);
54  
55      private static final String DEFAULT_SERVLET_FILTER_PATH = "/server/filters/servlets";
56      private final ServletDefinition servletDefinition;
57  
58      public RegisterServletTask(ServletDefinition servletDefinition) {
59          super("Servlet " + servletDefinition.getName(), "Registers servlet" + servletDefinition.getName() + " (" + servletDefinition.getComment() + ")");
60          this.servletDefinition = servletDefinition;
61      }
62  
63      public void execute(InstallContext installContext) throws TaskExecutionException {
64          log.debug("Registering servlet " + servletDefinition.getName() + " in servlet filter.");
65  
66          final String servletFilterPath = DEFAULT_SERVLET_FILTER_PATH;
67  
68          try {
69              final Content servletNode = installContext.getConfigHierarchyManager().createContent(servletFilterPath, servletDefinition.getName(),
70                      ItemType.CONTENTNODE.getSystemName());
71              NodeDataUtil.getOrCreateAndSet(servletNode, "class", "info.magnolia.cms.filters.ServletDispatchingFilter");
72              NodeDataUtil.getOrCreateAndSet(servletNode, "enabled", true);
73              NodeDataUtil.getOrCreateAndSet(servletNode, "servletClass", servletDefinition.getClassName());
74              NodeDataUtil.getOrCreateAndSet(servletNode, "servletName", servletDefinition.getName());
75              NodeDataUtil.getOrCreateAndSet(servletNode, "comment", servletDefinition.getComment());
76  
77              final Content mappingsNode = servletNode.createContent("mappings", ItemType.CONTENTNODE);
78              for (String pattern : servletDefinition.getMappings()) {
79                  if (StringUtils.isBlank(pattern)) {
80                      installContext.warn("Empty mappings configuration is not supported and sevlet was not installed.");
81                      continue;
82                  }
83                  String mappingNodeName = Path.getUniqueLabel(mappingsNode, Path.getValidatedLabel(pattern));
84                  final Content mappingNode = mappingsNode.createContent(mappingNodeName, ItemType.CONTENTNODE);
85                  NodeDataUtil.getOrCreateAndSet(mappingNode, "pattern", pattern);
86              }
87  
88              final Content parametersNode = servletNode.createContent("parameters", ItemType.CONTENTNODE);
89              for (ServletParameterDefinition parameter : servletDefinition.getParams()) {
90                  NodeDataUtil.getOrCreateAndSet(parametersNode, parameter.getName(), parameter.getValue());
91              }
92          } catch (RepositoryException e) {
93              log.error("Cannot create servlet node in servlet filter.", e);
94          }
95      }
96  
97      public ServletDefinition getServletDefinition() {
98          return this.servletDefinition;
99      }
100 
101 }