Load site metadata schema without location hint.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / metadata / provider / XMLMetadataLoadWrapper.java
1 /*
2  * The Shibboleth License, Version 1. Copyright (c) 2002 University Corporation for Advanced Internet Development, Inc.
3  * All rights reserved Redistribution and use in source and binary forms, with or without modification, are permitted
4  * provided that the following conditions are met: Redistributions of source code must retain the above copyright
5  * notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the
6  * above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other
7  * materials provided with the distribution, if any, must include the following acknowledgment: "This product includes
8  * software developed by the University Corporation for Advanced Internet Development <http://www.ucaid.edu>Internet2
9  * Project. Alternately, this acknowledegement may appear in the software itself, if and wherever such third-party
10  * acknowledgments normally appear. Neither the name of Shibboleth nor the names of its contributors, nor Internet2,
11  * nor the University Corporation for Advanced Internet Development, Inc., nor UCAID may be used to endorse or promote
12  * products derived from this software without specific prior written permission. For written permission, please
13  * contact shibboleth@shibboleth.org Products derived from this software may not be called Shibboleth, Internet2,
14  * UCAID, or the University Corporation for Advanced Internet Development, nor may Shibboleth appear in their name,
15  * without prior written permission of the University Corporation for Advanced Internet Development. THIS SOFTWARE IS
16  * PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES,
17  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
18  * NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS
19  * WITH LICENSEE. IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY CORPORATION FOR ADVANCED
20  * INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
23  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24  * POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 package edu.internet2.middleware.shibboleth.metadata.provider;
28
29 import java.io.IOException;
30 import java.io.InputStream;
31 import java.util.StringTokenizer;
32
33 import org.apache.log4j.Logger;
34 import org.apache.xerces.parsers.DOMParser;
35 import org.opensaml.SAMLException;
36 import org.w3c.dom.Document;
37 import org.w3c.dom.Element;
38 import org.xml.sax.EntityResolver;
39 import org.xml.sax.ErrorHandler;
40 import org.xml.sax.InputSource;
41 import org.xml.sax.SAXException;
42 import org.xml.sax.SAXParseException;
43
44 import edu.internet2.middleware.shibboleth.common.ResourceWatchdog;
45 import edu.internet2.middleware.shibboleth.common.ResourceWatchdogExecutionException;
46 import edu.internet2.middleware.shibboleth.common.ShibResource;
47 import edu.internet2.middleware.shibboleth.common.XML;
48 import edu.internet2.middleware.shibboleth.common.ShibResource.ResourceNotAvailableException;
49 import edu.internet2.middleware.shibboleth.metadata.Metadata;
50 import edu.internet2.middleware.shibboleth.metadata.MetadataException;
51 import edu.internet2.middleware.shibboleth.metadata.Provider;
52
53 /**
54  * @author Walter Hoehn (wassa@columbia.edu)
55  */
56 public class XMLMetadataLoadWrapper extends ResourceWatchdog implements Metadata {
57
58         private static Logger   log     = Logger.getLogger(XMLMetadataLoadWrapper.class.getName());
59         private Metadata                currentMeta;
60         private DOMParser               parser;
61
62         public XMLMetadataLoadWrapper(Element configuration) throws MetadataException, ResourceNotAvailableException {
63                 this(configuration.getAttribute("uri"));
64         }
65
66         public XMLMetadataLoadWrapper(String sitesFileLocation) throws MetadataException, ResourceNotAvailableException {
67                 super(new ShibResource(sitesFileLocation, XMLMetadataLoadWrapper.class));
68                 try {
69                         org.opensaml.XML.parserPool.registerSchema(XML.SHIB_NS, XML.SHIB_SCHEMA_ID, new XML.SchemaResolver());
70                         Document doc = org.opensaml.XML.parserPool.parse(resource.getInputStream());
71                         currentMeta = new XMLMetadata(doc.getDocumentElement());
72                 } catch (SAMLException e) {
73                         log.error("Encountered a problem parsing federation metadata source: " + e);
74                         throw new MetadataException("Unable to parse federation metadata.");
75                 } catch (SAXException e) {
76                         log.error("Encountered a problem parsing federation metadata source: " + e);
77                         throw new MetadataException("Unable to parse federation metadata.");
78                 } catch (IOException e) {
79                         log.error("Encountered a problem reading federation metadata source: " + e);
80                         throw new MetadataException("Unable to read federation metadata.");
81                 }
82
83                 //Start checking for metadata updates
84                 start();
85
86         }
87
88         public Provider lookup(String providerId) {
89                 synchronized (currentMeta) {
90                         return currentMeta.lookup(providerId);
91                 }
92         }
93
94         protected void doOnChange() throws ResourceWatchdogExecutionException {
95                 //Log
96                 try {
97                         log.info("Detected a change in the federation metadata.  Reloading from (" + resource.getURL().toString()
98                                         + ").");
99                 } catch (IOException e) {
100                         log.error("Encountered an error retrieving updated federation metadata, continuing to use stale copy.");
101                         return;
102                 }
103
104                 //Load new, but keep the old in place
105                 try {
106                         parser.parse(new InputSource(resource.getInputStream()));
107                 } catch (SAXException e) {
108                         log.error("Encountered an error parsing updated federation metadata, continuing to use stale copy.");
109                         return;
110                 } catch (IOException e) {
111                         log.error("Encountered an error retrieving updated federation metadata, continuing to use stale copy.");
112                         return;
113                 }
114
115                 //If things went well, replace the live copy
116                 Metadata newMeta = null;
117                 try {
118                         newMeta = new XMLMetadata(parser.getDocument().getDocumentElement());
119                 } catch (MetadataException e1) {
120                         log.error("Encountered an error loading updated federation metadata, continuing to use stale copy.");
121                         return;
122                 }
123
124                 if (newMeta != null) {
125                         synchronized (currentMeta) {
126                                 currentMeta = newMeta;
127                         }
128                 }
129         }
130
131 }