blob: 7f1199d3c4df812208ca1cb33a0dc2c71f701985 [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>LoggerContext xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/logging/log4j/core/LoggerContext.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;
<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.core.config.Configuration;
<a class="jxr_linenumber" name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.ConfigurationFactory;
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.ConfigurationListener;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.DefaultConfiguration;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.NullConfiguration;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.status.StatusLogger;
<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> java.io.File;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.net.URI;
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.ConcurrentHashMap;
<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.ConcurrentMap;
<a class="jxr_linenumber" name="30" href="#30">30</a>
<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * The LoggerContext is the anchor for the logging system. It maintains a list of all the loggers requested by</em>
<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * applications and a reference to the Configuration. The Configuration will contain the configured loggers, appenders,</em>
<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * filters, etc and will be atomically updated whenever a reconfigure occurs.</em>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/logging/log4j/core/LoggerContext.html">LoggerContext</a> <strong class="jxr_keyword">implements</strong> org.apache.logging.log4j.spi.LoggerContext, ConfigurationListener, <a href="../../../../../org/apache/logging/log4j/core/Lifecycle.html">Lifecycle</a> {
<a class="jxr_linenumber" name="37" href="#37">37</a>
<a class="jxr_linenumber" name="38" href="#38">38</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> StatusLogger logger = StatusLogger.getLogger();
<a class="jxr_linenumber" name="39" href="#39">39</a>
<a class="jxr_linenumber" name="40" href="#40">40</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ConcurrentMap&lt;String, Logger&gt; loggers = <strong class="jxr_keyword">new</strong> ConcurrentHashMap&lt;String, Logger&gt;();
<a class="jxr_linenumber" name="41" href="#41">41</a>
<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> <em class="jxr_javadoccomment"> * The Configuration is volatile to guarantee that initialization of the Configuration has completed before</em>
<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * the reference is updated.</em>
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">volatile</strong> <a href="../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/logging/log4j/core/config/DefaultConfiguration.html">DefaultConfiguration</a>();
<a class="jxr_linenumber" name="47" href="#47">47</a>
<a class="jxr_linenumber" name="48" href="#48">48</a> <strong class="jxr_keyword">private</strong> Object externalContext = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="49" href="#49">49</a>
<a class="jxr_linenumber" name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String contextName;
<a class="jxr_linenumber" name="51" href="#51">51</a>
<a class="jxr_linenumber" name="52" href="#52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> URI configLocation;
<a class="jxr_linenumber" name="53" href="#53">53</a>
<a class="jxr_linenumber" name="54" href="#54">54</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isStarted;
<a class="jxr_linenumber" name="55" href="#55">55</a>
<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * Constructor taking only a name.</em>
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * @param name The context name.</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="60" href="#60">60</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/logging/log4j/core/LoggerContext.html">LoggerContext</a>(String name) {
<a class="jxr_linenumber" name="61" href="#61">61</a> <strong class="jxr_keyword">this</strong>(name, <strong class="jxr_keyword">null</strong>, (URI) <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="62" href="#62">62</a> }
<a class="jxr_linenumber" name="63" href="#63">63</a>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * Constructor taking a name and a reference to an external context.</em>
<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * @param name The context name.</em>
<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @param externalContext The external context.</em>
<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="69" href="#69">69</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/logging/log4j/core/LoggerContext.html">LoggerContext</a>(String name, Object externalContext) {
<a class="jxr_linenumber" name="70" href="#70">70</a> <strong class="jxr_keyword">this</strong>(name, externalContext, (URI) <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="71" href="#71">71</a> }
<a class="jxr_linenumber" name="72" href="#72">72</a>
<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * Constructor taking a name, external context and a configuration URI.</em>
<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * @param name The context name.</em>
<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * @param externalContext The external context.</em>
<a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * @param configLocn The location of the configuration as a URI.</em>
<a class="jxr_linenumber" name="78" href="#78">78</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="79" href="#79">79</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/logging/log4j/core/LoggerContext.html">LoggerContext</a>(String name, Object externalContext, URI configLocn) {
<a class="jxr_linenumber" name="80" href="#80">80</a> contextName = name;
<a class="jxr_linenumber" name="81" href="#81">81</a> <strong class="jxr_keyword">this</strong>.externalContext = externalContext;
<a class="jxr_linenumber" name="82" href="#82">82</a> <strong class="jxr_keyword">this</strong>.configLocation = configLocn;
<a class="jxr_linenumber" name="83" href="#83">83</a> }
<a class="jxr_linenumber" name="84" href="#84">84</a>
<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * Constructor taking a name external context and a configuration location String. The location</em>
<a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * must be resolvable to a File.</em>
<a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @param name The configuration location.</em>
<a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @param externalContext The external context.</em>
<a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * @param configLocn The configuration location.</em>
<a class="jxr_linenumber" name="91" href="#91">91</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/logging/log4j/core/LoggerContext.html">LoggerContext</a>(String name, Object externalContext, String configLocn) {
<a class="jxr_linenumber" name="93" href="#93">93</a> contextName = name;
<a class="jxr_linenumber" name="94" href="#94">94</a> <strong class="jxr_keyword">this</strong>.externalContext = externalContext;
<a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">if</strong> (configLocn != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="96" href="#96">96</a> URI uri;
<a class="jxr_linenumber" name="97" href="#97">97</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="98" href="#98">98</a> uri = <strong class="jxr_keyword">new</strong> File(configLocn).toURI();
<a class="jxr_linenumber" name="99" href="#99">99</a> } <strong class="jxr_keyword">catch</strong> (Exception ex) {
<a class="jxr_linenumber" name="100" href="#100">100</a> uri = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="101" href="#101">101</a> }
<a class="jxr_linenumber" name="102" href="#102">102</a> configLocation = uri;
<a class="jxr_linenumber" name="103" href="#103">103</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="104" href="#104">104</a> configLocation = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="105" href="#105">105</a> }
<a class="jxr_linenumber" name="106" href="#106">106</a> }
<a class="jxr_linenumber" name="107" href="#107">107</a>
<a class="jxr_linenumber" name="108" href="#108">108</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> start() {
<a class="jxr_linenumber" name="109" href="#109">109</a> reconfigure();
<a class="jxr_linenumber" name="110" href="#110">110</a> isStarted = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="111" href="#111">111</a> }
<a class="jxr_linenumber" name="112" href="#112">112</a>
<a class="jxr_linenumber" name="113" href="#113">113</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> stop() {
<a class="jxr_linenumber" name="114" href="#114">114</a> isStarted = false;
<a class="jxr_linenumber" name="115" href="#115">115</a> updateLoggers(<strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/logging/log4j/core/config/NullConfiguration.html">NullConfiguration</a>());
<a class="jxr_linenumber" name="116" href="#116">116</a> config.stop();
<a class="jxr_linenumber" name="117" href="#117">117</a> externalContext = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="118" href="#118">118</a> }
<a class="jxr_linenumber" name="119" href="#119">119</a>
<a class="jxr_linenumber" name="120" href="#120">120</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isStarted() {
<a class="jxr_linenumber" name="121" href="#121">121</a> <strong class="jxr_keyword">return</strong> isStarted;
<a class="jxr_linenumber" name="122" href="#122">122</a> }
<a class="jxr_linenumber" name="123" href="#123">123</a>
<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * Set the external context.</em>
<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * @param context The external context.</em>
<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="128" href="#128">128</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setExternalContext(Object context) {
<a class="jxr_linenumber" name="129" href="#129">129</a> <strong class="jxr_keyword">this</strong>.externalContext = context;
<a class="jxr_linenumber" name="130" href="#130">130</a> }
<a class="jxr_linenumber" name="131" href="#131">131</a>
<a class="jxr_linenumber" name="132" href="#132">132</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * Return the external context.</em>
<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * @return The external context.</em>
<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="136" href="#136">136</a> <strong class="jxr_keyword">public</strong> Object getExternalContext() {
<a class="jxr_linenumber" name="137" href="#137">137</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.externalContext;
<a class="jxr_linenumber" name="138" href="#138">138</a> }
<a class="jxr_linenumber" name="139" href="#139">139</a>
<a class="jxr_linenumber" name="140" href="#140">140</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * Obtain a Logger from the Context.</em>
<a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * @param name The name of the Logger to return.</em>
<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * @return The Logger.</em>
<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="145" href="#145">145</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/logging/log4j/core/Logger.html">Logger</a> getLogger(String name) {
<a class="jxr_linenumber" name="146" href="#146">146</a>
<a class="jxr_linenumber" name="147" href="#147">147</a> <a href="../../../../../org/apache/logging/log4j/core/Logger.html">Logger</a> logger = loggers.get(name);
<a class="jxr_linenumber" name="148" href="#148">148</a> <strong class="jxr_keyword">if</strong> (logger != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="149" href="#149">149</a> <strong class="jxr_keyword">return</strong> logger;
<a class="jxr_linenumber" name="150" href="#150">150</a> }
<a class="jxr_linenumber" name="151" href="#151">151</a>
<a class="jxr_linenumber" name="152" href="#152">152</a> logger = (Logger) newInstance(<strong class="jxr_keyword">this</strong>, name);
<a class="jxr_linenumber" name="153" href="#153">153</a> <a href="../../../../../org/apache/logging/log4j/core/Logger.html">Logger</a> prev = loggers.putIfAbsent(name, logger);
<a class="jxr_linenumber" name="154" href="#154">154</a> <strong class="jxr_keyword">return</strong> prev == <strong class="jxr_keyword">null</strong> ? logger : prev;
<a class="jxr_linenumber" name="155" href="#155">155</a> }
<a class="jxr_linenumber" name="156" href="#156">156</a>
<a class="jxr_linenumber" name="157" href="#157">157</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * Determine if the specified Logger exists.</em>
<a class="jxr_linenumber" name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * @param name The Logger name to search for.</em>
<a class="jxr_linenumber" name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * @return True if the Logger exists, false otherwise.</em>
<a class="jxr_linenumber" name="161" href="#161">161</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="162" href="#162">162</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasLogger(String name) {
<a class="jxr_linenumber" name="163" href="#163">163</a> <strong class="jxr_keyword">return</strong> loggers.containsKey(name);
<a class="jxr_linenumber" name="164" href="#164">164</a> }
<a class="jxr_linenumber" name="165" href="#165">165</a>
<a class="jxr_linenumber" name="166" href="#166">166</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * Return the current Configuration. The Configuration will be replaced when a reconfigure occurs.</em>
<a class="jxr_linenumber" name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * @return The Configuration.</em>
<a class="jxr_linenumber" name="169" href="#169">169</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="170" href="#170">170</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> getConfiguration() {
<a class="jxr_linenumber" name="171" href="#171">171</a> <strong class="jxr_keyword">return</strong> config;
<a class="jxr_linenumber" name="172" href="#172">172</a> }
<a class="jxr_linenumber" name="173" href="#173">173</a>
<a class="jxr_linenumber" name="174" href="#174">174</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * Add a Filter to the Configuration. Filters that are added through the API will be lost</em>
<a class="jxr_linenumber" name="176" href="#176">176</a> <em class="jxr_javadoccomment"> * when a reconfigure occurs.</em>
<a class="jxr_linenumber" name="177" href="#177">177</a> <em class="jxr_javadoccomment"> * @param filter The Filter to add.</em>
<a class="jxr_linenumber" name="178" href="#178">178</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="179" href="#179">179</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addFilter(<a href="../../../../../org/apache/logging/log4j/core/Filter.html">Filter</a> filter) {
<a class="jxr_linenumber" name="180" href="#180">180</a> config.addFilter(filter);
<a class="jxr_linenumber" name="181" href="#181">181</a> }
<a class="jxr_linenumber" name="182" href="#182">182</a>
<a class="jxr_linenumber" name="183" href="#183">183</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * Removes a Filter from the current Configuration.</em>
<a class="jxr_linenumber" name="185" href="#185">185</a> <em class="jxr_javadoccomment"> * @param filter The Filter to remove.</em>
<a class="jxr_linenumber" name="186" href="#186">186</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="187" href="#187">187</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> removeFiler(<a href="../../../../../org/apache/logging/log4j/core/Filter.html">Filter</a> filter) {
<a class="jxr_linenumber" name="188" href="#188">188</a> config.removeFilter(filter);
<a class="jxr_linenumber" name="189" href="#189">189</a> }
<a class="jxr_linenumber" name="190" href="#190">190</a>
<a class="jxr_linenumber" name="191" href="#191">191</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="192" href="#192">192</a> <em class="jxr_javadoccomment"> * Set the Configuration to be used.</em>
<a class="jxr_linenumber" name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * @param config The new Configuration.</em>
<a class="jxr_linenumber" name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * @return The previous Configuration.</em>
<a class="jxr_linenumber" name="195" href="#195">195</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="196" href="#196">196</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <a href="../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> setConfiguration(<a href="../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config) {
<a class="jxr_linenumber" name="197" href="#197">197</a> <strong class="jxr_keyword">if</strong> (config == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="198" href="#198">198</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"No Configuration was provided"</span>);
<a class="jxr_linenumber" name="199" href="#199">199</a> }
<a class="jxr_linenumber" name="200" href="#200">200</a> <a href="../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> prev = <strong class="jxr_keyword">this</strong>.config;
<a class="jxr_linenumber" name="201" href="#201">201</a> config.addListener(<strong class="jxr_keyword">this</strong>);
<a class="jxr_linenumber" name="202" href="#202">202</a> config.start();
<a class="jxr_linenumber" name="203" href="#203">203</a> <strong class="jxr_keyword">this</strong>.config = config;
<a class="jxr_linenumber" name="204" href="#204">204</a> updateLoggers();
<a class="jxr_linenumber" name="205" href="#205">205</a> <strong class="jxr_keyword">if</strong> (prev != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="206" href="#206">206</a> prev.removeListener(<strong class="jxr_keyword">this</strong>);
<a class="jxr_linenumber" name="207" href="#207">207</a> prev.stop();
<a class="jxr_linenumber" name="208" href="#208">208</a> }
<a class="jxr_linenumber" name="209" href="#209">209</a> <strong class="jxr_keyword">return</strong> prev;
<a class="jxr_linenumber" name="210" href="#210">210</a> }
<a class="jxr_linenumber" name="211" href="#211">211</a>
<a class="jxr_linenumber" name="212" href="#212">212</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="213" href="#213">213</a> <em class="jxr_javadoccomment"> * Reconfigure the context.</em>
<a class="jxr_linenumber" name="214" href="#214">214</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="215" href="#215">215</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> reconfigure() {
<a class="jxr_linenumber" name="216" href="#216">216</a> logger.debug(<span class="jxr_string">"Reconfiguration started for context "</span> + contextName);
<a class="jxr_linenumber" name="217" href="#217">217</a> <a href="../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> instance = ConfigurationFactory.getInstance().getConfiguration(contextName, configLocation);
<a class="jxr_linenumber" name="218" href="#218">218</a> setConfiguration(instance);
<a class="jxr_linenumber" name="219" href="#219">219</a> <em class="jxr_comment">/*<em class="jxr_comment">instance.start();</em></em>
<a class="jxr_linenumber" name="220" href="#220">220</a> <em class="jxr_comment"> Configuration old = setConfiguration(instance);</em>
<a class="jxr_linenumber" name="221" href="#221">221</a> <em class="jxr_comment"> updateLoggers();</em>
<a class="jxr_linenumber" name="222" href="#222">222</a> <em class="jxr_comment"> if (old != null) {</em>
<a class="jxr_linenumber" name="223" href="#223">223</a> <em class="jxr_comment"> old.stop();</em>
<a class="jxr_linenumber" name="224" href="#224">224</a> <em class="jxr_comment"> } */</em>
<a class="jxr_linenumber" name="225" href="#225">225</a> logger.debug(<span class="jxr_string">"Reconfiguration completed"</span>);
<a class="jxr_linenumber" name="226" href="#226">226</a> }
<a class="jxr_linenumber" name="227" href="#227">227</a>
<a class="jxr_linenumber" name="228" href="#228">228</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * Cause all Loggers to be updated against the current Configuration.</em>
<a class="jxr_linenumber" name="230" href="#230">230</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="231" href="#231">231</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> updateLoggers() {
<a class="jxr_linenumber" name="232" href="#232">232</a> updateLoggers(<strong class="jxr_keyword">this</strong>.config);
<a class="jxr_linenumber" name="233" href="#233">233</a> }
<a class="jxr_linenumber" name="234" href="#234">234</a>
<a class="jxr_linenumber" name="235" href="#235">235</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="236" href="#236">236</a> <em class="jxr_javadoccomment"> * Cause all Logger to be updated against the specified Configuration.</em>
<a class="jxr_linenumber" name="237" href="#237">237</a> <em class="jxr_javadoccomment"> * @param config The Configuration.</em>
<a class="jxr_linenumber" name="238" href="#238">238</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="239" href="#239">239</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> updateLoggers(<a href="../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config) {
<a class="jxr_linenumber" name="240" href="#240">240</a> <strong class="jxr_keyword">for</strong> (Logger logger : loggers.values()) {
<a class="jxr_linenumber" name="241" href="#241">241</a> logger.updateConfiguration(config);
<a class="jxr_linenumber" name="242" href="#242">242</a> }
<a class="jxr_linenumber" name="243" href="#243">243</a> }
<a class="jxr_linenumber" name="244" href="#244">244</a>
<a class="jxr_linenumber" name="245" href="#245">245</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="246" href="#246">246</a> <em class="jxr_javadoccomment"> * Cause a reconfiguration to take place when the underlying configuration file changes.</em>
<a class="jxr_linenumber" name="247" href="#247">247</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="248" href="#248">248</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onChange() {
<a class="jxr_linenumber" name="249" href="#249">249</a> reconfigure();
<a class="jxr_linenumber" name="250" href="#250">250</a> }
<a class="jxr_linenumber" name="251" href="#251">251</a>
<a class="jxr_linenumber" name="252" href="#252">252</a>
<a class="jxr_linenumber" name="253" href="#253">253</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/logging/log4j/core/Logger.html">Logger</a> newInstance(<a href="../../../../../org/apache/logging/log4j/core/LoggerContext.html">LoggerContext</a> ctx, String name) {
<a class="jxr_linenumber" name="254" href="#254">254</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/logging/log4j/core/Logger.html">Logger</a>(ctx, name);
<a class="jxr_linenumber" name="255" href="#255">255</a> }
<a class="jxr_linenumber" name="256" href="#256">256</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>