| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>package org.apache.logging.log4j.web;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.util.Locale;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.concurrent.TimeUnit;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import javax.servlet.ServletContext;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import javax.servlet.ServletContextEvent;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import javax.servlet.ServletContextListener;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span><a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.Logger;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.LifeCycle2;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.util.Strings;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span><a name="line.30"></a> |
| <span class="sourceLineNo">031</span>/**<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * In environments older than Servlet 3.0, this initializer is responsible for starting up Log4j logging before anything<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * else happens in application initialization. In all environments, this shuts down Log4j after the application shuts<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * down.<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> */<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>public class Log4jServletContextListener implements ServletContextListener {<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> private static final int DEFAULT_STOP_TIMEOUT = 30;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> private static final TimeUnit DEFAULT_STOP_TIMEOUT_TIMEUNIT = TimeUnit.SECONDS;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> private static final String KEY_STOP_TIMEOUT = "log4j.stop.timeout";<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> private static final String KEY_STOP_TIMEOUT_TIMEUNIT = "log4j.stop.timeout.timeunit";<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> private ServletContext servletContext;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> private Log4jWebLifeCycle initializer;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> @Override<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> public void contextInitialized(final ServletContextEvent event) {<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> this.servletContext = event.getServletContext();<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> LOGGER.debug("Log4jServletContextListener ensuring that Log4j starts up properly.");<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> this.initializer = WebLoggerContextUtils.getWebLifeCycle(this.servletContext);<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> try {<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> this.initializer.start();<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> this.initializer.setLoggerContext(); // the application is just now starting to start up<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> } catch (final IllegalStateException e) {<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> throw new IllegalStateException("Failed to initialize Log4j properly.", e);<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> }<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> }<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> @Override<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> public void contextDestroyed(final ServletContextEvent event) {<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> if (this.servletContext == null || this.initializer == null) {<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> LOGGER.warn("Context destroyed before it was initialized.");<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> return;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> }<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> LOGGER.debug("Log4jServletContextListener ensuring that Log4j shuts down properly.");<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> this.initializer.clearLoggerContext(); // the application is finished<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> // shutting down now<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> if (initializer instanceof LifeCycle2) {<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> final String stopTimeoutStr = servletContext.getInitParameter(KEY_STOP_TIMEOUT);<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> final long stopTimeout = Strings.isEmpty(stopTimeoutStr) ? DEFAULT_STOP_TIMEOUT<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> : Long.parseLong(stopTimeoutStr);<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> final String timeoutTimeUnitStr = servletContext.getInitParameter(KEY_STOP_TIMEOUT_TIMEUNIT);<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> final TimeUnit timeoutTimeUnit = Strings.isEmpty(timeoutTimeUnitStr) ? DEFAULT_STOP_TIMEOUT_TIMEUNIT<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> : TimeUnit.valueOf(timeoutTimeUnitStr.toUpperCase(Locale.ROOT));<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> ((LifeCycle2) this.initializer).stop(stopTimeout, timeoutTimeUnit);<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> } else {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> this.initializer.stop();<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> }<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> }<a name="line.84"></a> |
| <span class="sourceLineNo">085</span>}<a name="line.85"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
