blob: 09fb79a8bd78b0ad1922dd26a6eca4d700fb609f [file] [log] [blame]
<!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.EnumSet;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.Set;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import javax.servlet.DispatcherType;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import javax.servlet.FilterRegistration;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import javax.servlet.ServletContainerInitializer;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import javax.servlet.ServletContext;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import javax.servlet.ServletException;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.Logger;<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><a name="line.29"></a>
<span class="sourceLineNo">030</span>/**<a name="line.30"></a>
<span class="sourceLineNo">031</span> * In a Servlet 3.0 or newer environment, this initializer is responsible for starting up Log4j logging before anything<a name="line.31"></a>
<span class="sourceLineNo">032</span> * else happens in application initialization. For consistency across all containers, if the effective Servlet major<a name="line.32"></a>
<span class="sourceLineNo">033</span> * version of the application is less than 3.0, this initializer does nothing.<a name="line.33"></a>
<span class="sourceLineNo">034</span> */<a name="line.34"></a>
<span class="sourceLineNo">035</span>public class Log4jServletContainerInitializer implements ServletContainerInitializer {<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> @Override<a name="line.37"></a>
<span class="sourceLineNo">038</span> public void onStartup(final Set&lt;Class&lt;?&gt;&gt; classes, final ServletContext servletContext) throws ServletException {<a name="line.38"></a>
<span class="sourceLineNo">039</span> if (servletContext.getMajorVersion() &gt; 2 &amp;&amp; servletContext.getEffectiveMajorVersion() &gt; 2 &amp;&amp;<a name="line.39"></a>
<span class="sourceLineNo">040</span> !"true".equalsIgnoreCase(servletContext.getInitParameter(<a name="line.40"></a>
<span class="sourceLineNo">041</span> Log4jWebSupport.IS_LOG4J_AUTO_INITIALIZATION_DISABLED<a name="line.41"></a>
<span class="sourceLineNo">042</span> ))) {<a name="line.42"></a>
<span class="sourceLineNo">043</span> final Logger LOGGER = StatusLogger.getLogger();<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> LOGGER.debug("Log4jServletContainerInitializer starting up Log4j in Servlet 3.0+ environment.");<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> final FilterRegistration.Dynamic filter =<a name="line.47"></a>
<span class="sourceLineNo">048</span> servletContext.addFilter("log4jServletFilter", Log4jServletFilter.class);<a name="line.48"></a>
<span class="sourceLineNo">049</span> if (filter == null) {<a name="line.49"></a>
<span class="sourceLineNo">050</span> LOGGER.warn("WARNING: In a Servlet 3.0+ application, you should not define a " +<a name="line.50"></a>
<span class="sourceLineNo">051</span> "log4jServletFilter in web.xml. Log4j 2 normally does this for you automatically. Log4j 2 " +<a name="line.51"></a>
<span class="sourceLineNo">052</span> "web auto-initialization has been canceled.");<a name="line.52"></a>
<span class="sourceLineNo">053</span> return;<a name="line.53"></a>
<span class="sourceLineNo">054</span> }<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> final Log4jWebLifeCycle initializer = WebLoggerContextUtils.getWebLifeCycle(servletContext);<a name="line.56"></a>
<span class="sourceLineNo">057</span> initializer.start();<a name="line.57"></a>
<span class="sourceLineNo">058</span> initializer.setLoggerContext(); // the application is just now starting to start up<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> servletContext.addListener(new Log4jServletContextListener());<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> filter.setAsyncSupported(true); // supporting async when the user isn't using async has no downsides<a name="line.62"></a>
<span class="sourceLineNo">063</span> filter.addMappingForUrlPatterns(EnumSet.allOf(DispatcherType.class), false, "/*");<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span> }<a name="line.65"></a>
<span class="sourceLineNo">066</span>}<a name="line.66"></a>
</pre>
</div>
</body>
</html>