1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17   * SOFTWARE.
18   */
19  
20  package com.liferay.util.xml.descriptor;
21  
22  import com.liferay.util.xml.ElementIdentifier;
23  
24  import org.dom4j.Document;
25  
26  /**
27   * <a href="WebXML23Descriptor.java.html"><b><i>View Source</i></b></a>
28   *
29   * @author Jorge Ferrer
30   *
31   */
32  public class WebXML23Descriptor extends SimpleXMLDescriptor {
33  
34      public boolean canHandleType(String doctype, Document root) {
35          if (doctype.indexOf("web-app") != -1) {
36              return true;
37          }
38          else {
39              return false;
40          }
41      }
42  
43      public String[] getRootChildrenOrder() {
44          return _ROOT_ORDERED_CHILDREN;
45      }
46  
47      public ElementIdentifier[] getElementsIdentifiedByAttribute() {
48          return _ELEMENTS_IDENTIFIED_BY_ATTR;
49      }
50  
51      public ElementIdentifier[] getElementsIdentifiedByChild() {
52          return _ELEMENTS_IDENTIFIED_BY_CHILD;
53      }
54  
55      public String[] getUniqueElements() {
56          return _UNIQUE_ELEMENTS;
57      }
58  
59      public String[] getJoinableElements() {
60          return _JOINABLE_ELEMENTS;
61      }
62  
63      private static final String[] _ROOT_ORDERED_CHILDREN = {
64          "icon", "display-name", "description", "distributable", "context-param",
65          "filter", "filter-mapping", "listener", "servlet", "servlet-mapping",
66          "session-config", "mime-mapping", "welcome-file-list", "error-page",
67          "taglib", "resource-env-ref", "resource-ref", "security-constraint",
68          "login-config", "security-role", "env-entry", "ejb-ref", "ejb-local-ref"
69      };
70  
71      private static final ElementIdentifier[] _ELEMENTS_IDENTIFIED_BY_ATTR = {
72      };
73  
74      private static final ElementIdentifier[] _ELEMENTS_IDENTIFIED_BY_CHILD = {
75          new ElementIdentifier("context-param", "param-name"),
76          new ElementIdentifier("filter", "filter-name"),
77          //new ElementIdentifier("filter-mapping", "filter-name"),
78          new ElementIdentifier("servlet", "servlet-name"),
79          //new ElementIdentifier("servlet-mapping", "servlet-name"),
80          new ElementIdentifier("init-param", "param-name"),
81          new ElementIdentifier("taglib", "taglib-uri"),
82          new ElementIdentifier("resource-env-ref", "res-env-ref-name"),
83          new ElementIdentifier("resource-ref", "res-ref-name"),
84          new ElementIdentifier("ejb-local-ref", "ejb-ref-name")
85      };
86  
87      private static final String[] _UNIQUE_ELEMENTS = {
88          "icon", "display-name", "description", "distributable",
89          "session-config", "welcome-file-list", "login-config"
90      };
91  
92      private static final String[] _JOINABLE_ELEMENTS = {
93          "welcome-file-list"
94      };
95  
96  }