src/edu/internet2/middleware/shibboleth/idp/provider/BaseHandler.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 above
   6  * copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials
   7  * provided with the distribution, if any, must include the following acknowledgment: "This product includes software
   8  * developed by the University Corporation for Advanced Internet Development <http://www.ucaid.edu> Internet2 Project.
   9  * 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, nor
  11  * 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 contact
  13  * shibboleth@shibboleth.org Products derived from this software may not be called Shibboleth, Internet2, UCAID, or the
  14  * University Corporation for Advanced Internet Development, nor may Shibboleth appear in their name, without prior
  15  * written permission of the University Corporation for Advanced Internet Development. THIS SOFTWARE IS PROVIDED BY THE
  16  * COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE
  18  * DISCLAIMED AND THE ENTIRE RISK OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE. IN NO
  19  * EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC.
  20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  21  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  23  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 package edu.internet2.middleware.shibboleth.idp.provider;
  27
  28 import java.net.URI;
  29 import java.net.URISyntaxException;
  30 import java.util.HashSet;
  31
  32 import org.apache.log4j.Logger;
  33 import org.w3c.dom.Element;
  34 import org.w3c.dom.Node;
  35 import org.w3c.dom.NodeList;
  36
  37 import edu.internet2.middleware.shibboleth.common.ShibbolethConfigurationException;
  38 import edu.internet2.middleware.shibboleth.idp.IdPConfig;
  39 import edu.internet2.middleware.shibboleth.idp.IdPProtocolHandler;
  40
  41 /**
  42  * Functionality common to all <code>IdPProtocolHandler</code> implementation.
  43  *
  44  * @author Walter Hoehn
  45  */
  46 public abstract class BaseHandler implements IdPProtocolHandler {
  47
  48         private static Logger log = Logger.getLogger(BaseHandler.class.getName());
  49         private HashSet locations = new HashSet();
  50
  51         /**
  52          * Required DOM-based constructor.
  53          */
  54         public BaseHandler(Element config) throws ShibbolethConfigurationException {
  55
  56                 // Make sure we have at least one location
  57                 NodeList locations = config.getElementsByTagNameNS(IdPConfig.configNameSpace, "Location");
  58                 if (locations.getLength() < 1) {
  59                         log.error("The <ProtocolHandler/> element must contain at least one <Location/> element.");
  60                         throw new ShibbolethConfigurationException("Unable to load ProtocolHandler.");
  61                 }
  62
  63                 // Parse the locations
  64                 for (int i = 0; i < locations.getLength(); i++) {
  65                         Node tnode = ((Element) locations.item(i)).getFirstChild();
  66                         if (tnode != null && tnode.getNodeType() == Node.TEXT_NODE) {
  67                                 String rawURI = tnode.getNodeValue();
  68
  69                                 if (rawURI == null || rawURI.equals("")) {
  70                                         log.error("The <Location/> element inside the <ProtocolHandler/> element must contain a URI.");
  71                                         throw new ShibbolethConfigurationException("Unable to load ProtocolHandler.");
  72                                 }
  73
  74                                 try {
  75                                         URI location = new URI(rawURI);
  76                                         this.locations.add(location);
  77                                 } catch (URISyntaxException e) {
  78                                         log.error("The <Location/> element inside the <ProtocolHandler/> element contains "
  79                                                         + "an improperly formatted URI: " + e);
  80                                         throw new ShibbolethConfigurationException("Unable to load ProtocolHandler.");
  81                                 }
  82
  83                         } else {
  84                                 log.error("The <Location/> element inside the <ProtocolHandler/> element must contain a URI.");
  85                                 throw new ShibbolethConfigurationException("Unable to load ProtocolHandler.");
  86                         }
  87                 }
  88         }
  89
  90         /*
  91          * @see edu.internet2.middleware.shibboleth.idp.IdPProtocolHandler#getLocations()
  92          */
  93         public URI[] getLocations() {
  94
  95                 return (URI[]) locations.toArray(new URI[0]);
  96         }
  97
  98 }