| <!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>AsyncQueueFullPolicyFactory xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../../apidocs/org/apache/logging/log4j/core/async/AsyncQueueFullPolicyFactory.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.async; |
| <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> org.apache.logging.log4j.Level; |
| <a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.Logger; |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.util.Loader; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.status.StatusLogger; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.util.PropertiesUtil; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * Creates {@link AsyncQueueFullPolicy} instances based on user-specified system properties. The {@code AsyncQueueFullPolicy}</em> |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * created by this factory is used in AsyncLogger, AsyncLoggerConfig and AsyncAppender</em> |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * to control if events are logged in the current thread, the background thread, or discarded.</em> |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * Property {@code "log4j2.AsyncQueueFullPolicy"} controls the routing behaviour. If this property is not specified or has</em> |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * value {@code "Default"}, this factory creates {@link DefaultAsyncQueueFullPolicy} objects.</em> |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * </p> <p></em> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * If this property has value {@code "Discard"}, this factory creates {@link DiscardingAsyncQueueFullPolicy} objects.</em> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * By default, this router discards events of level {@code INFO}, {@code DEBUG} and {@code TRACE} if the queue is full.</em> |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * This can be adjusted with property {@code "log4j2.DiscardThreshold"} (name of the level at which to start</em> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * discarding).</em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * </p> <p></em> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * For any other value, this</em> |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * factory interprets the value as the fully qualified name of a class implementing the {@link AsyncQueueFullPolicy}</em> |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * interface. The class must have a default constructor.</em> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @since 2.6</em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncQueueFullPolicyFactory.html">AsyncQueueFullPolicyFactory</a> { |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PROPERTY_NAME_ASYNC_EVENT_ROUTER = <span class="jxr_string">"log4j2.AsyncQueueFullPolicy"</span>; |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PROPERTY_VALUE_DEFAULT_ASYNC_EVENT_ROUTER = <span class="jxr_string">"Default"</span>; |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PROPERTY_VALUE_DISCARDING_ASYNC_EVENT_ROUTER = <span class="jxr_string">"Discard"</span>; |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PROPERTY_NAME_DISCARDING_THRESHOLD_LEVEL = <span class="jxr_string">"log4j2.DiscardThreshold"</span>; |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = StatusLogger.getLogger(); |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * Creates and returns {@link AsyncQueueFullPolicy} instances based on user-specified system properties.</em> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * Property {@code "log4j2.AsyncQueueFullPolicy"} controls the routing behaviour. If this property is not specified or</em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * has value {@code "Default"}, this method returns {@link DefaultAsyncQueueFullPolicy} objects.</em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * </p> <p></em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * If this property has value {@code "Discard"}, this method returns {@link DiscardingAsyncQueueFullPolicy} objects.</em> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * </p> <p></em> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * For any other value, this method interprets the value as the fully qualified name of a class implementing the</em> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * {@link AsyncQueueFullPolicy} interface. The class must have a default constructor.</em> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * @return a new AsyncQueueFullPolicy</em> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncQueueFullPolicy.html">AsyncQueueFullPolicy</a> create() { |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">final</strong> String router = PropertiesUtil.getProperties().getStringProperty(PROPERTY_NAME_ASYNC_EVENT_ROUTER); |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">if</strong> (router == <strong class="jxr_keyword">null</strong> || isRouterSelected( |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> router, DefaultAsyncQueueFullPolicy.<strong class="jxr_keyword">class</strong>, PROPERTY_VALUE_DEFAULT_ASYNC_EVENT_ROUTER)) { |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/DefaultAsyncQueueFullPolicy.html">DefaultAsyncQueueFullPolicy</a>(); |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> } |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">if</strong> (isRouterSelected( |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> router, DiscardingAsyncQueueFullPolicy.<strong class="jxr_keyword">class</strong>, PROPERTY_VALUE_DISCARDING_ASYNC_EVENT_ROUTER)) { |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">return</strong> createDiscardingAsyncQueueFullPolicy(); |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> } |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">return</strong> createCustomRouter(router); |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> } |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isRouterSelected( |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> String propertyValue, |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> Class<? <strong class="jxr_keyword">extends</strong> AsyncQueueFullPolicy> policy, |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> String shortPropertyValue) { |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">return</strong> propertyValue != <strong class="jxr_keyword">null</strong> && (shortPropertyValue.equalsIgnoreCase(propertyValue) |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> || policy.getName().equals(propertyValue) |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> || policy.getSimpleName().equals(propertyValue)); |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> } |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncQueueFullPolicy.html">AsyncQueueFullPolicy</a> createCustomRouter(<strong class="jxr_keyword">final</strong> String router) { |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">final</strong> Class<? <strong class="jxr_keyword">extends</strong> AsyncQueueFullPolicy> cls = Loader.loadClass(router).asSubclass(AsyncQueueFullPolicy.<strong class="jxr_keyword">class</strong>); |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> LOGGER.debug(<span class="jxr_string">"Creating custom AsyncQueueFullPolicy '{}'"</span>, router); |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">return</strong> cls.newInstance(); |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> Exception ex) { |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> LOGGER.debug(<span class="jxr_string">"Using DefaultAsyncQueueFullPolicy. Could not create custom AsyncQueueFullPolicy '{}': {}"</span>, router, |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> ex.toString()); |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/DefaultAsyncQueueFullPolicy.html">DefaultAsyncQueueFullPolicy</a>(); |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> } |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> } |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncQueueFullPolicy.html">AsyncQueueFullPolicy</a> createDiscardingAsyncQueueFullPolicy() { |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">final</strong> PropertiesUtil util = PropertiesUtil.getProperties(); |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">final</strong> String level = util.getStringProperty(PROPERTY_NAME_DISCARDING_THRESHOLD_LEVEL, Level.INFO.name()); |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">final</strong> Level thresholdLevel = Level.toLevel(level, Level.INFO); |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> LOGGER.debug(<span class="jxr_string">"Creating custom DiscardingAsyncQueueFullPolicy(discardThreshold:{})"</span>, thresholdLevel); |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/DiscardingAsyncQueueFullPolicy.html">DiscardingAsyncQueueFullPolicy</a>(thresholdLevel); |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> } |
| <a class="jxr_linenumber" name="L108" href="#L108">108</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> |
