1   /**
2    * Copyright (c) 2000-2007 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.util.xml.descriptor;
24  
25  import com.liferay.util.xml.ElementIdentifier;
26  
27  import org.dom4j.Document;
28  
29  /**
30   * <a href="WebXML24Descriptor.java.html"><b><i>View Source</i></b></a>
31   *
32   * @author Jorge Ferrer
33   * @author Brian Wing Shun Chan
34   *
35   */
36  public class WebXML24Descriptor extends SimpleXMLDescriptor {
37  
38      public boolean canHandleType(String doctype, Document root) {
39          if (doctype.indexOf("web-app") != -1) {
40              return true;
41          }
42          else {
43              return false;
44          }
45      }
46  
47      public String[] getRootChildrenOrder() {
48          return _ROOT_ORDERED_CHILDREN;
49      }
50  
51      public ElementIdentifier[] getElementsIdentifiedByAttribute() {
52          return _ELEMENTS_IDENTIFIED_BY_ATTR;
53      }
54  
55      public ElementIdentifier[] getElementsIdentifiedByChild() {
56          return _ELEMENTS_IDENTIFIED_BY_CHILD;
57      }
58  
59      public String[] getUniqueElements() {
60          return _UNIQUE_ELEMENTS;
61      }
62  
63      public String[] getJoinableElements() {
64          return _JOINABLE_ELEMENTS;
65      }
66  
67      private static final String[] _ROOT_ORDERED_CHILDREN = {
68          "icon", "display-name", "description", "distributable", "context-param",
69          "filter", "filter-mapping", "listener", "servlet", "servlet-mapping",
70          "session-config", "mime-mapping", "welcome-file-list", "error-page",
71          "jsp-config", "resource-env-ref", "resource-ref", "security-constraint",
72          "login-config", "security-role", "env-entry", "ejb-ref", "ejb-local-ref"
73      };
74  
75      private static final ElementIdentifier[] _ELEMENTS_IDENTIFIED_BY_ATTR = {
76      };
77  
78      private static final ElementIdentifier[] _ELEMENTS_IDENTIFIED_BY_CHILD = {
79          new ElementIdentifier("context-param", "param-name"),
80          new ElementIdentifier("filter", "filter-name"),
81          //new ElementIdentifier("filter-mapping", "filter-name"),
82          new ElementIdentifier("servlet", "servlet-name"),
83          //new ElementIdentifier("servlet-mapping", "servlet-name"),
84          new ElementIdentifier("init-param", "param-name"),
85          new ElementIdentifier("taglib", "taglib-uri"),
86          new ElementIdentifier("resource-env-ref", "res-env-ref-name"),
87          new ElementIdentifier("resource-ref", "res-ref-name"),
88          new ElementIdentifier("ejb-local-ref", "ejb-ref-name")
89      };
90  
91      private static final String[] _UNIQUE_ELEMENTS = {
92          "icon", "display-name", "description", "distributable",
93          "session-config", "welcome-file-list", "jsp-config", "login-config"
94      };
95  
96      private static final String[] _JOINABLE_ELEMENTS = {
97          "welcome-file-list", "jsp-config"
98      };
99  
100 }