| <!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>AsyncAppender xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../../apidocs/org/apache/logging/log4j/core/appender/AsyncAppender.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.core.appender; |
| <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.ArrayList; |
| <a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.util.List; |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.BlockingQueue; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.TimeUnit; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.TransferQueue; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.atomic.AtomicLong; |
| <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.core.AbstractLogEvent; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.Appender; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.Core; |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.Filter; |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.LogEvent; |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.async.ArrayBlockingQueueFactory; |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.async.AsyncQueueFullMessageUtil; |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.async.AsyncQueueFullPolicy; |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.async.AsyncQueueFullPolicyFactory; |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.async.BlockingQueueFactory; |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.async.DiscardingAsyncQueueFullPolicy; |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.async.EventRoute; |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.async.InternalAsyncUtil; |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.AppenderControl; |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.AppenderRef; |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.Configuration; |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.ConfigurationException; |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.Property; |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.Plugin; |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginAliases; |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute; |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory; |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginConfiguration; |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginElement; |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.validation.constraints.Required; |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.filter.AbstractFilterable; |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.impl.Log4jLogEvent; |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.util.Log4jThread; |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.spi.AbstractLogger; |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * Appends to one or more Appenders asynchronously. You can configure an AsyncAppender with one or more Appenders and an</em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * Appender to append to if the queue is full. The AsyncAppender does not allow a filter to be specified on the Appender</em> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * references.</em> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> @Plugin(name = <span class="jxr_string">"Async"</span>, category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE, printObject = <strong class="jxr_keyword">true</strong>) |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/AsyncAppender.html">AsyncAppender</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.html">AbstractAppender</a> { |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_QUEUE_SIZE = 1024; |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> SHUTDOWN_LOG_EVENT = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/AbstractLogEvent.html">AbstractLogEvent</a>() { |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = -1761035149477086330L; |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> }; |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> AtomicLong THREAD_SEQUENCE = <strong class="jxr_keyword">new</strong> AtomicLong(1); |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> BlockingQueue<LogEvent> queue; |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> queueSize; |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> blocking; |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> shutdownTimeout; |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config; |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/AppenderRef.html">AppenderRef</a>[] appenderRefs; |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String errorRef; |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> includeLocation; |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/AppenderControl.html">AppenderControl</a> errorAppender; |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/AsyncAppender.html">AsyncThread</a> thread; |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncQueueFullPolicy.html">AsyncQueueFullPolicy</a> asyncQueueFullPolicy; |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/AsyncAppender.html">AsyncAppender</a>(<strong class="jxr_keyword">final</strong> String name, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/Filter.html">Filter</a> filter, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/AppenderRef.html">AppenderRef</a>[] appenderRefs, |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">final</strong> String errorRef, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> queueSize, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> blocking, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> ignoreExceptions, |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> shutdownTimeout, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> includeLocation, |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">final</strong> BlockingQueueFactory<LogEvent> blockingQueueFactory, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/Property.html">Property</a>[] properties) { |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">super</strong>(name, filter, <strong class="jxr_keyword">null</strong>, ignoreExceptions, properties); |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">this</strong>.queue = blockingQueueFactory.create(queueSize); |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">this</strong>.queueSize = queueSize; |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">this</strong>.blocking = blocking; |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">this</strong>.shutdownTimeout = shutdownTimeout; |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">this</strong>.config = config; |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">this</strong>.appenderRefs = appenderRefs; |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">this</strong>.errorRef = errorRef; |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">this</strong>.includeLocation = includeLocation; |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> } |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> @Override |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> start() { |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">final</strong> Map<String, Appender> map = config.getAppenders(); |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">final</strong> List<AppenderControl> appenders = <strong class="jxr_keyword">new</strong> ArrayList<>(); |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> AppenderRef appenderRef : appenderRefs) { |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/Appender.html">Appender</a> appender = map.get(appenderRef.getRef()); |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">if</strong> (appender != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> appenders.add(<strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/AppenderControl.html">AppenderControl</a>(appender, appenderRef.getLevel(), appenderRef.getFilter())); |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> LOGGER.error(<span class="jxr_string">"No appender named {} was configured"</span>, appenderRef); |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> } |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> } |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">if</strong> (errorRef != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/Appender.html">Appender</a> appender = map.get(errorRef); |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">if</strong> (appender != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> errorAppender = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/AppenderControl.html">AppenderControl</a>(appender, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>); |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> LOGGER.error(<span class="jxr_string">"Unable to set up error Appender. No appender named {} was configured"</span>, errorRef); |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> } |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> } |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">if</strong> (appenders.size() > 0) { |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> thread = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/AsyncAppender.html">AsyncThread</a>(appenders, queue); |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> thread.setName(<span class="jxr_string">"AsyncAppender-"</span> + getName()); |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (errorRef == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationException.html">ConfigurationException</a>(<span class="jxr_string">"No appenders are available for AsyncAppender "</span> + getName()); |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> } |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> asyncQueueFullPolicy = AsyncQueueFullPolicyFactory.create(); |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> thread.start(); |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">super</strong>.start(); |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> } |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> @Override |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> stop(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> timeout, <strong class="jxr_keyword">final</strong> TimeUnit timeUnit) { |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> setStopping(); |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">super</strong>.stop(timeout, timeUnit, false); |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> LOGGER.trace(<span class="jxr_string">"AsyncAppender stopping. Queue still has {} events."</span>, queue.size()); |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> thread.shutdown(); |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> thread.join(shutdownTimeout); |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> InterruptedException ex) { |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> LOGGER.warn(<span class="jxr_string">"Interrupted while stopping AsyncAppender {}"</span>, getName()); |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> } |
| <a class="jxr_linenumber" name="L142" href="#L142">142</a> LOGGER.trace(<span class="jxr_string">"AsyncAppender stopped. Queue has {} events."</span>, queue.size()); |
| <a class="jxr_linenumber" name="L143" href="#L143">143</a> |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">if</strong> (DiscardingAsyncQueueFullPolicy.getDiscardCount(asyncQueueFullPolicy) > 0) { |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> LOGGER.trace(<span class="jxr_string">"AsyncAppender: {} discarded {} events."</span>, asyncQueueFullPolicy, |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> DiscardingAsyncQueueFullPolicy.getDiscardCount(asyncQueueFullPolicy)); |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> } |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> setStopped(); |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> } |
| <a class="jxr_linenumber" name="L151" href="#L151">151</a> |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * Actual writing occurs here.</em> |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * @param logEvent The LogEvent.</em> |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> @Override |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> append(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> logEvent) { |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">if</strong> (!isStarted()) { |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"AsyncAppender "</span> + getName() + <span class="jxr_string">" is not active"</span>); |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> } |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/impl/Log4jLogEvent.html">Log4jLogEvent</a> memento = Log4jLogEvent.createMemento(logEvent, includeLocation); |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> InternalAsyncUtil.makeMessageImmutable(logEvent.getMessage()); |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">if</strong> (!transfer(memento)) { |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">if</strong> (blocking) { |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">if</strong> (AbstractLogger.getRecursionDepth() > 1) { <em class="jxr_comment">// LOG4J2-1518, LOG4J2-2031</em> |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_comment">// If queue is full AND we are in a recursive call, call appender directly to prevent deadlock</em> |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> AsyncQueueFullMessageUtil.logWarningToStatusLogger(); |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> logMessageInCurrentThread(logEvent); |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_comment">// delegate to the event router (which may discard, enqueue and block, or log in current thread)</em> |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/EventRoute.html">EventRoute</a> route = asyncQueueFullPolicy.getRoute(thread.getId(), memento.getLevel()); |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> route.logMessage(<strong class="jxr_keyword">this</strong>, memento); |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> } |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> error(<span class="jxr_string">"Appender "</span> + getName() + <span class="jxr_string">" is unable to write primary appenders. queue is full"</span>); |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> logToErrorAppenderIfNecessary(false, memento); |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> } |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> } |
| <a class="jxr_linenumber" name="L180" href="#L180">180</a> } |
| <a class="jxr_linenumber" name="L181" href="#L181">181</a> |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> transfer(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> memento) { |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">return</strong> queue instanceof TransferQueue |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> ? ((TransferQueue<LogEvent>) queue).tryTransfer(memento) |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> : queue.offer(memento); |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> } |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * FOR INTERNAL USE ONLY.</em> |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * @param logEvent the event to log</em> |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> logMessageInCurrentThread(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> logEvent) { |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> logEvent.setEndOfBatch(queue.isEmpty()); |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> appendSuccessful = thread.callAppenders(logEvent); |
| <a class="jxr_linenumber" name="L196" href="#L196">196</a> logToErrorAppenderIfNecessary(appendSuccessful, logEvent); |
| <a class="jxr_linenumber" name="L197" href="#L197">197</a> } |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * FOR INTERNAL USE ONLY.</em> |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * @param logEvent the event to log</em> |
| <a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> logMessageInBackgroundThread(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> logEvent) { |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_comment">// wait for free slots in the queue</em> |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> queue.put(logEvent); |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> InterruptedException e) { |
| <a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> appendSuccessful = handleInterruptedException(logEvent); |
| <a class="jxr_linenumber" name="L210" href="#L210">210</a> logToErrorAppenderIfNecessary(appendSuccessful, logEvent); |
| <a class="jxr_linenumber" name="L211" href="#L211">211</a> } |
| <a class="jxr_linenumber" name="L212" href="#L212">212</a> } |
| <a class="jxr_linenumber" name="L213" href="#L213">213</a> |
| <a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_comment">// LOG4J2-1049: Some applications use Thread.interrupt() to send</em> |
| <a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_comment">// messages between application threads. This does not necessarily</em> |
| <a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_comment">// mean that the queue is full. To prevent dropping a log message,</em> |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_comment">// quickly try to offer the event to the queue again.</em> |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_comment">// (Yes, this means there is a possibility the same event is logged twice.)</em> |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_comment">//</em> |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_comment">// Finally, catching the InterruptedException means the</em> |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_comment">// interrupted flag has been cleared on the current thread.</em> |
| <a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_comment">// This may interfere with the application's expectation of</em> |
| <a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_comment">// being interrupted, so when we are done, we set the interrupted</em> |
| <a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_comment">// flag again.</em> |
| <a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> handleInterruptedException(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> memento) { |
| <a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> appendSuccessful = queue.offer(memento); |
| <a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">if</strong> (!appendSuccessful) { |
| <a class="jxr_linenumber" name="L228" href="#L228">228</a> LOGGER.warn(<span class="jxr_string">"Interrupted while waiting for a free slot in the AsyncAppender LogEvent-queue {}"</span>, |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> getName()); |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> } |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_comment">// set the interrupted flag again.</em> |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> Thread.currentThread().interrupt(); |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">return</strong> appendSuccessful; |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> } |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> |
| <a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> logToErrorAppenderIfNecessary(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> appendSuccessful, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> logEvent) { |
| <a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">if</strong> (!appendSuccessful && errorAppender != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L238" href="#L238">238</a> errorAppender.callAppender(logEvent); |
| <a class="jxr_linenumber" name="L239" href="#L239">239</a> } |
| <a class="jxr_linenumber" name="L240" href="#L240">240</a> } |
| <a class="jxr_linenumber" name="L241" href="#L241">241</a> |
| <a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> * Create an AsyncAppender. This method is retained for backwards compatibility. New code should use the</em> |
| <a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> * {@link Builder} instead. This factory will use {@link ArrayBlockingQueueFactory} by default as was the behavior</em> |
| <a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> * pre-2.7.</em> |
| <a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * @param appenderRefs The Appenders to reference.</em> |
| <a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> * @param errorRef An optional Appender to write to if the queue is full or other errors occur.</em> |
| <a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> * @param blocking True if the Appender should wait when the queue is full. The default is true.</em> |
| <a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> * @param shutdownTimeout How many milliseconds the Appender should wait to flush outstanding log events</em> |
| <a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> * in the queue on shutdown. The default is zero which means to wait forever.</em> |
| <a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> * @param size The size of the event queue. The default is 128.</em> |
| <a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> * @param name The name of the Appender.</em> |
| <a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * @param includeLocation whether to include location information. The default is false.</em> |
| <a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * @param filter The Filter or null.</em> |
| <a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * @param config The Configuration.</em> |
| <a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * @param ignoreExceptions If {@code "true"} (default) exceptions encountered when appending events are logged;</em> |
| <a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * otherwise they are propagated to the caller.</em> |
| <a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> * @return The AsyncAppender.</em> |
| <a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> * @deprecated use {@link Builder} instead</em> |
| <a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L262" href="#L262">262</a> @Deprecated |
| <a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/AsyncAppender.html">AsyncAppender</a> createAppender(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/AppenderRef.html">AppenderRef</a>[] appenderRefs, <strong class="jxr_keyword">final</strong> String errorRef, |
| <a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> blocking, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> shutdownTimeout, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> size, |
| <a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong class="jxr_keyword">final</strong> String name, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> includeLocation, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/Filter.html">Filter</a> filter, |
| <a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> ignoreExceptions) { |
| <a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L268" href="#L268">268</a> LOGGER.error(<span class="jxr_string">"No name provided for AsyncAppender"</span>); |
| <a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L270" href="#L270">270</a> } |
| <a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">if</strong> (appenderRefs == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L272" href="#L272">272</a> LOGGER.error(<span class="jxr_string">"No appender references provided to AsyncAppender {}"</span>, name); |
| <a class="jxr_linenumber" name="L273" href="#L273">273</a> } |
| <a class="jxr_linenumber" name="L274" href="#L274">274</a> |
| <a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/AsyncAppender.html">AsyncAppender</a>(name, filter, appenderRefs, errorRef, size, blocking, ignoreExceptions, |
| <a class="jxr_linenumber" name="L276" href="#L276">276</a> shutdownTimeout, config, includeLocation, <strong class="jxr_keyword">new</strong> ArrayBlockingQueueFactory<LogEvent>(), <strong class="jxr_keyword">null</strong>); |
| <a class="jxr_linenumber" name="L277" href="#L277">277</a> } |
| <a class="jxr_linenumber" name="L278" href="#L278">278</a> |
| <a class="jxr_linenumber" name="L279" href="#L279">279</a> @PluginBuilderFactory |
| <a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/logging/log4j/core/filter/DenyAllFilter.html">Builder</a> newBuilder() { |
| <a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/filter/DenyAllFilter.html">Builder</a>(); |
| <a class="jxr_linenumber" name="L282" href="#L282">282</a> } |
| <a class="jxr_linenumber" name="L283" href="#L283">283</a> |
| <a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> Builder<B <strong class="jxr_keyword">extends</strong> Builder<B>> <strong class="jxr_keyword">extends</strong> AbstractFilterable.Builder<B> |
| <a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">implements</strong> org.apache.logging.log4j.core.util.Builder<AsyncAppender> { |
| <a class="jxr_linenumber" name="L286" href="#L286">286</a> |
| <a class="jxr_linenumber" name="L287" href="#L287">287</a> @PluginElement(<span class="jxr_string">"AppenderRef"</span>) |
| <a class="jxr_linenumber" name="L288" href="#L288">288</a> @Required(message = <span class="jxr_string">"No appender references provided to AsyncAppender"</span>) |
| <a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/AppenderRef.html">AppenderRef</a>[] appenderRefs; |
| <a class="jxr_linenumber" name="L290" href="#L290">290</a> |
| <a class="jxr_linenumber" name="L291" href="#L291">291</a> @PluginBuilderAttribute |
| <a class="jxr_linenumber" name="L292" href="#L292">292</a> @PluginAliases(<span class="jxr_string">"error-ref"</span>) |
| <a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">private</strong> String errorRef; |
| <a class="jxr_linenumber" name="L294" href="#L294">294</a> |
| <a class="jxr_linenumber" name="L295" href="#L295">295</a> @PluginBuilderAttribute |
| <a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> blocking = <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L297" href="#L297">297</a> |
| <a class="jxr_linenumber" name="L298" href="#L298">298</a> @PluginBuilderAttribute |
| <a class="jxr_linenumber" name="L299" href="#L299">299</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">long</strong> shutdownTimeout = 0L; |
| <a class="jxr_linenumber" name="L300" href="#L300">300</a> |
| <a class="jxr_linenumber" name="L301" href="#L301">301</a> @PluginBuilderAttribute |
| <a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> bufferSize = DEFAULT_QUEUE_SIZE; |
| <a class="jxr_linenumber" name="L303" href="#L303">303</a> |
| <a class="jxr_linenumber" name="L304" href="#L304">304</a> @PluginBuilderAttribute |
| <a class="jxr_linenumber" name="L305" href="#L305">305</a> @Required(message = <span class="jxr_string">"No name provided for AsyncAppender"</span>) |
| <a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">private</strong> String name; |
| <a class="jxr_linenumber" name="L307" href="#L307">307</a> |
| <a class="jxr_linenumber" name="L308" href="#L308">308</a> @PluginBuilderAttribute |
| <a class="jxr_linenumber" name="L309" href="#L309">309</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> includeLocation = false; |
| <a class="jxr_linenumber" name="L310" href="#L310">310</a> |
| <a class="jxr_linenumber" name="L311" href="#L311">311</a> @PluginConfiguration |
| <a class="jxr_linenumber" name="L312" href="#L312">312</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> configuration; |
| <a class="jxr_linenumber" name="L313" href="#L313">313</a> |
| <a class="jxr_linenumber" name="L314" href="#L314">314</a> @PluginBuilderAttribute |
| <a class="jxr_linenumber" name="L315" href="#L315">315</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> ignoreExceptions = <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L316" href="#L316">316</a> |
| <a class="jxr_linenumber" name="L317" href="#L317">317</a> @PluginElement(BlockingQueueFactory.ELEMENT_TYPE) |
| <a class="jxr_linenumber" name="L318" href="#L318">318</a> <strong class="jxr_keyword">private</strong> BlockingQueueFactory<LogEvent> blockingQueueFactory = <strong class="jxr_keyword">new</strong> ArrayBlockingQueueFactory<>(); |
| <a class="jxr_linenumber" name="L319" href="#L319">319</a> |
| <a class="jxr_linenumber" name="L320" href="#L320">320</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/filter/DenyAllFilter.html">Builder</a> setAppenderRefs(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/AppenderRef.html">AppenderRef</a>[] appenderRefs) { |
| <a class="jxr_linenumber" name="L321" href="#L321">321</a> <strong class="jxr_keyword">this</strong>.appenderRefs = appenderRefs; |
| <a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a class="jxr_linenumber" name="L323" href="#L323">323</a> } |
| <a class="jxr_linenumber" name="L324" href="#L324">324</a> |
| <a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/filter/DenyAllFilter.html">Builder</a> setErrorRef(<strong class="jxr_keyword">final</strong> String errorRef) { |
| <a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong class="jxr_keyword">this</strong>.errorRef = errorRef; |
| <a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a class="jxr_linenumber" name="L328" href="#L328">328</a> } |
| <a class="jxr_linenumber" name="L329" href="#L329">329</a> |
| <a class="jxr_linenumber" name="L330" href="#L330">330</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/filter/DenyAllFilter.html">Builder</a> setBlocking(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> blocking) { |
| <a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">this</strong>.blocking = blocking; |
| <a class="jxr_linenumber" name="L332" href="#L332">332</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a class="jxr_linenumber" name="L333" href="#L333">333</a> } |
| <a class="jxr_linenumber" name="L334" href="#L334">334</a> |
| <a class="jxr_linenumber" name="L335" href="#L335">335</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/filter/DenyAllFilter.html">Builder</a> setShutdownTimeout(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> shutdownTimeout) { |
| <a class="jxr_linenumber" name="L336" href="#L336">336</a> <strong class="jxr_keyword">this</strong>.shutdownTimeout = shutdownTimeout; |
| <a class="jxr_linenumber" name="L337" href="#L337">337</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a class="jxr_linenumber" name="L338" href="#L338">338</a> } |
| <a class="jxr_linenumber" name="L339" href="#L339">339</a> |
| <a class="jxr_linenumber" name="L340" href="#L340">340</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/filter/DenyAllFilter.html">Builder</a> setBufferSize(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> bufferSize) { |
| <a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong class="jxr_keyword">this</strong>.bufferSize = bufferSize; |
| <a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a class="jxr_linenumber" name="L343" href="#L343">343</a> } |
| <a class="jxr_linenumber" name="L344" href="#L344">344</a> |
| <a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/filter/DenyAllFilter.html">Builder</a> setName(<strong class="jxr_keyword">final</strong> String name) { |
| <a class="jxr_linenumber" name="L346" href="#L346">346</a> <strong class="jxr_keyword">this</strong>.name = name; |
| <a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a class="jxr_linenumber" name="L348" href="#L348">348</a> } |
| <a class="jxr_linenumber" name="L349" href="#L349">349</a> |
| <a class="jxr_linenumber" name="L350" href="#L350">350</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/filter/DenyAllFilter.html">Builder</a> setIncludeLocation(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> includeLocation) { |
| <a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">this</strong>.includeLocation = includeLocation; |
| <a class="jxr_linenumber" name="L352" href="#L352">352</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a class="jxr_linenumber" name="L353" href="#L353">353</a> } |
| <a class="jxr_linenumber" name="L354" href="#L354">354</a> |
| <a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/filter/DenyAllFilter.html">Builder</a> setConfiguration(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> configuration) { |
| <a class="jxr_linenumber" name="L356" href="#L356">356</a> <strong class="jxr_keyword">this</strong>.configuration = configuration; |
| <a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a class="jxr_linenumber" name="L358" href="#L358">358</a> } |
| <a class="jxr_linenumber" name="L359" href="#L359">359</a> |
| <a class="jxr_linenumber" name="L360" href="#L360">360</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/filter/DenyAllFilter.html">Builder</a> setIgnoreExceptions(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> ignoreExceptions) { |
| <a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">this</strong>.ignoreExceptions = ignoreExceptions; |
| <a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a class="jxr_linenumber" name="L363" href="#L363">363</a> } |
| <a class="jxr_linenumber" name="L364" href="#L364">364</a> |
| <a class="jxr_linenumber" name="L365" href="#L365">365</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/filter/DenyAllFilter.html">Builder</a> setBlockingQueueFactory(<strong class="jxr_keyword">final</strong> BlockingQueueFactory<LogEvent> blockingQueueFactory) { |
| <a class="jxr_linenumber" name="L366" href="#L366">366</a> <strong class="jxr_keyword">this</strong>.blockingQueueFactory = blockingQueueFactory; |
| <a class="jxr_linenumber" name="L367" href="#L367">367</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a class="jxr_linenumber" name="L368" href="#L368">368</a> } |
| <a class="jxr_linenumber" name="L369" href="#L369">369</a> |
| <a class="jxr_linenumber" name="L370" href="#L370">370</a> @Override |
| <a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/AsyncAppender.html">AsyncAppender</a> build() { |
| <a class="jxr_linenumber" name="L372" href="#L372">372</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/AsyncAppender.html">AsyncAppender</a>(name, getFilter(), appenderRefs, errorRef, bufferSize, blocking, ignoreExceptions, |
| <a class="jxr_linenumber" name="L373" href="#L373">373</a> shutdownTimeout, configuration, includeLocation, blockingQueueFactory, getPropertyArray()); |
| <a class="jxr_linenumber" name="L374" href="#L374">374</a> } |
| <a class="jxr_linenumber" name="L375" href="#L375">375</a> } |
| <a class="jxr_linenumber" name="L376" href="#L376">376</a> |
| <a class="jxr_linenumber" name="L377" href="#L377">377</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L378" href="#L378">378</a> <em class="jxr_javadoccomment"> * Thread that calls the Appenders.</em> |
| <a class="jxr_linenumber" name="L379" href="#L379">379</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L380" href="#L380">380</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/AsyncAppender.html">AsyncThread</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/logging/log4j/core/util/Log4jThread.html">Log4jThread</a> { |
| <a class="jxr_linenumber" name="L381" href="#L381">381</a> |
| <a class="jxr_linenumber" name="L382" href="#L382">382</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">volatile</strong> <strong class="jxr_keyword">boolean</strong> shutdown = false; |
| <a class="jxr_linenumber" name="L383" href="#L383">383</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List<AppenderControl> appenders; |
| <a class="jxr_linenumber" name="L384" href="#L384">384</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> BlockingQueue<LogEvent> queue; |
| <a class="jxr_linenumber" name="L385" href="#L385">385</a> |
| <a class="jxr_linenumber" name="L386" href="#L386">386</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/AsyncAppender.html">AsyncThread</a>(<strong class="jxr_keyword">final</strong> List<AppenderControl> appenders, <strong class="jxr_keyword">final</strong> BlockingQueue<LogEvent> queue) { |
| <a class="jxr_linenumber" name="L387" href="#L387">387</a> <strong class="jxr_keyword">super</strong>(<span class="jxr_string">"AsyncAppender-"</span> + THREAD_SEQUENCE.getAndIncrement()); |
| <a class="jxr_linenumber" name="L388" href="#L388">388</a> <strong class="jxr_keyword">this</strong>.appenders = appenders; |
| <a class="jxr_linenumber" name="L389" href="#L389">389</a> <strong class="jxr_keyword">this</strong>.queue = queue; |
| <a class="jxr_linenumber" name="L390" href="#L390">390</a> setDaemon(<strong class="jxr_keyword">true</strong>); |
| <a class="jxr_linenumber" name="L391" href="#L391">391</a> } |
| <a class="jxr_linenumber" name="L392" href="#L392">392</a> |
| <a class="jxr_linenumber" name="L393" href="#L393">393</a> @Override |
| <a class="jxr_linenumber" name="L394" href="#L394">394</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> run() { |
| <a class="jxr_linenumber" name="L395" href="#L395">395</a> <strong class="jxr_keyword">while</strong> (!shutdown) { |
| <a class="jxr_linenumber" name="L396" href="#L396">396</a> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event; |
| <a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L398" href="#L398">398</a> event = queue.take(); |
| <a class="jxr_linenumber" name="L399" href="#L399">399</a> <strong class="jxr_keyword">if</strong> (event == SHUTDOWN_LOG_EVENT) { |
| <a class="jxr_linenumber" name="L400" href="#L400">400</a> shutdown = <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong class="jxr_keyword">continue</strong>; |
| <a class="jxr_linenumber" name="L402" href="#L402">402</a> } |
| <a class="jxr_linenumber" name="L403" href="#L403">403</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> InterruptedException ex) { |
| <a class="jxr_linenumber" name="L404" href="#L404">404</a> <strong class="jxr_keyword">break</strong>; <em class="jxr_comment">// LOG4J2-830</em> |
| <a class="jxr_linenumber" name="L405" href="#L405">405</a> } |
| <a class="jxr_linenumber" name="L406" href="#L406">406</a> event.setEndOfBatch(queue.isEmpty()); |
| <a class="jxr_linenumber" name="L407" href="#L407">407</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> success = callAppenders(event); |
| <a class="jxr_linenumber" name="L408" href="#L408">408</a> <strong class="jxr_keyword">if</strong> (!success && errorAppender != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L409" href="#L409">409</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L410" href="#L410">410</a> errorAppender.callAppender(event); |
| <a class="jxr_linenumber" name="L411" href="#L411">411</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> Exception ex) { |
| <a class="jxr_linenumber" name="L412" href="#L412">412</a> <em class="jxr_comment">// Silently accept the error.</em> |
| <a class="jxr_linenumber" name="L413" href="#L413">413</a> } |
| <a class="jxr_linenumber" name="L414" href="#L414">414</a> } |
| <a class="jxr_linenumber" name="L415" href="#L415">415</a> } |
| <a class="jxr_linenumber" name="L416" href="#L416">416</a> <em class="jxr_comment">// Process any remaining items in the queue.</em> |
| <a class="jxr_linenumber" name="L417" href="#L417">417</a> LOGGER.trace(<span class="jxr_string">"AsyncAppender.AsyncThread shutting down. Processing remaining {} queue events."</span>, |
| <a class="jxr_linenumber" name="L418" href="#L418">418</a> queue.size()); |
| <a class="jxr_linenumber" name="L419" href="#L419">419</a> <strong class="jxr_keyword">int</strong> count = 0; |
| <a class="jxr_linenumber" name="L420" href="#L420">420</a> <strong class="jxr_keyword">int</strong> ignored = 0; |
| <a class="jxr_linenumber" name="L421" href="#L421">421</a> <strong class="jxr_keyword">while</strong> (!queue.isEmpty()) { |
| <a class="jxr_linenumber" name="L422" href="#L422">422</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L423" href="#L423">423</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event = queue.take(); |
| <a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">if</strong> (event instanceof Log4jLogEvent) { |
| <a class="jxr_linenumber" name="L425" href="#L425">425</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/impl/Log4jLogEvent.html">Log4jLogEvent</a> logEvent = (Log4jLogEvent) event; |
| <a class="jxr_linenumber" name="L426" href="#L426">426</a> logEvent.setEndOfBatch(queue.isEmpty()); |
| <a class="jxr_linenumber" name="L427" href="#L427">427</a> callAppenders(logEvent); |
| <a class="jxr_linenumber" name="L428" href="#L428">428</a> count++; |
| <a class="jxr_linenumber" name="L429" href="#L429">429</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L430" href="#L430">430</a> ignored++; |
| <a class="jxr_linenumber" name="L431" href="#L431">431</a> LOGGER.trace(<span class="jxr_string">"Ignoring event of class {}"</span>, event.getClass().getName()); |
| <a class="jxr_linenumber" name="L432" href="#L432">432</a> } |
| <a class="jxr_linenumber" name="L433" href="#L433">433</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> InterruptedException ex) { |
| <a class="jxr_linenumber" name="L434" href="#L434">434</a> <em class="jxr_comment">// May have been interrupted to shut down.</em> |
| <a class="jxr_linenumber" name="L435" href="#L435">435</a> <em class="jxr_comment">// Here we ignore interrupts and try to process all remaining events.</em> |
| <a class="jxr_linenumber" name="L436" href="#L436">436</a> } |
| <a class="jxr_linenumber" name="L437" href="#L437">437</a> } |
| <a class="jxr_linenumber" name="L438" href="#L438">438</a> LOGGER.trace(<span class="jxr_string">"AsyncAppender.AsyncThread stopped. Queue has {} events remaining. "</span> |
| <a class="jxr_linenumber" name="L439" href="#L439">439</a> + <span class="jxr_string">"Processed {} and ignored {} events since shutdown started."</span>, queue.size(), count, ignored); |
| <a class="jxr_linenumber" name="L440" href="#L440">440</a> } |
| <a class="jxr_linenumber" name="L441" href="#L441">441</a> |
| <a class="jxr_linenumber" name="L442" href="#L442">442</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L443" href="#L443">443</a> <em class="jxr_javadoccomment"> * Calls {@link AppenderControl#callAppender(LogEvent) callAppender} on all registered {@code AppenderControl}</em> |
| <a class="jxr_linenumber" name="L444" href="#L444">444</a> <em class="jxr_javadoccomment"> * objects, and returns {@code true} if at least one appender call was successful, {@code false} otherwise. Any</em> |
| <a class="jxr_linenumber" name="L445" href="#L445">445</a> <em class="jxr_javadoccomment"> * exceptions are silently ignored.</em> |
| <a class="jxr_linenumber" name="L446" href="#L446">446</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L447" href="#L447">447</a> <em class="jxr_javadoccomment"> * @param event the event to forward to the registered appenders</em> |
| <a class="jxr_linenumber" name="L448" href="#L448">448</a> <em class="jxr_javadoccomment"> * @return {@code true} if at least one appender call succeeded, {@code false} otherwise</em> |
| <a class="jxr_linenumber" name="L449" href="#L449">449</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L450" href="#L450">450</a> <strong class="jxr_keyword">boolean</strong> callAppenders(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event) { |
| <a class="jxr_linenumber" name="L451" href="#L451">451</a> <strong class="jxr_keyword">boolean</strong> success = false; |
| <a class="jxr_linenumber" name="L452" href="#L452">452</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> AppenderControl control : appenders) { |
| <a class="jxr_linenumber" name="L453" href="#L453">453</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L454" href="#L454">454</a> control.callAppender(event); |
| <a class="jxr_linenumber" name="L455" href="#L455">455</a> success = <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L456" href="#L456">456</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> Exception ex) { |
| <a class="jxr_linenumber" name="L457" href="#L457">457</a> <em class="jxr_comment">// If no appender is successful the error appender will get it.</em> |
| <a class="jxr_linenumber" name="L458" href="#L458">458</a> } |
| <a class="jxr_linenumber" name="L459" href="#L459">459</a> } |
| <a class="jxr_linenumber" name="L460" href="#L460">460</a> <strong class="jxr_keyword">return</strong> success; |
| <a class="jxr_linenumber" name="L461" href="#L461">461</a> } |
| <a class="jxr_linenumber" name="L462" href="#L462">462</a> |
| <a class="jxr_linenumber" name="L463" href="#L463">463</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> shutdown() { |
| <a class="jxr_linenumber" name="L464" href="#L464">464</a> shutdown = <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L465" href="#L465">465</a> <strong class="jxr_keyword">if</strong> (queue.isEmpty()) { |
| <a class="jxr_linenumber" name="L466" href="#L466">466</a> queue.offer(SHUTDOWN_LOG_EVENT); |
| <a class="jxr_linenumber" name="L467" href="#L467">467</a> } |
| <a class="jxr_linenumber" name="L468" href="#L468">468</a> <strong class="jxr_keyword">if</strong> (getState() == State.TIMED_WAITING || getState() == State.WAITING) { |
| <a class="jxr_linenumber" name="L469" href="#L469">469</a> <strong class="jxr_keyword">this</strong>.interrupt(); <em class="jxr_comment">// LOG4J2-1422: if underlying appender is stuck in wait/sleep/join/park call</em> |
| <a class="jxr_linenumber" name="L470" href="#L470">470</a> } |
| <a class="jxr_linenumber" name="L471" href="#L471">471</a> } |
| <a class="jxr_linenumber" name="L472" href="#L472">472</a> } |
| <a class="jxr_linenumber" name="L473" href="#L473">473</a> |
| <a class="jxr_linenumber" name="L474" href="#L474">474</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L475" href="#L475">475</a> <em class="jxr_javadoccomment"> * Returns the names of the appenders that this asyncAppender delegates to as an array of Strings.</em> |
| <a class="jxr_linenumber" name="L476" href="#L476">476</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L477" href="#L477">477</a> <em class="jxr_javadoccomment"> * @return the names of the sink appenders</em> |
| <a class="jxr_linenumber" name="L478" href="#L478">478</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L479" href="#L479">479</a> <strong class="jxr_keyword">public</strong> String[] getAppenderRefStrings() { |
| <a class="jxr_linenumber" name="L480" href="#L480">480</a> <strong class="jxr_keyword">final</strong> String[] result = <strong class="jxr_keyword">new</strong> String[appenderRefs.length]; |
| <a class="jxr_linenumber" name="L481" href="#L481">481</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < result.length; i++) { |
| <a class="jxr_linenumber" name="L482" href="#L482">482</a> result[i] = appenderRefs[i].getRef(); |
| <a class="jxr_linenumber" name="L483" href="#L483">483</a> } |
| <a class="jxr_linenumber" name="L484" href="#L484">484</a> <strong class="jxr_keyword">return</strong> result; |
| <a class="jxr_linenumber" name="L485" href="#L485">485</a> } |
| <a class="jxr_linenumber" name="L486" href="#L486">486</a> |
| <a class="jxr_linenumber" name="L487" href="#L487">487</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L488" href="#L488">488</a> <em class="jxr_javadoccomment"> * Returns {@code true} if this AsyncAppender will take a snapshot of the stack with every log event to determine</em> |
| <a class="jxr_linenumber" name="L489" href="#L489">489</a> <em class="jxr_javadoccomment"> * the class and method where the logging call was made.</em> |
| <a class="jxr_linenumber" name="L490" href="#L490">490</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L491" href="#L491">491</a> <em class="jxr_javadoccomment"> * @return {@code true} if location is included with every event, {@code false} otherwise</em> |
| <a class="jxr_linenumber" name="L492" href="#L492">492</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L493" href="#L493">493</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isIncludeLocation() { |
| <a class="jxr_linenumber" name="L494" href="#L494">494</a> <strong class="jxr_keyword">return</strong> includeLocation; |
| <a class="jxr_linenumber" name="L495" href="#L495">495</a> } |
| <a class="jxr_linenumber" name="L496" href="#L496">496</a> |
| <a class="jxr_linenumber" name="L497" href="#L497">497</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L498" href="#L498">498</a> <em class="jxr_javadoccomment"> * Returns {@code true} if this AsyncAppender will block when the queue is full, or {@code false} if events are</em> |
| <a class="jxr_linenumber" name="L499" href="#L499">499</a> <em class="jxr_javadoccomment"> * dropped when the queue is full.</em> |
| <a class="jxr_linenumber" name="L500" href="#L500">500</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L501" href="#L501">501</a> <em class="jxr_javadoccomment"> * @return whether this AsyncAppender will block or drop events when the queue is full.</em> |
| <a class="jxr_linenumber" name="L502" href="#L502">502</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L503" href="#L503">503</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isBlocking() { |
| <a class="jxr_linenumber" name="L504" href="#L504">504</a> <strong class="jxr_keyword">return</strong> blocking; |
| <a class="jxr_linenumber" name="L505" href="#L505">505</a> } |
| <a class="jxr_linenumber" name="L506" href="#L506">506</a> |
| <a class="jxr_linenumber" name="L507" href="#L507">507</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L508" href="#L508">508</a> <em class="jxr_javadoccomment"> * Returns the name of the appender that any errors are logged to or {@code null}.</em> |
| <a class="jxr_linenumber" name="L509" href="#L509">509</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L510" href="#L510">510</a> <em class="jxr_javadoccomment"> * @return the name of the appender that any errors are logged to or {@code null}</em> |
| <a class="jxr_linenumber" name="L511" href="#L511">511</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L512" href="#L512">512</a> <strong class="jxr_keyword">public</strong> String getErrorRef() { |
| <a class="jxr_linenumber" name="L513" href="#L513">513</a> <strong class="jxr_keyword">return</strong> errorRef; |
| <a class="jxr_linenumber" name="L514" href="#L514">514</a> } |
| <a class="jxr_linenumber" name="L515" href="#L515">515</a> |
| <a class="jxr_linenumber" name="L516" href="#L516">516</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getQueueCapacity() { |
| <a class="jxr_linenumber" name="L517" href="#L517">517</a> <strong class="jxr_keyword">return</strong> queueSize; |
| <a class="jxr_linenumber" name="L518" href="#L518">518</a> } |
| <a class="jxr_linenumber" name="L519" href="#L519">519</a> |
| <a class="jxr_linenumber" name="L520" href="#L520">520</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getQueueRemainingCapacity() { |
| <a class="jxr_linenumber" name="L521" href="#L521">521</a> <strong class="jxr_keyword">return</strong> queue.remainingCapacity(); |
| <a class="jxr_linenumber" name="L522" href="#L522">522</a> } |
| <a class="jxr_linenumber" name="L523" href="#L523">523</a> |
| <a class="jxr_linenumber" name="L524" href="#L524">524</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L525" href="#L525">525</a> <em class="jxr_javadoccomment"> * Returns the number of elements in the queue.</em> |
| <a class="jxr_linenumber" name="L526" href="#L526">526</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L527" href="#L527">527</a> <em class="jxr_javadoccomment"> * @return the number of elements in the queue.</em> |
| <a class="jxr_linenumber" name="L528" href="#L528">528</a> <em class="jxr_javadoccomment"> * @since 2.11.1</em> |
| <a class="jxr_linenumber" name="L529" href="#L529">529</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L530" href="#L530">530</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getQueueSize() { |
| <a class="jxr_linenumber" name="L531" href="#L531">531</a> <strong class="jxr_keyword">return</strong> queue.size(); |
| <a class="jxr_linenumber" name="L532" href="#L532">532</a> } |
| <a class="jxr_linenumber" name="L533" href="#L533">533</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> |
