View Javadoc

1   /*
2    * $Header: /home/projects/jaxen/scm/jaxen/src/java/main/org/jaxen/saxpath/helpers/XPathReaderFactory.java,v 1.3 2004/06/15 01:36:01 proyal Exp $
3    * $Revision: 1.3 $
4    * $Date: 2004/06/15 01:36:01 $
5    *
6    * ====================================================================
7    *
8    * Copyright (C) 2000-2002 bob mcwhirter & James Strachan.
9    * All rights reserved.
10   *
11   * Redistribution and use in source and binary forms, with or without
12   * modification, are permitted provided that the following conditions
13   * are met:
14   *
15   * 1. Redistributions of source code must retain the above copyright
16   *    notice, this list of conditions, and the following disclaimer.
17   *
18   * 2. Redistributions in binary form must reproduce the above copyright
19   *    notice, this list of conditions, and the disclaimer that follows
20   *    these conditions in the documentation and/or other materials
21   *    provided with the distribution.
22   *
23   * 3. The name "Jaxen" must not be used to endorse or promote products
24   *    derived from this software without prior written permission.  For
25   *    written permission, please contact license@jaxen.org.
26   *
27   * 4. Products derived from this software may not be called "Jaxen", nor
28   *    may "Jaxen" appear in their name, without prior written permission
29   *    from the Jaxen Project Management (pm@jaxen.org).
30   *
31   * In addition, we request (but do not require) that you include in the
32   * end-user documentation provided with the redistribution and/or in the
33   * software itself an acknowledgement equivalent to the following:
34   *     "This product includes software developed by the
35   *      Jaxen Project (http://www.jaxen.org/)."
36   * Alternatively, the acknowledgment may be graphical using the logos
37   * available at http://www.jaxen.org/
38   *
39   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
40   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
41   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
42   * DISCLAIMED.  IN NO EVENT SHALL THE Jaxen AUTHORS OR THE PROJECT
43   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
45   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
46   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
47   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
48   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
49   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50   * SUCH DAMAGE.
51   *
52   * ====================================================================
53   * This software consists of voluntary contributions made by many
54   * individuals on behalf of the Jaxen Project and was originally
55   * created by bob mcwhirter <bob@werken.com> and
56   * James Strachan <jstrachan@apache.org>.  For more information on the
57   * Jaxen Project, please see <http://www.jaxen.org/>.
58   *
59   * $Id: XPathReaderFactory.java,v 1.3 2004/06/15 01:36:01 proyal Exp $
60   */
61  
62  
63  
64  
65  package org.jaxen.saxpath.helpers;
66  
67  import org.jaxen.saxpath.XPathReader;
68  
69  /*** Create an {@link org.jaxen.saxpath.XPathReader} from
70   *  either a system property, or a named class.
71   *
72   *  <p>
73   *  Similar to the SAX API, the <code>XPathReaderFactory</code>
74   *  can create an <code>XPathReader</code> from a name of a
75   *  class passed in directly, or by inspecting the system
76   *  property <code>org.saxpath.driver</code>.
77   *
78   *  @author bob mcwhirter (bob@werken.com)
79   */
80  public class XPathReaderFactory
81  {
82      /*** The <code>org.saxpath.driver</code> property name. */
83      public static final String DRIVER_PROPERTY = "org.saxpath.driver";
84  
85      /*** The default driver to use if none is configured. */
86      protected static final String DEFAULT_DRIVER = "org.jaxen.saxpath.base.XPathReader";
87  
88      /*** Should the default driver be used */
89      private static boolean USE_DEFAULT = true;
90      
91      
92      /*** Create an <code>XPathReader</code> using the value of
93       *  the <code>org.saxpath.driver</code> system property.
94       *
95       *  @return An instance of the <code>XPathReader</code> specified
96       *          by the <code>org.saxpath.driver</code> property.
97       *
98       *  @throws org.jaxen.saxpath.SAXPathException if the property is unset, or if
99       *          the class can not be instantiated for some reason.,
100      *          or if the class doesn't implement the <code>XPathReader</code>
101      *          interface.
102      */
103     public static XPathReader createReader() throws org.jaxen.saxpath.SAXPathException
104     {
105         String className = null;
106 
107         boolean securityException = false;
108 
109         try
110         {
111             className = System.getProperty( DRIVER_PROPERTY );
112         }
113         catch (SecurityException e)
114         {
115             securityException = true;
116         }
117 
118         if ( className == null
119              ||
120              className.length() == 0 )
121         {
122             if ( USE_DEFAULT )
123             {
124                 className = DEFAULT_DRIVER;
125             }
126             else
127             {
128                 if ( securityException )
129                 {
130                     throw new org.jaxen.saxpath.SAXPathException( "Reading of property " + DRIVER_PROPERTY + " disallowed." );
131                 }
132                 else
133                 {
134                     throw new org.jaxen.saxpath.SAXPathException( "Property " + DRIVER_PROPERTY + " not set" );
135                 }
136             }
137         }
138 
139         return createReader( className );
140     }
141     
142     /*** Create an <code>XPathReader</code> using the passed
143      *  in class name.
144      *
145      *  @param className The name of the class which implements
146      *         the <code>XPathReader</code> interface.
147      *
148      *  @throws org.jaxen.saxpath.SAXPathException if the class can not be
149      *          instantiated for some reason, or if the
150      *          class doesn't implement the <code>XPathReader</code>
151      *          interface.
152      */
153     public static XPathReader createReader(String className) throws org.jaxen.saxpath.SAXPathException
154     {
155         Class readerClass  = null;
156         XPathReader reader = null;
157 
158         try
159         {
160             // Use the full version of Class.forName(), so as to
161             // work better in sandboxed environments, such as
162             // Servlet contains, and Applets.
163 
164             readerClass = Class.forName( className,
165                                          true,
166                                          XPathReaderFactory.class.getClassLoader() );
167             
168             // Double-check that it's actually the right kind of class
169             // before attempting instantiation.
170             
171             if ( ! XPathReader.class.isAssignableFrom( readerClass ) )
172             {
173                 throw new org.jaxen.saxpath.SAXPathException( "Class [" + className + "] does not implement the org.jaxen.saxpath.XPathReader interface." );
174             }
175         }
176         catch (ClassNotFoundException e)
177         {
178             throw new org.jaxen.saxpath.SAXPathException( e.getMessage() );
179         }
180 
181         try
182         {
183             reader = (XPathReader) readerClass.newInstance();
184         }
185         catch (IllegalAccessException e)
186         {
187             throw new org.jaxen.saxpath.SAXPathException( e.getMessage() );
188         }
189         catch (InstantiationException e)
190         {
191             throw new org.jaxen.saxpath.SAXPathException( e.getMessage() );
192         }
193 
194         if ( reader == null )
195         {
196             throw new org.jaxen.saxpath.SAXPathException( "Unable to create XPathReader" );
197         }
198         
199         return reader;
200     }
201 }