Metadata provider now supports inline metadata specification.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / metadata / provider / XMLMetadata.java
index 75580a8..4ade35b 100644 (file)
@@ -2,26 +2,25 @@
  * The Shibboleth License, Version 1. Copyright (c) 2002 University Corporation for Advanced Internet Development, Inc.
  * All rights reserved Redistribution and use in source and binary forms, with or without modification, are permitted
  * provided that the following conditions are met: Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the
- * above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other
- * materials provided with the distribution, if any, must include the following acknowledgment: "This product includes
- * software developed by the University Corporation for Advanced Internet Development <http://www.ucaid.edu>Internet2
- * Project. Alternately, this acknowledegement may appear in the software itself, if and wherever such third-party
- * acknowledgments normally appear. Neither the name of Shibboleth nor the names of its contributors, nor Internet2,
- * nor the University Corporation for Advanced Internet Development, Inc., nor UCAID may be used to endorse or promote
- * products derived from this software without specific prior written permission. For written permission, please
- * contact shibboleth@shibboleth.org Products derived from this software may not be called Shibboleth, Internet2,
- * UCAID, or the University Corporation for Advanced Internet Development, nor may Shibboleth appear in their name,
- * without prior written permission of the University Corporation for Advanced Internet Development. THIS SOFTWARE IS
- * PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES,
- * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
- * NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS
- * WITH LICENSEE. IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY CORPORATION FOR ADVANCED
- * INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
- * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
- * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
+ * notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials
+ * provided with the distribution, if any, must include the following acknowledgment: "This product includes software
+ * developed by the University Corporation for Advanced Internet Development <http://www.ucaid.edu>Internet2 Project.
+ * Alternately, this acknowledegement may appear in the software itself, if and wherever such third-party
+ * acknowledgments normally appear. Neither the name of Shibboleth nor the names of its contributors, nor Internet2, nor
+ * the University Corporation for Advanced Internet Development, Inc., nor UCAID may be used to endorse or promote
+ * products derived from this software without specific prior written permission. For written permission, please contact
+ * shibboleth@shibboleth.org Products derived from this software may not be called Shibboleth, Internet2, UCAID, or the
+ * University Corporation for Advanced Internet Development, nor may Shibboleth appear in their name, without prior
+ * written permission of the University Corporation for Advanced Internet Development. THIS SOFTWARE IS PROVIDED BY THE
+ * COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE
+ * DISCLAIMED AND THE ENTIRE RISK OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE. IN NO
+ * EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC.
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+ * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 package edu.internet2.middleware.shibboleth.metadata.provider;
@@ -34,6 +33,7 @@ import org.opensaml.XML;
 import org.opensaml.artifact.Artifact;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
+import org.w3c.dom.NodeList;
 import org.xml.sax.InputSource;
 import org.xml.sax.SAXException;
 
@@ -51,70 +51,115 @@ import edu.internet2.middleware.shibboleth.xml.Parser;
  */
 public class XMLMetadata extends ResourceWatchdog implements Metadata {
 
-       private static Logger   log     = Logger.getLogger(XMLMetadataLoadWrapper.class.getName());
-       private Metadata                currentMeta;
+       private static Logger log = Logger.getLogger(XMLMetadataLoadWrapper.class.getName());
+       private Metadata currentMeta;
 
        public XMLMetadata(Element configuration) throws MetadataException, ResourceNotAvailableException {
-               this(configuration.getAttribute("uri"));
+
+               super(new ShibResource(configuration.getAttribute("uri"), XMLMetadata.class));
+
+               try {
+
+                       if (configuration.getAttribute("uri") != null && !configuration.getAttribute("uri").equals("")) {
+                               // The configuration points to a metadata file
+                               InputSource src = new InputSource(resource.getInputStream());
+                               src.setSystemId(resource.getURL().toString());
+                               Document doc = Parser.loadDom(src, true);
+                               currentMeta = new XMLMetadataProvider(doc.getDocumentElement());
+
+                               // Start checking for metadata updates
+                               start();
+
+                       } else {
+                               // Hopefully, the configuration is inline (don't reload in this case)
+                               NodeList children = configuration.getChildNodes();
+                               for (int i = 0; i < children.getLength(); i++) {
+
+                                       if ((children.item(i) instanceof Element)
+                                                       && (XML.isElementNamed((Element) children.item(i),
+                                                                       edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS, "EntitiesDescriptor") || XML
+                                                                       .isElementNamed((Element) children.item(i),
+                                                                                       edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,
+                                                                                       "EntityDescriptor"))) {
+                                               currentMeta = new XMLMetadataProvider((Element) children.item(i));
+                                               return;
+                                       }
+                               }
+                               // We didn't find a uri pointer or inline metadata, bail out
+                               log.error("Encountered a problem reading metadata: <MetadataProvider/> configuration must "
+                                               + "include either a (uri) attribute or inline metadata.");
+                               throw new MetadataException("Unable to read metadata.");
+                       }
+
+               } catch (IOException e) {
+                       log.error("Encountered a problem reading metadata source: " + e);
+                       throw new MetadataException("Unable to read metadata: " + e);
+               } catch (SAXException e) {
+                       log.error("Encountered a problem parsing metadata source: " + e);
+                       throw new MetadataException("Unable to read metadata: " + e);
+               } catch (SAMLException e) {
+                       log.error("Encountered a problem processing metadata source: " + e);
+                       throw new MetadataException("Unable to read metadata: + e");
+               }
+
        }
 
        public XMLMetadata(String sitesFileLocation) throws MetadataException, ResourceNotAvailableException {
+
                super(new ShibResource(sitesFileLocation, XMLMetadata.class));
                try {
-            InputSource src = new InputSource(resource.getInputStream());
-            src.setSystemId(resource.getURL().toString());
-                       Document doc = Parser.loadDom(src,true);
+                       InputSource src = new InputSource(resource.getInputStream());
+                       src.setSystemId(resource.getURL().toString());
+                       Document doc = Parser.loadDom(src, true);
                        currentMeta = new XMLMetadataProvider(doc.getDocumentElement());
                } catch (IOException e) {
                        log.error("Encountered a problem reading metadata source: " + e);
                        throw new MetadataException("Unable to read metadata: " + e);
+               } catch (SAXException e) {
+                       log.error("Encountered a problem parsing metadata source: " + e);
+                       throw new MetadataException("Unable to read metadata: " + e);
+               } catch (SAMLException e) {
+                       log.error("Encountered a problem processing metadata source: " + e);
+                       throw new MetadataException("Unable to read metadata: + e");
                }
-        catch (SAXException e) {
-            log.error("Encountered a problem parsing metadata source: " + e);
-            throw new MetadataException("Unable to read metadata: + e");
-        }
-        catch (SAMLException e) {
-            log.error("Encountered a problem processing metadata source: " + e);
-            throw new MetadataException("Unable to read metadata: + e");
-        }
-
-               //Start checking for metadata updates
+
+               // Start checking for metadata updates
                start();
 
        }
 
        public EntityDescriptor lookup(String providerId) {
+
                synchronized (currentMeta) {
                        return currentMeta.lookup(providerId);
                }
        }
 
-    public EntityDescriptor lookup(Artifact artifact) {
-        synchronized (currentMeta) {
-            return currentMeta.lookup(artifact);
-        }
-    }
-    
+       public EntityDescriptor lookup(Artifact artifact) {
+
+               synchronized (currentMeta) {
+                       return currentMeta.lookup(artifact);
+               }
+       }
+
        protected void doOnChange() throws ResourceWatchdogExecutionException {
-        Metadata newMeta = null;
-        Document newDoc = null;
+
+               Metadata newMeta = null;
+               Document newDoc = null;
 
                try {
                        log.info("Detected a change in the metadata. Reloading from (" + resource.getURL().toString() + ").");
-            newMeta = new XMLMetadataProvider(XML.parserPool.parse(resource.getInputStream()).getDocumentElement());
-        }
-        catch (IOException e) {
-                       log.error("Encountered an error retrieving updated federation metadata, continuing to use stale copy: " + e);
+                       newMeta = new XMLMetadataProvider(XML.parserPool.parse(resource.getInputStream()).getDocumentElement());
+               } catch (IOException e) {
+                       log.error("Encountered an error retrieving updated SAML metadata, continuing to use stale copy: " + e);
+                       return;
+               } catch (SAXException e) {
+                       log.error("Encountered an error retrieving updated SAML metadata, continuing to use stale copy: " + e);
+                       return;
+               } catch (SAMLException e) {
+                       log.error("Encountered an error retrieving updated SAML metadata, continuing to use stale copy: " + e);
                        return;
                }
-        catch (SAXException e) {
-            log.error("Encountered an error retrieving updated federation metadata, continuing to use stale copy: " + e);
-            return;
-        }
-        catch (SAMLException e) {
-            log.error("Encountered an error retrieving updated federation metadata, continuing to use stale copy: " + e);
-            return;
-        }
 
                if (newMeta != null) {
                        synchronized (currentMeta) {