Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.2 / log4j-core / xref / org / apache / logging / log4j / core / appender / rolling / action / IfAccumulatedFileCount.html
blob: f3e58eaea5b848123581fe174f5b9d06e1b31d3d [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>IfAccumulatedFileCount 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/rolling/action/IfAccumulatedFileCount.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.rolling.action;
<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.nio.file.Path;
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.nio.file.attribute.BasicFileAttributes;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.util.Arrays;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.Collections;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="L24" href="#L24">24</a>
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.Logger;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.Core;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.Plugin;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginAttribute;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginElement;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginFactory;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.status.StatusLogger;
<a class="jxr_linenumber" name="L32" href="#L32">32</a>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * PathCondition that accepts paths after some count threshold is exceeded during the file tree walk.</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> @Plugin(name = <span class="jxr_string">"IfAccumulatedFileCount"</span>, category = Core.CATEGORY_NAME, printObject = <strong class="jxr_keyword">true</strong>)
<a class="jxr_linenumber" name="L37" href="#L37">37</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/rolling/action/IfAccumulatedFileCount.html">IfAccumulatedFileCount</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PathCondition.html">PathCondition</a> {
<a class="jxr_linenumber" name="L38" href="#L38">38</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/Logger.html">Logger</a> LOGGER = StatusLogger.getLogger();
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> threshold;
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> count;
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PathCondition.html">PathCondition</a>[] nestedConditions;
<a class="jxr_linenumber" name="L42" href="#L42">42</a>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/IfAccumulatedFileCount.html">IfAccumulatedFileCount</a>(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> thresholdParam, <strong class="jxr_keyword">final</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PathCondition.html">PathCondition</a>[] nestedConditions) {
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">if</strong> (thresholdParam &lt;= 0) {
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Count must be a positive integer but was "</span> + thresholdParam);
<a class="jxr_linenumber" name="L46" href="#L46">46</a> }
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">this</strong>.threshold = thresholdParam;
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">this</strong>.nestedConditions = nestedConditions == <strong class="jxr_keyword">null</strong> ? <strong class="jxr_keyword">new</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PathCondition.html">PathCondition</a>[0] : Arrays.copyOf(nestedConditions,
<a class="jxr_linenumber" name="L49" href="#L49">49</a> nestedConditions.length);
<a class="jxr_linenumber" name="L50" href="#L50">50</a> }
<a class="jxr_linenumber" name="L51" href="#L51">51</a>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getThresholdCount() {
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">return</strong> threshold;
<a class="jxr_linenumber" name="L54" href="#L54">54</a> }
<a class="jxr_linenumber" name="L55" href="#L55">55</a>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">public</strong> List&lt;PathCondition&gt; getNestedConditions() {
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">return</strong> Collections.unmodifiableList(Arrays.asList(nestedConditions));
<a class="jxr_linenumber" name="L58" href="#L58">58</a> }
<a class="jxr_linenumber" name="L59" href="#L59">59</a>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_comment"> * (non-Javadoc)</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_comment"> * @see org.apache.logging.log4j.core.appender.rolling.action.PathCondition#accept(java.nio.file.Path,</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_comment"> * java.nio.file.Path, java.nio.file.attribute.BasicFileAttributes)</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> @Override
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> accept(<strong class="jxr_keyword">final</strong> Path basePath, <strong class="jxr_keyword">final</strong> Path relativePath, <strong class="jxr_keyword">final</strong> BasicFileAttributes attrs) {
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> result = ++count &gt; threshold;
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">final</strong> String match = result ? <span class="jxr_string">"&gt;"</span> : <span class="jxr_string">"&lt;="</span>;
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">final</strong> String accept = result ? <span class="jxr_string">"ACCEPTED"</span> : <span class="jxr_string">"REJECTED"</span>;
<a class="jxr_linenumber" name="L71" href="#L71">71</a> LOGGER.trace(<span class="jxr_string">"IfAccumulatedFileCount {}: {} count '{}' {} threshold '{}'"</span>, accept, relativePath, count, match,
<a class="jxr_linenumber" name="L72" href="#L72">72</a> threshold);
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">if</strong> (result) {
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">return</strong> IfAll.accept(nestedConditions, basePath, relativePath, attrs);
<a class="jxr_linenumber" name="L75" href="#L75">75</a> }
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">return</strong> result;
<a class="jxr_linenumber" name="L77" href="#L77">77</a> }
<a class="jxr_linenumber" name="L78" href="#L78">78</a>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_comment"> * (non-Javadoc)</em>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_comment"> * @see org.apache.logging.log4j.core.appender.rolling.action.PathCondition#beforeFileTreeWalk()</em>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L84" href="#L84">84</a> @Override
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> beforeFileTreeWalk() {
<a class="jxr_linenumber" name="L86" href="#L86">86</a> count = 0;
<a class="jxr_linenumber" name="L87" href="#L87">87</a> IfAll.beforeFileTreeWalk(nestedConditions);
<a class="jxr_linenumber" name="L88" href="#L88">88</a> }
<a class="jxr_linenumber" name="L89" href="#L89">89</a>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * Create an IfAccumulatedFileCount condition.</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * @param threshold The threshold count from which files will be deleted.</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @return An IfAccumulatedFileCount condition.</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L96" href="#L96">96</a> @PluginFactory
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/IfAccumulatedFileCount.html">IfAccumulatedFileCount</a> createFileCountCondition(
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_comment">// @formatter:off</em>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> @PluginAttribute(value = <span class="jxr_string">"exceeds"</span>, defaultInt = Integer.MAX_VALUE) <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> threshold,
<a class="jxr_linenumber" name="L100" href="#L100">100</a> @PluginElement(<span class="jxr_string">"PathConditions"</span>) <strong class="jxr_keyword">final</strong> PathCondition... nestedConditions) {
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_comment">// @formatter:on</em>
<a class="jxr_linenumber" name="L102" href="#L102">102</a>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">if</strong> (threshold == Integer.MAX_VALUE) {
<a class="jxr_linenumber" name="L104" href="#L104">104</a> LOGGER.error(<span class="jxr_string">"IfAccumulatedFileCount invalid or missing threshold value."</span>);
<a class="jxr_linenumber" name="L105" href="#L105">105</a> }
<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/appender/rolling/action/IfAccumulatedFileCount.html">IfAccumulatedFileCount</a>(threshold, nestedConditions);
<a class="jxr_linenumber" name="L107" href="#L107">107</a> }
<a class="jxr_linenumber" name="L108" href="#L108">108</a>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> @Override
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">public</strong> String toString() {
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">final</strong> String nested = nestedConditions.length == 0 ? <span class="jxr_string">""</span> : <span class="jxr_string">" AND "</span> + Arrays.toString(nestedConditions);
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"IfAccumulatedFileCount(exceeds="</span> + threshold + nested + <span class="jxr_string">")"</span>;
<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
<a class="jxr_linenumber" name="L114" href="#L114">114</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 1999&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>