Integrated Chad's logging changes:
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / idp / IdPConfigLoader.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;
27
28 import javax.servlet.ServletContext;
29
30 import org.apache.log4j.Logger;
31 import org.w3c.dom.Document;
32
33 import edu.internet2.middleware.shibboleth.common.ShibbolethConfigurationException;
34 import edu.internet2.middleware.shibboleth.xml.Parser;
35
36 /**
37  * Constructs a DOM tree for the IdP configuration XML file.
38  * 
39  * @author Walter Hoehn
40  * @author Noah Levitt
41  */
42 public class IdPConfigLoader {
43
44         private static Logger log = Logger.getLogger(IdPConfigLoader.class);
45         private static Document idpConfig = null;
46         private static String idpConfigFile = null;
47
48         /**
49          * Returnes the location of the configuration file.
50          * 
51          * @param context
52          *            the context of the IdP servlet
53          * @return the location of the configuration file
54          */
55         private static String getIdPConfigFile(ServletContext context) {
56
57                 if (context.getInitParameter("IdPConfigFile") != null) {
58                         return context.getInitParameter("IdPConfigFile");
59                 } else {
60                         return "/conf/idp.xml";
61                 }
62         }
63
64         /**
65          * Loads the IdP Configuration file into a DOM tree.
66          * 
67          * @param configFileLocation
68          *            URL of the configuration file
69          * @return the DOM Document
70          * @throws ShibbolethConfigurationException
71          *             if there was an error loading the file
72          */
73         public static synchronized Document getIdPConfig(String configFileLocation) throws ShibbolethConfigurationException {
74
75                 if (log.isDebugEnabled()) {
76                         log.debug("Getting IdP configuration file: " + configFileLocation);
77                 }
78
79                 if (configFileLocation.equals(idpConfigFile)) {
80                         return idpConfig;
81
82                 } else if (idpConfigFile == null) {
83                         idpConfigFile = configFileLocation;
84
85                 } else {
86                         log.error("Previously read IdP configuration from (" + idpConfigFile + "), re-reading from ("
87                                         + configFileLocation + "). This probably indicates a bug in shibboleth.");
88                         idpConfigFile = configFileLocation;
89                 }
90
91                 try {
92                         idpConfig = Parser.loadDom(configFileLocation, true);
93                         if (log.isDebugEnabled()) {
94                                 log.debug("IdP configuration file " + configFileLocation + " successfully read and cached.");
95                         }
96                 } catch (Exception e) {
97                         log.error("Encountered an error while parsing Shibboleth Identity Provider configuration file: " + e);
98                         throw new ShibbolethConfigurationException("Unable to parse IdP configuration file.");
99                 }
100                 return idpConfig;
101         }
102
103         /**
104          * Loads the IdP Configuration file into a DOM tree.
105          * 
106          * @param context
107          *            {@link ServletContext}from which to figure out the location of IdP
108          * @return the DOM Document
109          * @throws ShibbolethConfigurationException
110          *             if there was an error loading the file
111          */
112         public static Document getIdPConfig(ServletContext context) throws ShibbolethConfigurationException {
113
114                 return getIdPConfig(getIdPConfigFile(context));
115
116         }
117 }