| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
| <title>Log4jServletContainerInitializer xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/logging/log4j/web/Log4jServletContainerInitializer.html">View Javadoc</a></div><pre> |
| <a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> |
| <a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> |
| <a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> |
| <a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache license, Version 2.0</em> |
| <a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> |
| <a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em> |
| <a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> |
| <a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> |
| <a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> |
| <a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em> |
| <a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the license.</em> |
| <a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.web; |
| <a class="jxr_linenumber" name="L18" href="#L18">18</a> |
| <a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.util.EnumSet; |
| <a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.util.Set; |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> javax.servlet.DispatcherType; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> javax.servlet.FilterRegistration; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletContainerInitializer; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletContext; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletException; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.Logger; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.status.StatusLogger; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * In a Servlet 3.0 or newer environment, this initializer is responsible for starting up Log4j logging before anything</em> |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * else happens in application initialization. For consistency across all containers, if the effective Servlet major</em> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * version of the application is less than 3.0, this initializer does nothing.</em> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/logging/log4j/web/Log4jServletContainerInitializer.html">Log4jServletContainerInitializer</a> <strong class="jxr_keyword">implements</strong> ServletContainerInitializer { |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> @Override |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onStartup(<strong class="jxr_keyword">final</strong> Set<Class<?>> classes, <strong class="jxr_keyword">final</strong> ServletContext servletContext) <strong class="jxr_keyword">throws</strong> ServletException { |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">if</strong> (servletContext.getMajorVersion() > 2 && servletContext.getEffectiveMajorVersion() > 2 && |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> !<span class="jxr_string">"true"</span>.equalsIgnoreCase(servletContext.getInitParameter( |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> Log4jWebSupport.IS_LOG4J_AUTO_INITIALIZATION_DISABLED |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> ))) { |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">final</strong> Logger LOGGER = StatusLogger.getLogger(); |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> LOGGER.debug(<span class="jxr_string">"Log4jServletContainerInitializer starting up Log4j in Servlet 3.0+ environment."</span>); |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">final</strong> FilterRegistration.Dynamic filter = |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> servletContext.addFilter(<span class="jxr_string">"log4jServletFilter"</span>, Log4jServletFilter.<strong class="jxr_keyword">class</strong>); |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">if</strong> (filter == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> LOGGER.warn(<span class="jxr_string">"WARNING: In a Servlet 3.0+ application, you should not define a "</span> + |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <span class="jxr_string">"log4jServletFilter in web.xml. Log4j 2 normally does this for you automatically. Log4j 2 "</span> + |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <span class="jxr_string">"web auto-initialization has been canceled."</span>); |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">return</strong>; |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> } |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/logging/log4j/web/Log4jWebLifeCycle.html">Log4jWebLifeCycle</a> initializer = WebLoggerContextUtils.getWebLifeCycle(servletContext); |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> initializer.start(); |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> initializer.setLoggerContext(); <em class="jxr_comment">// the application is just now starting to start up</em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> servletContext.addListener(<strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/logging/log4j/web/Log4jServletContextListener.html">Log4jServletContextListener</a>()); |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> filter.setAsyncSupported(<strong class="jxr_keyword">true</strong>); <em class="jxr_comment">// supporting async when the user isn't using async has no downsides</em> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> filter.addMappingForUrlPatterns(EnumSet.allOf(DispatcherType.<strong class="jxr_keyword">class</strong>), false, <span class="jxr_string">"/*"</span>); |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> } |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> } |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 1999–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
