27adbdc141ba1b728551731a7fa139845bbcd2da
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / log / LogServ.java
1 /* 
2  * The Shibboleth License, Version 1. 
3  * Copyright (c) 2002 
4  * University Corporation for Advanced Internet Development, Inc. 
5  * All rights reserved
6  * 
7  * 
8  * Redistribution and use in source and binary forms, with or without 
9  * modification, are permitted provided that the following conditions are met:
10  * 
11  * Redistributions of source code must retain the above copyright notice, this 
12  * list of conditions and the following disclaimer.
13  * 
14  * Redistributions in binary form must reproduce the above copyright notice, 
15  * this list of conditions and the following disclaimer in the documentation 
16  * and/or other materials provided with the distribution, if any, must include 
17  * the following acknowledgment: "This product includes software developed by 
18  * the University Corporation for Advanced Internet Development 
19  * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement 
20  * may appear in the software itself, if and wherever such third-party 
21  * acknowledgments normally appear.
22  * 
23  * Neither the name of Shibboleth nor the names of its contributors, nor 
24  * Internet2, nor the University Corporation for Advanced Internet Development, 
25  * Inc., nor UCAID may be used to endorse or promote products derived from this 
26  * software without specific prior written permission. For written permission, 
27  * please contact shibboleth@shibboleth.org
28  * 
29  * Products derived from this software may not be called Shibboleth, Internet2, 
30  * UCAID, or the University Corporation for Advanced Internet Development, nor 
31  * may Shibboleth appear in their name, without prior written permission of the 
32  * University Corporation for Advanced Internet Development.
33  * 
34  * 
35  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
36  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
37  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
38  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK 
39  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE. 
40  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY 
41  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT, 
42  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
43  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
44  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
47  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48  */
49
50 package edu.internet2.middleware.shibboleth.log;
51
52 import java.io.IOException;
53
54 import javax.servlet.ServletException;
55 import javax.servlet.UnavailableException;
56 import javax.servlet.http.HttpServlet;
57
58 import org.apache.log4j.Logger;
59 import org.apache.log4j.MDC;
60 import org.apache.log4j.PropertyConfigurator;
61 import org.apache.xml.security.Init;
62
63 import edu.internet2.middleware.shibboleth.common.ShibResource;
64
65 /**
66  * 
67  * Servlet used to configure logging for other components.
68  * 
69  * @author Walter Hoehn
70  *
71  */
72 public class LogServ extends HttpServlet {
73
74         private static Logger log = Logger.getLogger(LogServ.class.getName());
75
76         /**
77          * @see javax.servlet.GenericServlet#init()
78          */
79         public void init() throws ServletException {
80
81                 super.init();
82                 //Silliness to get around xmlsec doing its own configuration, ie: we might need to override it
83                 Init.init();
84                 String log4jConfigFileLocation = getServletConfig().getInitParameter("log4jConfigFileLocation");
85                 if (log4jConfigFileLocation == null) {
86                         log4jConfigFileLocation = "/conf/log4j.properties";
87                 }
88                 try {
89                         PropertyConfigurator.configure(new ShibResource(log4jConfigFileLocation, this.getClass()).getURL());
90                 } catch (IOException e) {
91                         getServletContext().log("Could not load Logger configuration from supplied location.", e);
92                         System.err.println("Could not load Logger configuration from supplied location: " + e);
93                         throw new UnavailableException("Could not load Logger configuration from supplied location: " + e);
94                 }
95                 MDC.put("serviceId", "[Logger] Core");
96                 log.info("Logger initialized.");
97         }
98
99 }
100