Default protocol handler configuration is used if none is specified in idp.xml.
[java-idp.git] / 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.util.HashSet;
29
30 import javax.security.auth.x500.X500Principal;
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.common.provider.ShibbolethTrust;
39 import edu.internet2.middleware.shibboleth.idp.IdPConfig;
40 import edu.internet2.middleware.shibboleth.idp.IdPProtocolHandler;
41
42 /**
43  * Functionality common to all <code>IdPProtocolHandler</code> implementation.
44  * 
45  * @author Walter Hoehn
46  */
47 public abstract class BaseHandler implements IdPProtocolHandler {
48
49         private static Logger log = Logger.getLogger(BaseHandler.class.getName());
50         private HashSet locations = new HashSet();
51
52         /**
53          * Required DOM-based constructor.
54          */
55         public BaseHandler(Element config) throws ShibbolethConfigurationException {
56
57                 // Make sure we have at least one location
58                 NodeList locations = config.getElementsByTagNameNS(IdPConfig.configNameSpace, "Location");
59                 if (locations.getLength() < 1) {
60                         log.error("The <ProtocolHandler/> element must contain at least one <Location/> element.");
61                         throw new ShibbolethConfigurationException("Unable to load ProtocolHandler.");
62                 }
63
64                 // Parse the locations
65                 for (int i = 0; i < locations.getLength(); i++) {
66                         Node tnode = ((Element) locations.item(i)).getFirstChild();
67                         if (tnode != null && tnode.getNodeType() == Node.TEXT_NODE) {
68                                 String rawURI = tnode.getNodeValue();
69
70                                 if (rawURI == null || rawURI.equals("")) {
71                                         log.error("The <Location/> element inside the <ProtocolHandler/> element must "
72                                                         + "contain a URI or regular expressions.");
73                                         throw new ShibbolethConfigurationException("Unable to load ProtocolHandler.");
74                                 }
75                                 this.locations.add(rawURI);
76
77                         } else {
78                                 log.error("The <Location/> element inside the <ProtocolHandler/> element must contain a "
79                                                 + "URI or regular expression.");
80                                 throw new ShibbolethConfigurationException("Unable to load ProtocolHandler.");
81                         }
82                 }
83         }
84
85         /*
86          * @see edu.internet2.middleware.shibboleth.idp.IdPProtocolHandler#getLocations()
87          */
88         public String[] getLocations() {
89
90                 return (String[]) locations.toArray(new String[0]);
91         }
92
93         protected static String getHostNameFromDN(X500Principal dn) {
94
95                 return ShibbolethTrust.getHostNameFromDN(dn);
96         }
97
98 }