Made entity resolver visible
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / common / XML.java
1 /* 
2  * The Shibboleth License, Version 1. 
3  * Copyright (c) 2002 
4  * University Corporation for Advanced Internet Development, Inc. 
5  * All rights reserved
6  * 
7  * 
8  * Redistribution and use in source and binary forms, with or without 
9  * modification, are permitted provided that the following conditions are met:
10  * 
11  * Redistributions of source code must retain the above copyright notice, this 
12  * list of conditions and the following disclaimer.
13  * 
14  * Redistributions in binary form must reproduce the above copyright notice, 
15  * this list of conditions and the following disclaimer in the documentation 
16  * and/or other materials provided with the distribution, if any, must include 
17  * the following acknowledgment: "This product includes software developed by 
18  * the University Corporation for Advanced Internet Development 
19  * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement 
20  * may appear in the software itself, if and wherever such third-party 
21  * acknowledgments normally appear.
22  * 
23  * Neither the name of Shibboleth nor the names of its contributors, nor 
24  * Internet2, nor the University Corporation for Advanced Internet Development, 
25  * Inc., nor UCAID may be used to endorse or promote products derived from this 
26  * software without specific prior written permission. For written permission, 
27  * please contact shibboleth@shibboleth.org
28  * 
29  * Products derived from this software may not be called Shibboleth, Internet2, 
30  * UCAID, or the University Corporation for Advanced Internet Development, nor 
31  * may Shibboleth appear in their name, without prior written permission of the 
32  * University Corporation for Advanced Internet Development.
33  * 
34  * 
35  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
36  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
37  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
38  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK 
39  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE. 
40  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY 
41  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT, 
42  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
43  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
44  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
47  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48  */
49
50 package edu.internet2.middleware.shibboleth.common;
51
52 import java.io.ByteArrayInputStream;
53 import java.io.InputStream;
54 import org.xml.sax.EntityResolver;
55 import org.xml.sax.InputSource;
56 import org.xml.sax.SAXException;
57
58 /**
59  *  Utility class for XML constants and schema handling
60  *
61  * @author     Scott Cantor
62  * @created    January 2, 2002
63  */
64 public class XML
65 {
66     /**  Shibboleth XML namespace */
67     public final static String SHIB_NS = "urn:mace:shibboleth:1.0";
68
69     /**  Shibboleth XML schema identifier */
70     public final static String SHIB_SCHEMA_ID = "shibboleth.xsd";
71
72     /**  Shibboleth trust metadata XML namespace */
73     public final static String TRUST_NS = "urn:mace:shibboleth:trust:1.0";
74     
75     /**  Shibboleth trust metadata XML schema identifier */
76     public final static String TRUST_SCHEMA_ID = "shibboleth-trust-1.0.xsd";
77     
78     private static byte[] Shib_schema;
79     private static byte[] Trust_schema;
80
81     /**
82      *  Custom schema resolver class
83      *
84      * @author     Scott Cantor
85      * @created    May 18, 2002
86      */
87     public static class SchemaResolver implements EntityResolver {
88         /**
89          *  A customized entity resolver for the Shibboleth extension schema
90          *
91          * @param  publicId                 The public identifier of the entity
92          * @param  systemId                 The system identifier of the entity
93          * @return                          A source of bytes for the entity or null
94          * @exception  SAXException         Raised if an XML parsing problem occurs
95          * @exception  java.io.IOException  Raised if an I/O problem is detected
96          */
97         public InputSource resolveEntity(String publicId, String systemId) throws SAXException, java.io.IOException {
98             InputSource src = null;
99             if (systemId.endsWith(SHIB_SCHEMA_ID) && Shib_schema != null)
100                 src = new InputSource(new ByteArrayInputStream(Shib_schema));
101             else if (systemId.endsWith(TRUST_SCHEMA_ID) && Trust_schema != null)
102                 src = new InputSource(new ByteArrayInputStream(Trust_schema));
103             return src;
104         }
105     }
106
107     static {
108         try {
109             StringBuffer buf = new StringBuffer(4096);
110             InputStream xmlin = XML.class.getResourceAsStream("/schemas/" + SHIB_SCHEMA_ID);
111             if (xmlin == null)
112                 throw new RuntimeException("XML static initializer unable to locate Shibboleth schema");
113             else {
114                 int b;
115                 while ((b = xmlin.read()) != -1)
116                     buf.append((char)b);
117                 Shib_schema = buf.toString().getBytes();
118                 xmlin.close();
119             }
120
121             xmlin = XML.class.getResourceAsStream("/schemas/" + TRUST_SCHEMA_ID);
122             if (xmlin == null)
123                 throw new RuntimeException("XML static initializer unable to locate Shibboleth trust schema");
124             else {
125                 int b;
126                 while ((b = xmlin.read()) != -1)
127                     buf.append((char)b);
128                 Trust_schema = buf.toString().getBytes();
129                 xmlin.close();
130             }
131         }
132         catch (java.io.IOException e) {
133             throw new RuntimeException("XML static initializer caught an I/O error");
134         }
135     }
136 }