ae7c3412e19582dbfc7262100835d398fdf776b5
[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.apache.xerces.parsers.DOMParser;
33 import org.xml.sax.InputSource;
34 import org.xml.sax.SAXException;
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
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         private DOMParser               parser;
52
53         public XMLMetadataLoadWrapper(String sitesFileLocation) throws MetadataException, ResourceNotAvailableException {
54                 super(new ShibResource(sitesFileLocation), 5000);
55
56                 //TODO make validating
57                 parser = new DOMParser();
58                 try {
59                         ////parser.setFeature("http://xml.org/sax/features/validation", false);
60                         //parser.setFeature("http://apache.org/xml/features/validation/schema", false);
61                         parser.parse(new InputSource(resource.getInputStream()));
62                 } catch (SAXException e) {
63                         // TODO Auto-generated catch block
64                         e.printStackTrace();
65                 } catch (IOException e) {
66                         // TODO Auto-generated catch block
67                         e.printStackTrace();
68                 }
69                 currentMeta = new XMLMetadata(parser.getDocument().getDocumentElement());
70
71                 //Start checking for metadata updates
72                 start();
73
74         }
75
76         public Provider lookup(String providerId) {
77                 synchronized (currentMeta) {
78                         return currentMeta.lookup(providerId);
79                 }
80         }
81
82         protected void doOnChange() throws ResourceWatchdogExecutionException {
83                 //Log
84                 try {
85                         log.info("Detected a change in the federation metadata.  Reloading from (" + resource.getURL().toString()
86                                         + ").");
87                 } catch (IOException e) {
88                         log.error("Encountered an error retrieving updated federation metadata, continuing to use stale copy.");
89                         return;
90                 }
91
92                 //Load new, but keep the old in place
93                 try {
94                         parser.parse(new InputSource(resource.getInputStream()));
95                 } catch (SAXException e) {
96                         log.error("Encountered an error parsing updated federation metadata, continuing to use stale copy.");
97                         return;
98                 } catch (IOException e) {
99                         log.error("Encountered an error retrieving updated federation metadata, continuing to use stale copy.");
100                         return;
101                 }
102
103                 //If things went well, replace the live copy
104                 Metadata newMeta = null;
105                 try {
106                         newMeta = new XMLMetadata(parser.getDocument().getDocumentElement());
107                 } catch (MetadataException e1) {
108                         log.error("Encountered an error loading updated federation metadata, continuing to use stale copy.");
109                         return;
110                 }
111
112                 if (newMeta != null) {
113                         synchronized (currentMeta) {
114                                 currentMeta = newMeta;
115                         }
116                 }
117         }
118
119 }