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