WebDescriptor xref

View Javadoc

1   // ========================================================================
2   // Copyright (c) 2006-2010 Mort Bay Consulting Pty. Ltd.
3   // ------------------------------------------------------------------------
4   // All rights reserved. This program and the accompanying materials
5   // are made available under the terms of the Eclipse Public License v1.0
6   // and Apache License v2.0 which accompanies this distribution.
7   // The Eclipse Public License is available at 
8   // http://www.eclipse.org/legal/epl-v10.html
9   // The Apache License v2.0 is available at
10  // http://www.opensource.org/licenses/apache2.0.php
11  // You may elect to redistribute this code under either of these licenses. 
12  // ========================================================================
13  
14  package org.eclipse.jetty.webapp;
15  
16  import java.net.URL;
17  import java.util.ArrayList;
18  import java.util.Iterator;
19  import java.util.List;
20  
21  import javax.servlet.Servlet;
22  
23  import org.eclipse.jetty.util.Loader;
24  import org.eclipse.jetty.util.log.Log;
25  import org.eclipse.jetty.util.resource.Resource;
26  import org.eclipse.jetty.xml.XmlParser;
27  
28  
29  
30  /**
31   * Descriptor
32   *
33   * A web descriptor (web.xml/web-defaults.xml/web-overrides.xml).
34   */
35  public class WebDescriptor extends Descriptor
36  { 
37      protected static XmlParser _parserSingleton;
38      public enum MetaDataComplete {NotSet, True, False};
39    
40      protected MetaDataComplete _metaDataComplete;
41      protected int _majorVersion = 3; //default to container version
42      protected int _minorVersion = 0;
43      protected ArrayList<String> _classNames = new ArrayList<String>();
44      protected boolean _distributable;
45  
46      protected boolean _isOrdered = false;
47      protected List<String> _ordering = new ArrayList<String>();
48      
49      @Override
50      public void ensureParser()
51      throws ClassNotFoundException
52      {
53          if (_parserSingleton == null)
54          {
55              _parserSingleton = newParser();
56          }
57          _parser = _parserSingleton;
58      }
59  
60      
61      public XmlParser newParser()
62      throws ClassNotFoundException
63      {
64          XmlParser xmlParser=new XmlParser();
65          //set up cache of DTDs and schemas locally        
66          URL dtd22=Loader.getResource(Servlet.class,"javax/servlet/resources/web-app_2_2.dtd",true);
67          URL dtd23=Loader.getResource(Servlet.class,"javax/servlet/resources/web-app_2_3.dtd",true);
68          URL j2ee14xsd=Loader.getResource(Servlet.class,"javax/servlet/resources/j2ee_1_4.xsd",true);
69          URL webapp24xsd=Loader.getResource(Servlet.class,"javax/servlet/resources/web-app_2_4.xsd",true);
70          URL webapp25xsd=Loader.getResource(Servlet.class,"javax/servlet/resources/web-app_2_5.xsd",true);
71          URL webapp30xsd=Loader.getResource(Servlet.class,"javax/servlet/resources/web-app_3_0.xsd",true);
72          URL webcommon30xsd=Loader.getResource(Servlet.class,"javax/servlet/resources/web-common_3_0.xsd",true);
73          URL webfragment30xsd=Loader.getResource(Servlet.class,"javax/servlet/resources/web-fragment_3_0.xsd",true);
74          URL schemadtd=Loader.getResource(Servlet.class,"javax/servlet/resources/XMLSchema.dtd",true);
75          URL xmlxsd=Loader.getResource(Servlet.class,"javax/servlet/resources/xml.xsd",true);
76          URL webservice11xsd=Loader.getResource(Servlet.class,"javax/servlet/resources/j2ee_web_services_client_1_1.xsd",true);
77          URL webservice12xsd=Loader.getResource(Servlet.class,"javax/servlet/resources/javaee_web_services_client_1_2.xsd",true);
78          URL datatypesdtd=Loader.getResource(Servlet.class,"javax/servlet/resources/datatypes.dtd",true);
79  
80          URL jsp20xsd = null;
81          URL jsp21xsd = null;
82  
83          try
84          {
85              Class<?> jsp_page = Loader.loadClass(WebXmlConfiguration.class, "javax.servlet.jsp.JspPage");
86              jsp20xsd = jsp_page.getResource("/javax/servlet/resources/jsp_2_0.xsd");
87              jsp21xsd = jsp_page.getResource("/javax/servlet/resources/jsp_2_1.xsd");
88          }
89          catch (Exception e)
90          {
91              Log.ignore(e);
92          }
93          finally
94          {
95              if (jsp20xsd == null) jsp20xsd = Loader.getResource(Servlet.class, "javax/servlet/resources/jsp_2_0.xsd", true);
96              if (jsp21xsd == null) jsp21xsd = Loader.getResource(Servlet.class, "javax/servlet/resources/jsp_2_1.xsd", true);
97          }
98          
99          redirect(xmlParser,"web-app_2_2.dtd",dtd22);
100         redirect(xmlParser,"-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN",dtd22);
101         redirect(xmlParser,"web.dtd",dtd23);
102         redirect(xmlParser,"web-app_2_3.dtd",dtd23);
103         redirect(xmlParser,"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN",dtd23);
104         redirect(xmlParser,"XMLSchema.dtd",schemadtd);
105         redirect(xmlParser,"http://www.w3.org/2001/XMLSchema.dtd",schemadtd);
106         redirect(xmlParser,"-//W3C//DTD XMLSCHEMA 200102//EN",schemadtd);
107         redirect(xmlParser,"jsp_2_0.xsd",jsp20xsd);
108         redirect(xmlParser,"http://java.sun.com/xml/ns/j2ee/jsp_2_0.xsd",jsp20xsd);
109         redirect(xmlParser,"http://java.sun.com/xml/ns/javaee/jsp_2_1.xsd",jsp21xsd);
110         redirect(xmlParser,"j2ee_1_4.xsd",j2ee14xsd);
111         redirect(xmlParser,"http://java.sun.com/xml/ns/j2ee/j2ee_1_4.xsd",j2ee14xsd);
112         redirect(xmlParser,"web-app_2_4.xsd",webapp24xsd);
113         redirect(xmlParser,"http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd",webapp24xsd);
114         redirect(xmlParser,"web-app_2_5.xsd",webapp25xsd);
115         redirect(xmlParser,"http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd",webapp25xsd);
116         redirect(xmlParser,"web-app_3_0.xsd",webapp30xsd);
117         redirect(xmlParser,"http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd",webapp30xsd);
118         redirect(xmlParser,"web-common_3_0.xsd",webcommon30xsd);
119         redirect(xmlParser,"http://java.sun.com/xml/ns/javaee/web-common_3_0.xsd",webcommon30xsd);
120         redirect(xmlParser,"web-fragment_3_0.xsd",webfragment30xsd);
121         redirect(xmlParser,"http://java.sun.com/xml/ns/javaee/web-fragment_3_0.xsd",webfragment30xsd);
122         redirect(xmlParser,"xml.xsd",xmlxsd);
123         redirect(xmlParser,"http://www.w3.org/2001/xml.xsd",xmlxsd);
124         redirect(xmlParser,"datatypes.dtd",datatypesdtd);
125         redirect(xmlParser,"http://www.w3.org/2001/datatypes.dtd",datatypesdtd);
126         redirect(xmlParser,"j2ee_web_services_client_1_1.xsd",webservice11xsd);
127         redirect(xmlParser,"http://www.ibm.com/webservices/xsd/j2ee_web_services_client_1_1.xsd",webservice11xsd);
128         redirect(xmlParser,"javaee_web_services_client_1_2.xsd",webservice12xsd);
129         redirect(xmlParser,"http://www.ibm.com/webservices/xsd/javaee_web_services_client_1_2.xsd",webservice12xsd);
130         return xmlParser;
131     }
132     
133     
134     public WebDescriptor (Resource xml)
135     {
136         super(xml);
137     }
138     
139     public void parse ()
140     throws Exception
141     {
142         super.parse();
143         processVersion();
144         processOrdering();
145     }
146     
147     public MetaDataComplete getMetaDataComplete()
148     {
149         return _metaDataComplete;
150     }
151     
152  
153     
154     public int getMajorVersion ()
155     {
156         return _majorVersion;
157     }
158     
159     public int getMinorVersion()
160     {
161         return _minorVersion;
162     }
163   
164     
165     public void processVersion ()
166     {
167         String version = _root.getAttribute("version", "DTD");
168         if ("DTD".equals(version))
169         {
170             _majorVersion = 2;
171             _minorVersion = 3;
172             String dtd = _parser.getDTD();
173             if (dtd != null && dtd.indexOf("web-app_2_2") >= 0)
174             {
175                 _majorVersion = 2;
176                 _minorVersion = 2;
177             }
178         }
179         else 
180         {
181            int dot = version.indexOf(".");
182            if (dot > 0)
183            {
184                _majorVersion = Integer.parseInt(version.substring(0,dot));
185                _minorVersion = Integer.parseInt(version.substring(dot+1));
186            }
187         }
188      
189         if (_majorVersion < 2 && _minorVersion < 5)
190             _metaDataComplete = MetaDataComplete.True; // does not apply before 2.5
191         else
192         {
193             String s = (String)_root.getAttribute("metadata-complete");
194             if (s == null)
195                 _metaDataComplete = MetaDataComplete.NotSet;
196             else
197                 _metaDataComplete = Boolean.valueOf(s).booleanValue()?MetaDataComplete.True:MetaDataComplete.False;
198         }
199             
200         Log.debug(_xml.toString()+": Calculated metadatacomplete = " + _metaDataComplete + " with version=" + version);     
201     }
202     
203     public void processOrdering ()
204     {
205         //Process the web.xml's optional <absolute-ordering> element              
206         XmlParser.Node ordering = _root.get("absolute-ordering");
207         if (ordering == null)
208            return;
209         
210         _isOrdered = true;
211         //If an absolute-ordering was already set, then ignore it in favour of this new one
212        // _processor.setOrdering(new AbsoluteOrdering());
213    
214         Iterator iter = ordering.iterator();
215         XmlParser.Node node = null;
216         while (iter.hasNext())
217         {
218             Object o = iter.next();
219             if (!(o instanceof XmlParser.Node)) continue;
220             node = (XmlParser.Node) o;
221 
222             if (node.getTag().equalsIgnoreCase("others"))
223                 //((AbsoluteOrdering)_processor.getOrdering()).addOthers();
224                 _ordering.add("others");
225             else if (node.getTag().equalsIgnoreCase("name"))
226                 //((AbsoluteOrdering)_processor.getOrdering()).add(node.toString(false,true));
227                 _ordering.add(node.toString(false,true));
228         }
229     }
230   
231     public void addClassName (String className)
232     {
233         if (!_classNames.contains(className))
234             _classNames.add(className);
235     }
236     
237     public ArrayList<String> getClassNames ()
238     {
239         return _classNames;
240     }
241     
242     public void setDistributable (boolean distributable)
243     {
244         _distributable = distributable;
245     }
246     
247     public boolean isDistributable()
248     {
249         return _distributable;
250     }
251     
252     public void setValidating (boolean validating)
253     {
254        _validating = validating;
255     }
256     
257     
258     public boolean isOrdered()
259     {
260         return _isOrdered;
261     }
262     
263     public List<String> getOrdering()
264     {
265         return _ordering;
266     }
267 
268   
269 }