b0f34180934bccc89ffcd4806248280cc78e2e24
[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 org.apache.log4j.Logger;
31 import org.opensaml.SAMLException;
32 import org.w3c.dom.Document;
33 import org.w3c.dom.Element;
34 import org.xml.sax.SAXException;
35 import edu.internet2.middleware.shibboleth.common.ResourceWatchdog;
36 import edu.internet2.middleware.shibboleth.common.ResourceWatchdogExecutionException;
37 import edu.internet2.middleware.shibboleth.common.ShibResource;
38 import edu.internet2.middleware.shibboleth.common.XML;
39 import edu.internet2.middleware.shibboleth.common.ShibResource.ResourceNotAvailableException;
40 import edu.internet2.middleware.shibboleth.metadata.Metadata;
41 import edu.internet2.middleware.shibboleth.metadata.MetadataException;
42 import edu.internet2.middleware.shibboleth.metadata.Provider;
43
44 /**
45  * @author Walter Hoehn (wassa@columbia.edu)
46  */
47 public class XMLMetadataLoadWrapper extends ResourceWatchdog implements Metadata {
48
49         private static Logger   log     = Logger.getLogger(XMLMetadataLoadWrapper.class.getName());
50         private Metadata                currentMeta;
51
52         public XMLMetadataLoadWrapper(Element configuration) throws MetadataException, ResourceNotAvailableException {
53                 this(configuration.getAttribute("uri"));
54         }
55
56         public XMLMetadataLoadWrapper(String sitesFileLocation) throws MetadataException, ResourceNotAvailableException {
57                 super(new ShibResource(sitesFileLocation, XMLMetadataLoadWrapper.class));
58                 try {
59                         org.opensaml.XML.parserPool.registerSchema(XML.SHIB_NS, XML.SHIB_SCHEMA_ID, new XML.SchemaResolver());
60                         Document doc = org.opensaml.XML.parserPool.parse(resource.getInputStream());
61                         currentMeta = new XMLMetadata(doc.getDocumentElement());
62                 } catch (SAMLException e) {
63                         log.error("Encountered a problem parsing federation metadata source: " + e);
64                         throw new MetadataException("Unable to parse federation metadata.");
65                 } catch (SAXException e) {
66                         log.error("Encountered a problem parsing federation metadata source: " + e);
67                         throw new MetadataException("Unable to parse federation metadata.");
68                 } catch (IOException e) {
69                         log.error("Encountered a problem reading federation metadata source: " + e);
70                         throw new MetadataException("Unable to read federation metadata.");
71                 }
72
73                 //Start checking for metadata updates
74                 start();
75
76         }
77
78         public Provider lookup(String providerId) {
79                 synchronized (currentMeta) {
80                         return currentMeta.lookup(providerId);
81                 }
82         }
83
84         protected void doOnChange() throws ResourceWatchdogExecutionException {
85         Document newDoc = null;
86                 //Log
87                 try {
88                         log.info("Detected a change in the federation metadata.  Reloading from (" + resource.getURL().toString()
89                                         + ").");
90                 } catch (IOException e) {
91                         log.error("Encountered an error retrieving updated federation metadata, continuing to use stale copy.");
92                         return;
93                 }
94
95                 //Load new, but keep the old in place
96                 try {
97             newDoc = org.opensaml.XML.parserPool.parse(resource.getInputStream());
98         } catch (SAMLException e) {
99             log.error("Encountered an error parsing updated federation metadata, continuing to use stale copy.");
100             return;
101                 } catch (SAXException e) {
102                         log.error("Encountered an error parsing updated federation metadata, continuing to use stale copy.");
103                         return;
104                 } catch (IOException e) {
105                         log.error("Encountered an error retrieving updated federation metadata, continuing to use stale copy.");
106                         return;
107                 }
108
109                 //If things went well, replace the live copy
110                 Metadata newMeta = null;
111                 try {
112                         newMeta = new XMLMetadata(newDoc.getDocumentElement());
113                 } catch (MetadataException e1) {
114                         log.error("Encountered an error loading updated federation metadata, continuing to use stale copy.");
115                         return;
116                 }
117
118                 if (newMeta != null) {
119                         synchronized (currentMeta) {
120                                 currentMeta = newMeta;
121                         }
122                 }
123         }
124
125 }