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