001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.util.xml.descriptor;
016    
017    import com.liferay.util.xml.ElementIdentifier;
018    
019    import org.dom4j.Document;
020    
021    /**
022     * @author Jorge Ferrer
023     */
024    public class WebXML23Descriptor extends SimpleXMLDescriptor {
025    
026            @Override
027            public boolean canHandleType(String doctype, Document root) {
028                    if (doctype.indexOf("web-app") != -1) {
029                            return true;
030                    }
031                    else {
032                            return false;
033                    }
034            }
035    
036            @Override
037            public ElementIdentifier[] getElementsIdentifiedByAttribute() {
038                    return _ELEMENTS_IDENTIFIED_BY_ATTR;
039            }
040    
041            @Override
042            public ElementIdentifier[] getElementsIdentifiedByChild() {
043                    return _ELEMENTS_IDENTIFIED_BY_CHILD;
044            }
045    
046            @Override
047            public String[] getJoinableElements() {
048                    return _JOINABLE_ELEMENTS;
049            }
050    
051            @Override
052            public String[] getRootChildrenOrder() {
053                    return _ROOT_ORDERED_CHILDREN;
054            }
055    
056            @Override
057            public String[] getUniqueElements() {
058                    return _UNIQUE_ELEMENTS;
059            }
060    
061            private static final ElementIdentifier[] _ELEMENTS_IDENTIFIED_BY_ATTR = {
062            };
063    
064            private static final ElementIdentifier[] _ELEMENTS_IDENTIFIED_BY_CHILD = {
065                    new ElementIdentifier("context-param", "param-name"),
066                    new ElementIdentifier("filter", "filter-name"),
067                    //new ElementIdentifier("filter-mapping", "filter-name"),
068                    new ElementIdentifier("servlet", "servlet-name"),
069                    //new ElementIdentifier("servlet-mapping", "servlet-name"),
070                    new ElementIdentifier("init-param", "param-name"),
071                    new ElementIdentifier("taglib", "taglib-uri"),
072                    new ElementIdentifier("resource-env-ref", "res-env-ref-name"),
073                    new ElementIdentifier("resource-ref", "res-ref-name"),
074                    new ElementIdentifier("ejb-local-ref", "ejb-ref-name")
075            };
076    
077            private static final String[] _JOINABLE_ELEMENTS = {
078                    "welcome-file-list"
079            };
080    
081            private static final String[] _ROOT_ORDERED_CHILDREN = {
082                    "icon", "display-name", "description", "distributable", "context-param",
083                    "filter", "filter-mapping", "listener", "servlet", "servlet-mapping",
084                    "session-config", "mime-mapping", "welcome-file-list", "error-page",
085                    "taglib", "resource-env-ref", "resource-ref", "security-constraint",
086                    "login-config", "security-role", "env-entry", "ejb-ref", "ejb-local-ref"
087            };
088    
089            private static final String[] _UNIQUE_ELEMENTS = {
090                    "icon", "display-name", "description", "distributable",
091                    "session-config", "welcome-file-list", "login-config"
092            };
093    
094    }