Google Git
Sign in
apache / logging-log4j-site / d0d0de55986756593c08e5d2b8059541eacaf428 / . / log4j-2.0-alpha1-SNAPSHOT / log4j-core / xref / org / apache / logging / log4j / core / javaee / JNDIContextFilter.html
blob: 0272896c3ee30fd1995dcebc547ac55b70d49281 [file] [log] [blame]
<!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>JNDIContextFilter xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/logging/log4j/core/javaee/JNDIContextFilter.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="5" href="#5">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="6" href="#6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * limitations under the license.</em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.core.javaee;
<a class="jxr_linenumber" name="18" href="#18">18</a>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.LogManager;
<a class="jxr_linenumber" name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.impl.Log4jContextFactory;
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.selector.ContextSelector;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.LoggerContext;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.selector.NamedContextSelector;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.spi.LoggerContextFactory;
<a class="jxr_linenumber" name="25" href="#25">25</a>
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> javax.servlet.Filter;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> javax.servlet.FilterChain;
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> javax.servlet.FilterConfig;
<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletContext;
<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletException;
<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest;
<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse;
<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> javax.servlet.UnavailableException;
<a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="35" href="#35">35</a>
<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * ServletFilter than may be used to set up a LoggerContext for each web application.</em>
<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="39" href="#39">39</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/javaee/JNDIContextFilter.html">JNDIContextFilter</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../../org/apache/logging/log4j/core/Filter.html">Filter</a> {
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * The Filter init parameter that defines the name of the LoggerContext.</em>
<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="43" href="#43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CONTEXT_NAME = <span class="jxr_string">"context-name"</span>;
<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * The Filter init parameter that defines the configuration location for the LoggerContext.</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="47" href="#47">47</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CONFIG_LOCATION = <span class="jxr_string">"config-location"</span>;
<a class="jxr_linenumber" name="48" href="#48">48</a> <strong class="jxr_keyword">private</strong> ServletContext context;
<a class="jxr_linenumber" name="49" href="#49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> created = false;
<a class="jxr_linenumber" name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> String name;
<a class="jxr_linenumber" name="51" href="#51">51</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/logging/log4j/core/selector/NamedContextSelector.html">NamedContextSelector</a> selector = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="52" href="#52">52</a>
<a class="jxr_linenumber" name="53" href="#53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init(FilterConfig filterConfig) <strong class="jxr_keyword">throws</strong> ServletException {
<a class="jxr_linenumber" name="54" href="#54">54</a> context = filterConfig.getServletContext();
<a class="jxr_linenumber" name="55" href="#55">55</a> name = filterConfig.getInitParameter(CONTEXT_NAME);
<a class="jxr_linenumber" name="56" href="#56">56</a> String configLocn = filterConfig.getInitParameter(CONFIG_LOCATION);
<a class="jxr_linenumber" name="57" href="#57">57</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="58" href="#58">58</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> UnavailableException(<span class="jxr_string">"A context-name attribute is required"</span>);
<a class="jxr_linenumber" name="59" href="#59">59</a> }
<a class="jxr_linenumber" name="60" href="#60">60</a> <strong class="jxr_keyword">if</strong> (context.getAttribute(ContextListener.LOG4J_CONTEXT_ATTRIBUTE) == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="61" href="#61">61</a> <a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html">LoggerContext</a> ctx;
<a class="jxr_linenumber" name="62" href="#62">62</a> LoggerContextFactory factory = LogManager.getFactory();
<a class="jxr_linenumber" name="63" href="#63">63</a> <strong class="jxr_keyword">if</strong> (factory instanceof Log4jContextFactory) {
<a class="jxr_linenumber" name="64" href="#64">64</a> <a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html">ContextSelector</a> sel = ((Log4jContextFactory) factory).getSelector();
<a class="jxr_linenumber" name="65" href="#65">65</a> <strong class="jxr_keyword">if</strong> (sel instanceof NamedContextSelector) {
<a class="jxr_linenumber" name="66" href="#66">66</a> selector = (NamedContextSelector) sel;
<a class="jxr_linenumber" name="67" href="#67">67</a> ctx = selector.locateContext(name, configLocn);
<a class="jxr_linenumber" name="68" href="#68">68</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="69" href="#69">69</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="70" href="#70">70</a> }
<a class="jxr_linenumber" name="71" href="#71">71</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="72" href="#72">72</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="73" href="#73">73</a> }
<a class="jxr_linenumber" name="74" href="#74">74</a> context.setAttribute(ContextListener.LOG4J_CONTEXT_ATTRIBUTE, ctx);
<a class="jxr_linenumber" name="75" href="#75">75</a> created = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="76" href="#76">76</a> context.log(<span class="jxr_string">"Created context for "</span> + name + <span class="jxr_string">" using "</span> + ctx.getClass().getClassLoader());
<a class="jxr_linenumber" name="77" href="#77">77</a> }
<a class="jxr_linenumber" name="78" href="#78">78</a> }
<a class="jxr_linenumber" name="79" href="#79">79</a>
<a class="jxr_linenumber" name="80" href="#80">80</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
<a class="jxr_linenumber" name="81" href="#81">81</a> <strong class="jxr_keyword">throws</strong> IOException, ServletException {
<a class="jxr_linenumber" name="82" href="#82">82</a> <a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html">LoggerContext</a> ctx = (LoggerContext) context.getAttribute(ContextListener.LOG4J_CONTEXT_ATTRIBUTE);
<a class="jxr_linenumber" name="83" href="#83">83</a> <strong class="jxr_keyword">if</strong> (ctx != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="84" href="#84">84</a> ContextAnchor.THREAD_CONTEXT.set(ctx);
<a class="jxr_linenumber" name="85" href="#85">85</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="86" href="#86">86</a> filterChain.doFilter(servletRequest, servletResponse);
<a class="jxr_linenumber" name="87" href="#87">87</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="88" href="#88">88</a> ContextAnchor.THREAD_CONTEXT.remove();
<a class="jxr_linenumber" name="89" href="#89">89</a> }
<a class="jxr_linenumber" name="90" href="#90">90</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="91" href="#91">91</a> filterChain.doFilter(servletRequest, servletResponse);
<a class="jxr_linenumber" name="92" href="#92">92</a> }
<a class="jxr_linenumber" name="93" href="#93">93</a> }
<a class="jxr_linenumber" name="94" href="#94">94</a>
<a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> destroy() {
<a class="jxr_linenumber" name="96" href="#96">96</a> <a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html">LoggerContext</a> ctx = (LoggerContext) context.getAttribute(ContextListener.LOG4J_CONTEXT_ATTRIBUTE);
<a class="jxr_linenumber" name="97" href="#97">97</a> <strong class="jxr_keyword">if</strong> (ctx != <strong class="jxr_keyword">null</strong> &amp;&amp; created) {
<a class="jxr_linenumber" name="98" href="#98">98</a> context.log(<span class="jxr_string">"Removing context for "</span> + name);
<a class="jxr_linenumber" name="99" href="#99">99</a> context.removeAttribute(ContextListener.LOG4J_CONTEXT_ATTRIBUTE);
<a class="jxr_linenumber" name="100" href="#100">100</a> <strong class="jxr_keyword">if</strong> (selector != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="101" href="#101">101</a> selector.removeContext(name);
<a class="jxr_linenumber" name="102" href="#102">102</a> }
<a class="jxr_linenumber" name="103" href="#103">103</a> ctx.stop();
<a class="jxr_linenumber" name="104" href="#104">104</a> }
<a class="jxr_linenumber" name="105" href="#105">105</a> }
<a class="jxr_linenumber" name="106" href="#106">106</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>