| <!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>DefaultRolloverStrategy 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/DefaultRolloverStrategy.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; |
| <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.io.File; |
| <a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.io.IOException; |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.nio.file.Files; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.nio.file.Path; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.Arrays; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Collections; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.List; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.SortedMap; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.TimeUnit; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.util.zip.Deflater; |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.Core; |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.appender.rolling.action.Action; |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.appender.rolling.action.CompositeAction; |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.appender.rolling.action.FileRenameAction; |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.appender.rolling.action.PathCondition; |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.appender.rolling.action.PosixViewAttributeAction; |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.Configuration; |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.Plugin; |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginAttribute; |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute; |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory; |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginConfiguration; |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginElement; |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginFactory; |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.lookup.StrSubstitutor; |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.util.Integers; |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * When rolling over, <code>DefaultRolloverStrategy</code> renames files according to an algorithm as described below.</em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * The DefaultRolloverStrategy is a combination of a time-based policy and a fixed-window policy. When the file name</em> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * pattern contains a date format then the rollover time interval will be used to calculate the time to use in the file</em> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * pattern. When the file pattern contains an integer replacement token one of the counting techniques will be used.</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"> * <p></em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * When the ascending attribute is set to true (the default) then the counter will be incremented and the current log</em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * file will be renamed to include the counter value. If the counter hits the maximum value then the oldest file, which</em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * will have the smallest counter, will be deleted, all other files will be renamed to have their counter decremented</em> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * and then the current file will be renamed to have the maximum counter value. Note that with this counting strategy</em> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * specifying a large maximum value may entirely avoid renaming files.</em> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * </p></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"> * When the ascending attribute is false, then the "normal" fixed-window strategy will be used.</em> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * Let <em>max</em> and <em>min</em> represent the values of respectively the <b>MaxIndex</b> and <b>MinIndex</b></em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * options. Let "foo.log" be the value of the <b>ActiveFile</b> option and "foo.%i.log" the value of</em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * <b>FileNamePattern</b>. Then, when rolling over, the file <code>foo.<em>max</em>.log</code> will be deleted, the file</em> |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * <code>foo.<em>max-1</em>.log</code> will be renamed as <code>foo.<em>max</em>.log</code>, the file</em> |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * <code>foo.<em>max-2</em>.log</code> renamed as <code>foo.<em>max-1</em>.log</code>, and so on, the file</em> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * <code>foo.<em>min+1</em>.log</code> renamed as <code>foo.<em>min+2</em>.log</code>. Lastly, the active file</em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * <code>foo.log</code> will be renamed as <code>foo.<em>min</em>.log</code> and a new active file name</em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * <code>foo.log</code> will be created.</em> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * Given that this rollover algorithm requires as many file renaming operations as the window size, large window sizes</em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * are discouraged.</em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> @Plugin(name = <span class="jxr_string">"DefaultRolloverStrategy"</span>, category = Core.CATEGORY_NAME, printObject = <strong class="jxr_keyword">true</strong>) |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/DefaultRolloverStrategy.html">DefaultRolloverStrategy</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/AbstractRolloverStrategy.html">AbstractRolloverStrategy</a> { |
| <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> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> MIN_WINDOW_SIZE = 1; |
| <a class="jxr_linenumber" name="L85" href="#L85">85</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_WINDOW_SIZE = 7; |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * Builds DefaultRolloverStrategy instances.</em> |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PosixViewAttributeAction.html">Builder</a> <strong class="jxr_keyword">implements</strong> org.apache.logging.log4j.core.util.Builder<DefaultRolloverStrategy> { |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> @PluginBuilderAttribute(<span class="jxr_string">"max"</span>) |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">private</strong> String max; |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> @PluginBuilderAttribute(<span class="jxr_string">"min"</span>) |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">private</strong> String min; |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> @PluginBuilderAttribute(<span class="jxr_string">"fileIndex"</span>) |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">private</strong> String fileIndex; |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> @PluginBuilderAttribute(<span class="jxr_string">"compressionLevel"</span>) |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">private</strong> String compressionLevelStr; |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> @PluginElement(<span class="jxr_string">"Actions"</span>) |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Action.html">Action</a>[] customActions; |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> @PluginBuilderAttribute(value = <span class="jxr_string">"stopCustomActionsOnError"</span>) |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> stopCustomActionsOnError = <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> @PluginBuilderAttribute(value = <span class="jxr_string">"tempCompressedFilePattern"</span>) |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">private</strong> String tempCompressedFilePattern; |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> @PluginConfiguration |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config; |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> @Override |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/DefaultRolloverStrategy.html">DefaultRolloverStrategy</a> build() { |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">int</strong> minIndex; |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">int</strong> maxIndex; |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">boolean</strong> useMax; |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">if</strong> (fileIndex != <strong class="jxr_keyword">null</strong> && fileIndex.equalsIgnoreCase(<span class="jxr_string">"nomax"</span>)) { |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> minIndex = Integer.MIN_VALUE; |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> maxIndex = Integer.MAX_VALUE; |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> useMax = false; |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> useMax = fileIndex == <strong class="jxr_keyword">null</strong> ? <strong class="jxr_keyword">true</strong> : fileIndex.equalsIgnoreCase(<span class="jxr_string">"max"</span>); |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> minIndex = MIN_WINDOW_SIZE; |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">if</strong> (min != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> minIndex = Integer.parseInt(min); |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">if</strong> (minIndex < 1) { |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> LOGGER.error(<span class="jxr_string">"Minimum window size too small. Limited to "</span> + MIN_WINDOW_SIZE); |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> minIndex = MIN_WINDOW_SIZE; |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> } |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> } |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> maxIndex = DEFAULT_WINDOW_SIZE; |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">if</strong> (max != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> maxIndex = Integer.parseInt(max); |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">if</strong> (maxIndex < minIndex) { |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> maxIndex = minIndex < DEFAULT_WINDOW_SIZE ? DEFAULT_WINDOW_SIZE : minIndex; |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> LOGGER.error(<span class="jxr_string">"Maximum window size must be greater than the minimum windows size. Set to "</span> + maxIndex); |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> } |
| <a class="jxr_linenumber" name="L142" href="#L142">142</a> } |
| <a class="jxr_linenumber" name="L143" href="#L143">143</a> } |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> compressionLevel = Integers.parseInt(compressionLevelStr, Deflater.DEFAULT_COMPRESSION); |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_comment">// The config object can be null when this object is built programmatically.</em> |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html">StrSubstitutor</a> nonNullStrSubstitutor = config != <strong class="jxr_keyword">null</strong> ? config.getStrSubstitutor() : <strong class="jxr_keyword">new</strong> StrSubstitutor(); |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/DefaultRolloverStrategy.html">DefaultRolloverStrategy</a>(minIndex, maxIndex, useMax, compressionLevel, nonNullStrSubstitutor, |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> customActions, stopCustomActionsOnError, tempCompressedFilePattern); |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> } |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> |
| <a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">public</strong> String getMax() { |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">return</strong> max; |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> } |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * Defines the maximum number of files to keep.</em> |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * @param max The maximum number of files to keep.</em> |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * @return This builder for chaining convenience</em> |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PosixViewAttributeAction.html">Builder</a> withMax(<strong class="jxr_keyword">final</strong> String max) { |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">this</strong>.max = max; |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> } |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">public</strong> String getMin() { |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">return</strong> min; |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> } |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * Defines the minimum number of files to keep.</em> |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * @param min The minimum number of files to keep.</em> |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * @return This builder for chaining convenience</em> |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PosixViewAttributeAction.html">Builder</a> withMin(<strong class="jxr_keyword">final</strong> String min) { |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">this</strong>.min = min; |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <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> <strong class="jxr_keyword">public</strong> String getFileIndex() { |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">return</strong> fileIndex; |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> } |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * Defines the file index for rolling strategy.</em> |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * @param fileIndex If set to "max" (the default), files with a higher index will be newer than files with a smaller</em> |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * index. If set to "min", file renaming and the counter will follow the Fixed Window strategy.</em> |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * @return This builder for chaining convenience</em> |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PosixViewAttributeAction.html">Builder</a> withFileIndex(<strong class="jxr_keyword">final</strong> String fileIndex) { |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">this</strong>.fileIndex = fileIndex; |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> } |
| <a class="jxr_linenumber" name="L196" href="#L196">196</a> |
| <a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">public</strong> String getCompressionLevelStr() { |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">return</strong> compressionLevelStr; |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> } |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> |
| <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"> * Defines compression level.</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> <em class="jxr_javadoccomment"> * @param compressionLevelStr The compression level, 0 (less) through 9 (more); applies only to ZIP files.</em> |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * @return This builder for chaining convenience</em> |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PosixViewAttributeAction.html">Builder</a> withCompressionLevelStr(<strong class="jxr_keyword">final</strong> String compressionLevelStr) { |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">this</strong>.compressionLevelStr = compressionLevelStr; |
| <a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a class="jxr_linenumber" name="L210" href="#L210">210</a> } |
| <a class="jxr_linenumber" name="L211" href="#L211">211</a> |
| <a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Action.html">Action</a>[] getCustomActions() { |
| <a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">return</strong> customActions; |
| <a class="jxr_linenumber" name="L214" href="#L214">214</a> } |
| <a class="jxr_linenumber" name="L215" href="#L215">215</a> |
| <a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * Defines custom actions.</em> |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * @param customActions custom actions to perform asynchronously after rollover</em> |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * @return This builder for chaining convenience</em> |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PosixViewAttributeAction.html">Builder</a> withCustomActions(<strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Action.html">Action</a>[] customActions) { |
| <a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">this</strong>.customActions = customActions; |
| <a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a class="jxr_linenumber" name="L225" href="#L225">225</a> } |
| <a class="jxr_linenumber" name="L226" href="#L226">226</a> |
| <a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isStopCustomActionsOnError() { |
| <a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">return</strong> stopCustomActionsOnError; |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> } |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> * Defines whether to stop executing asynchronous actions if an error occurs.</em> |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * @param stopCustomActionsOnError whether to stop executing asynchronous actions if an error occurs</em> |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> * @return This builder for chaining convenience</em> |
| <a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PosixViewAttributeAction.html">Builder</a> withStopCustomActionsOnError(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> stopCustomActionsOnError) { |
| <a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">this</strong>.stopCustomActionsOnError = stopCustomActionsOnError; |
| <a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <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> <strong class="jxr_keyword">public</strong> String getTempCompressedFilePattern() { |
| <a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">return</strong> tempCompressedFilePattern; |
| <a class="jxr_linenumber" name="L244" href="#L244">244</a> } |
| <a class="jxr_linenumber" name="L245" href="#L245">245</a> |
| <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"> * Defines temporary compression file pattern.</em> |
| <a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> * @param tempCompressedFilePattern File pattern of the working file pattern used during compression, if null no temporary file are used</em> |
| <a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> * @return This builder for chaining convenience</em> |
| <a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PosixViewAttributeAction.html">Builder</a> withTempCompressedFilePattern(<strong class="jxr_keyword">final</strong> String tempCompressedFilePattern) { |
| <a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">this</strong>.tempCompressedFilePattern = tempCompressedFilePattern; |
| <a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a class="jxr_linenumber" name="L255" href="#L255">255</a> } |
| <a class="jxr_linenumber" name="L256" href="#L256">256</a> |
| <a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> getConfig() { |
| <a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">return</strong> config; |
| <a class="jxr_linenumber" name="L259" href="#L259">259</a> } |
| <a class="jxr_linenumber" name="L260" href="#L260">260</a> |
| <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> <em class="jxr_javadoccomment"> * Defines configuration.</em> |
| <a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> * @param config The Configuration.</em> |
| <a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * @return This builder for chaining convenience</em> |
| <a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PosixViewAttributeAction.html">Builder</a> withConfig(<strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config) { |
| <a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">this</strong>.config = config; |
| <a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a class="jxr_linenumber" name="L270" href="#L270">270</a> } |
| <a class="jxr_linenumber" name="L271" href="#L271">271</a> } |
| <a class="jxr_linenumber" name="L272" href="#L272">272</a> |
| <a class="jxr_linenumber" name="L273" href="#L273">273</a> @PluginBuilderFactory |
| <a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PosixViewAttributeAction.html">Builder</a> newBuilder() { |
| <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/rolling/action/PosixViewAttributeAction.html">Builder</a>(); |
| <a class="jxr_linenumber" name="L276" href="#L276">276</a> } |
| <a class="jxr_linenumber" name="L277" href="#L277">277</a> |
| <a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> * Creates the DefaultRolloverStrategy.</em> |
| <a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment"> * @param max The maximum number of files to keep.</em> |
| <a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment"> * @param min The minimum number of files to keep.</em> |
| <a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> * @param fileIndex If set to "max" (the default), files with a higher index will be newer than files with a smaller</em> |
| <a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * index. If set to "min", file renaming and the counter will follow the Fixed Window strategy.</em> |
| <a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> * @param compressionLevelStr The compression level, 0 (less) through 9 (more); applies only to ZIP files.</em> |
| <a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * @param customActions custom actions to perform asynchronously after rollover</em> |
| <a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * @param stopCustomActionsOnError whether to stop executing asynchronous actions if an error occurs</em> |
| <a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * @param config The Configuration.</em> |
| <a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * @return A DefaultRolloverStrategy.</em> |
| <a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> * @deprecated Since 2.9 Usage of Builder API is preferable</em> |
| <a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L292" href="#L292">292</a> @PluginFactory |
| <a class="jxr_linenumber" name="L293" href="#L293">293</a> @Deprecated |
| <a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/DefaultRolloverStrategy.html">DefaultRolloverStrategy</a> createStrategy( |
| <a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_comment">// @formatter:off</em> |
| <a class="jxr_linenumber" name="L296" href="#L296">296</a> @PluginAttribute(<span class="jxr_string">"max"</span>) <strong class="jxr_keyword">final</strong> String max, |
| <a class="jxr_linenumber" name="L297" href="#L297">297</a> @PluginAttribute(<span class="jxr_string">"min"</span>) <strong class="jxr_keyword">final</strong> String min, |
| <a class="jxr_linenumber" name="L298" href="#L298">298</a> @PluginAttribute(<span class="jxr_string">"fileIndex"</span>) <strong class="jxr_keyword">final</strong> String fileIndex, |
| <a class="jxr_linenumber" name="L299" href="#L299">299</a> @PluginAttribute(<span class="jxr_string">"compressionLevel"</span>) <strong class="jxr_keyword">final</strong> String compressionLevelStr, |
| <a class="jxr_linenumber" name="L300" href="#L300">300</a> @PluginElement(<span class="jxr_string">"Actions"</span>) <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Action.html">Action</a>[] customActions, |
| <a class="jxr_linenumber" name="L301" href="#L301">301</a> @PluginAttribute(value = <span class="jxr_string">"stopCustomActionsOnError"</span>, defaultBoolean = <strong class="jxr_keyword">true</strong>) |
| <a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> stopCustomActionsOnError, |
| <a class="jxr_linenumber" name="L303" href="#L303">303</a> @PluginConfiguration <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config) { |
| <a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong class="jxr_keyword">return</strong> DefaultRolloverStrategy.newBuilder() |
| <a class="jxr_linenumber" name="L305" href="#L305">305</a> .withMin(min) |
| <a class="jxr_linenumber" name="L306" href="#L306">306</a> .withMax(max) |
| <a class="jxr_linenumber" name="L307" href="#L307">307</a> .withFileIndex(fileIndex) |
| <a class="jxr_linenumber" name="L308" href="#L308">308</a> .withCompressionLevelStr(compressionLevelStr) |
| <a class="jxr_linenumber" name="L309" href="#L309">309</a> .withCustomActions(customActions) |
| <a class="jxr_linenumber" name="L310" href="#L310">310</a> .withStopCustomActionsOnError(stopCustomActionsOnError) |
| <a class="jxr_linenumber" name="L311" href="#L311">311</a> .withConfig(config) |
| <a class="jxr_linenumber" name="L312" href="#L312">312</a> .build(); |
| <a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_comment">// @formatter:on</em> |
| <a class="jxr_linenumber" name="L314" href="#L314">314</a> } |
| <a class="jxr_linenumber" name="L315" href="#L315">315</a> |
| <a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> * Index for oldest retained log file.</em> |
| <a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> maxIndex; |
| <a class="jxr_linenumber" name="L320" href="#L320">320</a> |
| <a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> * Index for most recent log file.</em> |
| <a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L324" href="#L324">324</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> minIndex; |
| <a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> useMax; |
| <a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> compressionLevel; |
| <a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List<Action> customActions; |
| <a class="jxr_linenumber" name="L328" href="#L328">328</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> stopCustomActionsOnError; |
| <a class="jxr_linenumber" name="L329" href="#L329">329</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/PatternProcessor.html">PatternProcessor</a> tempCompressedFilePattern; |
| <a class="jxr_linenumber" name="L330" href="#L330">330</a> |
| <a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * Constructs a new instance.</em> |
| <a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> * @param minIndex The minimum index.</em> |
| <a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> * @param maxIndex The maximum index.</em> |
| <a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * @param customActions custom actions to perform asynchronously after rollover</em> |
| <a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> * @param stopCustomActionsOnError whether to stop executing asynchronous actions if an error occurs</em> |
| <a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_javadoccomment"> * @deprecated Since 2.9 Added tempCompressedFilePatternString parameter</em> |
| <a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L340" href="#L340">340</a> @Deprecated |
| <a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/DefaultRolloverStrategy.html">DefaultRolloverStrategy</a>(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> minIndex, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> maxIndex, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> useMax, |
| <a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> compressionLevel, <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html">StrSubstitutor</a> strSubstitutor, <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Action.html">Action</a>[] customActions, |
| <a class="jxr_linenumber" name="L343" href="#L343">343</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> stopCustomActionsOnError) { |
| <a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong class="jxr_keyword">this</strong>(minIndex, maxIndex, useMax, compressionLevel, |
| <a class="jxr_linenumber" name="L345" href="#L345">345</a> strSubstitutor, customActions, stopCustomActionsOnError, <strong class="jxr_keyword">null</strong>); |
| <a class="jxr_linenumber" name="L346" href="#L346">346</a> } |
| <a class="jxr_linenumber" name="L347" href="#L347">347</a> |
| <a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_javadoccomment"> * Constructs a new instance.</em> |
| <a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_javadoccomment"> * @param minIndex The minimum index.</em> |
| <a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_javadoccomment"> * @param maxIndex The maximum index.</em> |
| <a class="jxr_linenumber" name="L353" href="#L353">353</a> <em class="jxr_javadoccomment"> * @param customActions custom actions to perform asynchronously after rollover</em> |
| <a class="jxr_linenumber" name="L354" href="#L354">354</a> <em class="jxr_javadoccomment"> * @param stopCustomActionsOnError whether to stop executing asynchronous actions if an error occurs</em> |
| <a class="jxr_linenumber" name="L355" href="#L355">355</a> <em class="jxr_javadoccomment"> * @param tempCompressedFilePatternString File pattern of the working file</em> |
| <a class="jxr_linenumber" name="L356" href="#L356">356</a> <em class="jxr_javadoccomment"> * used during compression, if null no temporary file are used</em> |
| <a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/DefaultRolloverStrategy.html">DefaultRolloverStrategy</a>(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> minIndex, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> maxIndex, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> useMax, |
| <a class="jxr_linenumber" name="L359" href="#L359">359</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> compressionLevel, <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html">StrSubstitutor</a> strSubstitutor, <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Action.html">Action</a>[] customActions, |
| <a class="jxr_linenumber" name="L360" href="#L360">360</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> stopCustomActionsOnError, <strong class="jxr_keyword">final</strong> String tempCompressedFilePatternString) { |
| <a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">super</strong>(strSubstitutor); |
| <a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong class="jxr_keyword">this</strong>.minIndex = minIndex; |
| <a class="jxr_linenumber" name="L363" href="#L363">363</a> <strong class="jxr_keyword">this</strong>.maxIndex = maxIndex; |
| <a class="jxr_linenumber" name="L364" href="#L364">364</a> <strong class="jxr_keyword">this</strong>.useMax = useMax; |
| <a class="jxr_linenumber" name="L365" href="#L365">365</a> <strong class="jxr_keyword">this</strong>.compressionLevel = compressionLevel; |
| <a class="jxr_linenumber" name="L366" href="#L366">366</a> <strong class="jxr_keyword">this</strong>.stopCustomActionsOnError = stopCustomActionsOnError; |
| <a class="jxr_linenumber" name="L367" href="#L367">367</a> <strong class="jxr_keyword">this</strong>.customActions = customActions == <strong class="jxr_keyword">null</strong> ? Collections.<Action> emptyList() : Arrays.asList(customActions); |
| <a class="jxr_linenumber" name="L368" href="#L368">368</a> <strong class="jxr_keyword">this</strong>.tempCompressedFilePattern = |
| <a class="jxr_linenumber" name="L369" href="#L369">369</a> tempCompressedFilePatternString != <strong class="jxr_keyword">null</strong> ? <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/PatternProcessor.html">PatternProcessor</a>(tempCompressedFilePatternString) : <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L370" href="#L370">370</a> } |
| <a class="jxr_linenumber" name="L371" href="#L371">371</a> |
| <a class="jxr_linenumber" name="L372" href="#L372">372</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getCompressionLevel() { |
| <a class="jxr_linenumber" name="L373" href="#L373">373</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.compressionLevel; |
| <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> <strong class="jxr_keyword">public</strong> List<Action> getCustomActions() { |
| <a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">return</strong> customActions; |
| <a class="jxr_linenumber" name="L378" href="#L378">378</a> } |
| <a class="jxr_linenumber" name="L379" href="#L379">379</a> |
| <a class="jxr_linenumber" name="L380" href="#L380">380</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getMaxIndex() { |
| <a class="jxr_linenumber" name="L381" href="#L381">381</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.maxIndex; |
| <a class="jxr_linenumber" name="L382" href="#L382">382</a> } |
| <a class="jxr_linenumber" name="L383" href="#L383">383</a> |
| <a class="jxr_linenumber" name="L384" href="#L384">384</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getMinIndex() { |
| <a class="jxr_linenumber" name="L385" href="#L385">385</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.minIndex; |
| <a class="jxr_linenumber" name="L386" href="#L386">386</a> } |
| <a class="jxr_linenumber" name="L387" href="#L387">387</a> |
| <a class="jxr_linenumber" name="L388" href="#L388">388</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isStopCustomActionsOnError() { |
| <a class="jxr_linenumber" name="L389" href="#L389">389</a> <strong class="jxr_keyword">return</strong> stopCustomActionsOnError; |
| <a class="jxr_linenumber" name="L390" href="#L390">390</a> } |
| <a class="jxr_linenumber" name="L391" href="#L391">391</a> |
| <a class="jxr_linenumber" name="L392" href="#L392">392</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isUseMax() { |
| <a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">return</strong> useMax; |
| <a class="jxr_linenumber" name="L394" href="#L394">394</a> } |
| <a class="jxr_linenumber" name="L395" href="#L395">395</a> |
| <a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/PatternProcessor.html">PatternProcessor</a> getTempCompressedFilePattern() { |
| <a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">return</strong> tempCompressedFilePattern; |
| <a class="jxr_linenumber" name="L398" href="#L398">398</a> } |
| <a class="jxr_linenumber" name="L399" href="#L399">399</a> |
| <a class="jxr_linenumber" name="L400" href="#L400">400</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> purge(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> lowIndex, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> highIndex, <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/RollingFileManager.html">RollingFileManager</a> manager) { |
| <a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong class="jxr_keyword">return</strong> useMax ? purgeAscending(lowIndex, highIndex, manager) : purgeDescending(lowIndex, highIndex, manager); |
| <a class="jxr_linenumber" name="L402" href="#L402">402</a> } |
| <a class="jxr_linenumber" name="L403" href="#L403">403</a> |
| <a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> * Purges and renames old log files in preparation for rollover. The oldest file will have the smallest index, the</em> |
| <a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_javadoccomment"> * newest the highest.</em> |
| <a class="jxr_linenumber" name="L407" href="#L407">407</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L408" href="#L408">408</a> <em class="jxr_javadoccomment"> * @param lowIndex low index. Log file associated with low index will be deleted if needed.</em> |
| <a class="jxr_linenumber" name="L409" href="#L409">409</a> <em class="jxr_javadoccomment"> * @param highIndex high index.</em> |
| <a class="jxr_linenumber" name="L410" href="#L410">410</a> <em class="jxr_javadoccomment"> * @param manager The RollingFileManager</em> |
| <a class="jxr_linenumber" name="L411" href="#L411">411</a> <em class="jxr_javadoccomment"> * @return true if purge was successful and rollover should be attempted.</em> |
| <a class="jxr_linenumber" name="L412" href="#L412">412</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L413" href="#L413">413</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> purgeAscending(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> lowIndex, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> highIndex, <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/RollingFileManager.html">RollingFileManager</a> manager) { |
| <a class="jxr_linenumber" name="L414" href="#L414">414</a> <strong class="jxr_keyword">final</strong> SortedMap<Integer, Path> eligibleFiles = getEligibleFiles(manager); |
| <a class="jxr_linenumber" name="L415" href="#L415">415</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> maxFiles = highIndex - lowIndex + 1; |
| <a class="jxr_linenumber" name="L416" href="#L416">416</a> |
| <a class="jxr_linenumber" name="L417" href="#L417">417</a> <strong class="jxr_keyword">boolean</strong> renameFiles = !eligibleFiles.isEmpty() && eligibleFiles.lastKey() >= maxIndex; |
| <a class="jxr_linenumber" name="L418" href="#L418">418</a> <strong class="jxr_keyword">while</strong> (eligibleFiles.size() >= maxFiles) { |
| <a class="jxr_linenumber" name="L419" href="#L419">419</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L420" href="#L420">420</a> LOGGER.debug(<span class="jxr_string">"Eligible files: {}"</span>, eligibleFiles); |
| <a class="jxr_linenumber" name="L421" href="#L421">421</a> <strong class="jxr_keyword">final</strong> Integer key = eligibleFiles.firstKey(); |
| <a class="jxr_linenumber" name="L422" href="#L422">422</a> LOGGER.debug(<span class="jxr_string">"Deleting {}"</span>, eligibleFiles.get(key).toFile().getAbsolutePath()); |
| <a class="jxr_linenumber" name="L423" href="#L423">423</a> Files.delete(eligibleFiles.get(key)); |
| <a class="jxr_linenumber" name="L424" href="#L424">424</a> eligibleFiles.remove(key); |
| <a class="jxr_linenumber" name="L425" href="#L425">425</a> renameFiles = <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L426" href="#L426">426</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException ioe) { |
| <a class="jxr_linenumber" name="L427" href="#L427">427</a> LOGGER.error(<span class="jxr_string">"Unable to delete {}, {}"</span>, eligibleFiles.firstKey(), ioe.getMessage(), ioe); |
| <a class="jxr_linenumber" name="L428" href="#L428">428</a> <strong class="jxr_keyword">break</strong>; |
| <a class="jxr_linenumber" name="L429" href="#L429">429</a> } |
| <a class="jxr_linenumber" name="L430" href="#L430">430</a> } |
| <a class="jxr_linenumber" name="L431" href="#L431">431</a> <strong class="jxr_keyword">final</strong> StringBuilder buf = <strong class="jxr_keyword">new</strong> StringBuilder(); |
| <a class="jxr_linenumber" name="L432" href="#L432">432</a> <strong class="jxr_keyword">if</strong> (renameFiles) { |
| <a class="jxr_linenumber" name="L433" href="#L433">433</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Map.Entry<Integer, Path> entry : eligibleFiles.entrySet()) { |
| <a class="jxr_linenumber" name="L434" href="#L434">434</a> buf.setLength(0); |
| <a class="jxr_linenumber" name="L435" href="#L435">435</a> <em class="jxr_comment">// LOG4J2-531: directory scan & rollover must use same format</em> |
| <a class="jxr_linenumber" name="L436" href="#L436">436</a> manager.getPatternProcessor().formatFileName(strSubstitutor, buf, entry.getKey() - 1); |
| <a class="jxr_linenumber" name="L437" href="#L437">437</a> <strong class="jxr_keyword">final</strong> String currentName = entry.getValue().toFile().getName(); |
| <a class="jxr_linenumber" name="L438" href="#L438">438</a> String renameTo = buf.toString(); |
| <a class="jxr_linenumber" name="L439" href="#L439">439</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> suffixLength = suffixLength(renameTo); |
| <a class="jxr_linenumber" name="L440" href="#L440">440</a> <strong class="jxr_keyword">if</strong> (suffixLength > 0 && suffixLength(currentName) == 0) { |
| <a class="jxr_linenumber" name="L441" href="#L441">441</a> renameTo = renameTo.substring(0, renameTo.length() - suffixLength); |
| <a class="jxr_linenumber" name="L442" href="#L442">442</a> } |
| <a class="jxr_linenumber" name="L443" href="#L443">443</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Action.html">Action</a> action = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/FileRenameAction.html">FileRenameAction</a>(entry.getValue().toFile(), <strong class="jxr_keyword">new</strong> File(renameTo), <strong class="jxr_keyword">true</strong>); |
| <a class="jxr_linenumber" name="L444" href="#L444">444</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L445" href="#L445">445</a> LOGGER.debug(<span class="jxr_string">"DefaultRolloverStrategy.purgeAscending executing {}"</span>, action); |
| <a class="jxr_linenumber" name="L446" href="#L446">446</a> <strong class="jxr_keyword">if</strong> (!action.execute()) { |
| <a class="jxr_linenumber" name="L447" href="#L447">447</a> <strong class="jxr_keyword">return</strong> -1; |
| <a class="jxr_linenumber" name="L448" href="#L448">448</a> } |
| <a class="jxr_linenumber" name="L449" href="#L449">449</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> Exception ex) { |
| <a class="jxr_linenumber" name="L450" href="#L450">450</a> LOGGER.warn(<span class="jxr_string">"Exception during purge in RollingFileAppender"</span>, ex); |
| <a class="jxr_linenumber" name="L451" href="#L451">451</a> <strong class="jxr_keyword">return</strong> -1; |
| <a class="jxr_linenumber" name="L452" href="#L452">452</a> } |
| <a class="jxr_linenumber" name="L453" href="#L453">453</a> } |
| <a class="jxr_linenumber" name="L454" href="#L454">454</a> } |
| <a class="jxr_linenumber" name="L455" href="#L455">455</a> |
| <a class="jxr_linenumber" name="L456" href="#L456">456</a> <strong class="jxr_keyword">return</strong> eligibleFiles.size() > 0 ? |
| <a class="jxr_linenumber" name="L457" href="#L457">457</a> (eligibleFiles.lastKey() < highIndex ? eligibleFiles.lastKey() + 1 : highIndex) : lowIndex; |
| <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> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L461" href="#L461">461</a> <em class="jxr_javadoccomment"> * Purges and renames old log files in preparation for rollover. The newest file will have the smallest index, the</em> |
| <a class="jxr_linenumber" name="L462" href="#L462">462</a> <em class="jxr_javadoccomment"> * oldest will have the highest.</em> |
| <a class="jxr_linenumber" name="L463" href="#L463">463</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L464" href="#L464">464</a> <em class="jxr_javadoccomment"> * @param lowIndex low index</em> |
| <a class="jxr_linenumber" name="L465" href="#L465">465</a> <em class="jxr_javadoccomment"> * @param highIndex high index. Log file associated with high index will be deleted if needed.</em> |
| <a class="jxr_linenumber" name="L466" href="#L466">466</a> <em class="jxr_javadoccomment"> * @param manager The RollingFileManager</em> |
| <a class="jxr_linenumber" name="L467" href="#L467">467</a> <em class="jxr_javadoccomment"> * @return true if purge was successful and rollover should be attempted.</em> |
| <a class="jxr_linenumber" name="L468" href="#L468">468</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L469" href="#L469">469</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> purgeDescending(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> lowIndex, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> highIndex, <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/RollingFileManager.html">RollingFileManager</a> manager) { |
| <a class="jxr_linenumber" name="L470" href="#L470">470</a> <em class="jxr_comment">// Retrieve the files in descending order, so the highest key will be first.</em> |
| <a class="jxr_linenumber" name="L471" href="#L471">471</a> <strong class="jxr_keyword">final</strong> SortedMap<Integer, Path> eligibleFiles = getEligibleFiles(manager, false); |
| <a class="jxr_linenumber" name="L472" href="#L472">472</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> maxFiles = highIndex - lowIndex + 1; |
| <a class="jxr_linenumber" name="L473" href="#L473">473</a> LOGGER.debug(<span class="jxr_string">"Eligible files: {}"</span>, eligibleFiles); |
| <a class="jxr_linenumber" name="L474" href="#L474">474</a> <strong class="jxr_keyword">while</strong> (eligibleFiles.size() >= maxFiles) { |
| <a class="jxr_linenumber" name="L475" href="#L475">475</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L476" href="#L476">476</a> <strong class="jxr_keyword">final</strong> Integer key = eligibleFiles.firstKey(); |
| <a class="jxr_linenumber" name="L477" href="#L477">477</a> Files.delete(eligibleFiles.get(key)); |
| <a class="jxr_linenumber" name="L478" href="#L478">478</a> eligibleFiles.remove(key); |
| <a class="jxr_linenumber" name="L479" href="#L479">479</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException ioe) { |
| <a class="jxr_linenumber" name="L480" href="#L480">480</a> LOGGER.error(<span class="jxr_string">"Unable to delete {}, {}"</span>, eligibleFiles.firstKey(), ioe.getMessage(), ioe); |
| <a class="jxr_linenumber" name="L481" href="#L481">481</a> <strong class="jxr_keyword">break</strong>; |
| <a class="jxr_linenumber" name="L482" href="#L482">482</a> } |
| <a class="jxr_linenumber" name="L483" href="#L483">483</a> } |
| <a class="jxr_linenumber" name="L484" href="#L484">484</a> <strong class="jxr_keyword">final</strong> StringBuilder buf = <strong class="jxr_keyword">new</strong> StringBuilder(); |
| <a class="jxr_linenumber" name="L485" href="#L485">485</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Map.Entry<Integer, Path> entry : eligibleFiles.entrySet()) { |
| <a class="jxr_linenumber" name="L486" href="#L486">486</a> buf.setLength(0); |
| <a class="jxr_linenumber" name="L487" href="#L487">487</a> <em class="jxr_comment">// LOG4J2-531: directory scan & rollover must use same format</em> |
| <a class="jxr_linenumber" name="L488" href="#L488">488</a> manager.getPatternProcessor().formatFileName(strSubstitutor, buf, entry.getKey() + 1); |
| <a class="jxr_linenumber" name="L489" href="#L489">489</a> <strong class="jxr_keyword">final</strong> String currentName = entry.getValue().toFile().getName(); |
| <a class="jxr_linenumber" name="L490" href="#L490">490</a> String renameTo = buf.toString(); |
| <a class="jxr_linenumber" name="L491" href="#L491">491</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> suffixLength = suffixLength(renameTo); |
| <a class="jxr_linenumber" name="L492" href="#L492">492</a> <strong class="jxr_keyword">if</strong> (suffixLength > 0 && suffixLength(currentName) == 0) { |
| <a class="jxr_linenumber" name="L493" href="#L493">493</a> renameTo = renameTo.substring(0, renameTo.length() - suffixLength); |
| <a class="jxr_linenumber" name="L494" href="#L494">494</a> } |
| <a class="jxr_linenumber" name="L495" href="#L495">495</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Action.html">Action</a> action = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/FileRenameAction.html">FileRenameAction</a>(entry.getValue().toFile(), <strong class="jxr_keyword">new</strong> File(renameTo), <strong class="jxr_keyword">true</strong>); |
| <a class="jxr_linenumber" name="L496" href="#L496">496</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L497" href="#L497">497</a> LOGGER.debug(<span class="jxr_string">"DefaultRolloverStrategy.purgeDescending executing {}"</span>, action); |
| <a class="jxr_linenumber" name="L498" href="#L498">498</a> <strong class="jxr_keyword">if</strong> (!action.execute()) { |
| <a class="jxr_linenumber" name="L499" href="#L499">499</a> <strong class="jxr_keyword">return</strong> -1; |
| <a class="jxr_linenumber" name="L500" href="#L500">500</a> } |
| <a class="jxr_linenumber" name="L501" href="#L501">501</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> Exception ex) { |
| <a class="jxr_linenumber" name="L502" href="#L502">502</a> LOGGER.warn(<span class="jxr_string">"Exception during purge in RollingFileAppender"</span>, ex); |
| <a class="jxr_linenumber" name="L503" href="#L503">503</a> <strong class="jxr_keyword">return</strong> -1; |
| <a class="jxr_linenumber" name="L504" href="#L504">504</a> } |
| <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> <strong class="jxr_keyword">return</strong> lowIndex; |
| <a class="jxr_linenumber" name="L508" href="#L508">508</a> } |
| <a class="jxr_linenumber" name="L509" href="#L509">509</a> |
| <a class="jxr_linenumber" name="L510" href="#L510">510</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L511" href="#L511">511</a> <em class="jxr_javadoccomment"> * Performs the rollover.</em> |
| <a class="jxr_linenumber" name="L512" href="#L512">512</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L513" href="#L513">513</a> <em class="jxr_javadoccomment"> * @param manager The RollingFileManager name for current active log file.</em> |
| <a class="jxr_linenumber" name="L514" href="#L514">514</a> <em class="jxr_javadoccomment"> * @return A RolloverDescription.</em> |
| <a class="jxr_linenumber" name="L515" href="#L515">515</a> <em class="jxr_javadoccomment"> * @throws SecurityException if an error occurs.</em> |
| <a class="jxr_linenumber" name="L516" href="#L516">516</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L517" href="#L517">517</a> @Override |
| <a class="jxr_linenumber" name="L518" href="#L518">518</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/RolloverDescription.html">RolloverDescription</a> rollover(<strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/RollingFileManager.html">RollingFileManager</a> manager) <strong class="jxr_keyword">throws</strong> SecurityException { |
| <a class="jxr_linenumber" name="L519" href="#L519">519</a> <strong class="jxr_keyword">int</strong> fileIndex; |
| <a class="jxr_linenumber" name="L520" href="#L520">520</a> <strong class="jxr_keyword">final</strong> StringBuilder buf = <strong class="jxr_keyword">new</strong> StringBuilder(255); |
| <a class="jxr_linenumber" name="L521" href="#L521">521</a> <strong class="jxr_keyword">if</strong> (minIndex == Integer.MIN_VALUE) { |
| <a class="jxr_linenumber" name="L522" href="#L522">522</a> <strong class="jxr_keyword">final</strong> SortedMap<Integer, Path> eligibleFiles = getEligibleFiles(manager); |
| <a class="jxr_linenumber" name="L523" href="#L523">523</a> fileIndex = eligibleFiles.size() > 0 ? eligibleFiles.lastKey() + 1 : 1; |
| <a class="jxr_linenumber" name="L524" href="#L524">524</a> manager.getPatternProcessor().formatFileName(strSubstitutor, buf, fileIndex); |
| <a class="jxr_linenumber" name="L525" href="#L525">525</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L526" href="#L526">526</a> <strong class="jxr_keyword">if</strong> (maxIndex < 0) { |
| <a class="jxr_linenumber" name="L527" href="#L527">527</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L528" href="#L528">528</a> } |
| <a class="jxr_linenumber" name="L529" href="#L529">529</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> startNanos = System.nanoTime(); |
| <a class="jxr_linenumber" name="L530" href="#L530">530</a> fileIndex = purge(minIndex, maxIndex, manager); |
| <a class="jxr_linenumber" name="L531" href="#L531">531</a> <strong class="jxr_keyword">if</strong> (fileIndex < 0) { |
| <a class="jxr_linenumber" name="L532" href="#L532">532</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L533" href="#L533">533</a> } |
| <a class="jxr_linenumber" name="L534" href="#L534">534</a> manager.getPatternProcessor().formatFileName(strSubstitutor, buf, fileIndex); |
| <a class="jxr_linenumber" name="L535" href="#L535">535</a> <strong class="jxr_keyword">if</strong> (LOGGER.isTraceEnabled()) { |
| <a class="jxr_linenumber" name="L536" href="#L536">536</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">double</strong> durationMillis = TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startNanos); |
| <a class="jxr_linenumber" name="L537" href="#L537">537</a> LOGGER.trace(<span class="jxr_string">"DefaultRolloverStrategy.purge() took {} milliseconds"</span>, durationMillis); |
| <a class="jxr_linenumber" name="L538" href="#L538">538</a> } |
| <a class="jxr_linenumber" name="L539" href="#L539">539</a> } |
| <a class="jxr_linenumber" name="L540" href="#L540">540</a> |
| <a class="jxr_linenumber" name="L541" href="#L541">541</a> <strong class="jxr_keyword">final</strong> String currentFileName = manager.getFileName(); |
| <a class="jxr_linenumber" name="L542" href="#L542">542</a> |
| <a class="jxr_linenumber" name="L543" href="#L543">543</a> String renameTo = buf.toString(); |
| <a class="jxr_linenumber" name="L544" href="#L544">544</a> <strong class="jxr_keyword">final</strong> String compressedName = renameTo; |
| <a class="jxr_linenumber" name="L545" href="#L545">545</a> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Action.html">Action</a> compressAction = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L546" href="#L546">546</a> |
| <a class="jxr_linenumber" name="L547" href="#L547">547</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/FileExtension.html">FileExtension</a> fileExtension = manager.getFileExtension(); |
| <a class="jxr_linenumber" name="L548" href="#L548">548</a> <strong class="jxr_keyword">if</strong> (fileExtension != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L549" href="#L549">549</a> <strong class="jxr_keyword">final</strong> File renameToFile = <strong class="jxr_keyword">new</strong> File(renameTo); |
| <a class="jxr_linenumber" name="L550" href="#L550">550</a> renameTo = renameTo.substring(0, renameTo.length() - fileExtension.length()); |
| <a class="jxr_linenumber" name="L551" href="#L551">551</a> <strong class="jxr_keyword">if</strong> (tempCompressedFilePattern != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L552" href="#L552">552</a> buf.delete(0, buf.length()); |
| <a class="jxr_linenumber" name="L553" href="#L553">553</a> tempCompressedFilePattern.formatFileName(strSubstitutor, buf, fileIndex); |
| <a class="jxr_linenumber" name="L554" href="#L554">554</a> <strong class="jxr_keyword">final</strong> String tmpCompressedName = buf.toString(); |
| <a class="jxr_linenumber" name="L555" href="#L555">555</a> <strong class="jxr_keyword">final</strong> File tmpCompressedNameFile = <strong class="jxr_keyword">new</strong> File(tmpCompressedName); |
| <a class="jxr_linenumber" name="L556" href="#L556">556</a> <strong class="jxr_keyword">final</strong> File parentFile = tmpCompressedNameFile.getParentFile(); |
| <a class="jxr_linenumber" name="L557" href="#L557">557</a> <strong class="jxr_keyword">if</strong> (parentFile != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L558" href="#L558">558</a> parentFile.mkdirs(); |
| <a class="jxr_linenumber" name="L559" href="#L559">559</a> } |
| <a class="jxr_linenumber" name="L560" href="#L560">560</a> compressAction = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/CompositeAction.html">CompositeAction</a>( |
| <a class="jxr_linenumber" name="L561" href="#L561">561</a> Arrays.asList(fileExtension.createCompressAction(renameTo, tmpCompressedName, |
| <a class="jxr_linenumber" name="L562" href="#L562">562</a> <strong class="jxr_keyword">true</strong>, compressionLevel), |
| <a class="jxr_linenumber" name="L563" href="#L563">563</a> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/FileRenameAction.html">FileRenameAction</a>(tmpCompressedNameFile, |
| <a class="jxr_linenumber" name="L564" href="#L564">564</a> renameToFile, <strong class="jxr_keyword">true</strong>)), |
| <a class="jxr_linenumber" name="L565" href="#L565">565</a> <strong class="jxr_keyword">true</strong>); |
| <a class="jxr_linenumber" name="L566" href="#L566">566</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L567" href="#L567">567</a> compressAction = fileExtension.createCompressAction(renameTo, compressedName, |
| <a class="jxr_linenumber" name="L568" href="#L568">568</a> <strong class="jxr_keyword">true</strong>, compressionLevel); |
| <a class="jxr_linenumber" name="L569" href="#L569">569</a> } |
| <a class="jxr_linenumber" name="L570" href="#L570">570</a> } |
| <a class="jxr_linenumber" name="L571" href="#L571">571</a> |
| <a class="jxr_linenumber" name="L572" href="#L572">572</a> <strong class="jxr_keyword">if</strong> (currentFileName.equals(renameTo)) { |
| <a class="jxr_linenumber" name="L573" href="#L573">573</a> LOGGER.warn(<span class="jxr_string">"Attempt to rename file {} to itself will be ignored"</span>, currentFileName); |
| <a class="jxr_linenumber" name="L574" href="#L574">574</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/RolloverDescriptionImpl.html">RolloverDescriptionImpl</a>(currentFileName, false, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>); |
| <a class="jxr_linenumber" name="L575" href="#L575">575</a> } |
| <a class="jxr_linenumber" name="L576" href="#L576">576</a> |
| <a class="jxr_linenumber" name="L577" href="#L577">577</a> <strong class="jxr_keyword">if</strong> (compressAction != <strong class="jxr_keyword">null</strong> && manager.isAttributeViewEnabled()) { |
| <a class="jxr_linenumber" name="L578" href="#L578">578</a> <em class="jxr_comment">// Propagate posix attribute view to compressed file</em> |
| <a class="jxr_linenumber" name="L579" href="#L579">579</a> <em class="jxr_comment">// @formatter:off</em> |
| <a class="jxr_linenumber" name="L580" href="#L580">580</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Action.html">Action</a> posixAttributeViewAction = PosixViewAttributeAction.newBuilder() |
| <a class="jxr_linenumber" name="L581" href="#L581">581</a> .withBasePath(compressedName) |
| <a class="jxr_linenumber" name="L582" href="#L582">582</a> .withFollowLinks(false) |
| <a class="jxr_linenumber" name="L583" href="#L583">583</a> .withMaxDepth(1) |
| <a class="jxr_linenumber" name="L584" href="#L584">584</a> .withPathConditions(<strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PathCondition.html">PathCondition</a>[0]) |
| <a class="jxr_linenumber" name="L585" href="#L585">585</a> .withSubst(getStrSubstitutor()) |
| <a class="jxr_linenumber" name="L586" href="#L586">586</a> .withFilePermissions(manager.getFilePermissions()) |
| <a class="jxr_linenumber" name="L587" href="#L587">587</a> .withFileOwner(manager.getFileOwner()) |
| <a class="jxr_linenumber" name="L588" href="#L588">588</a> .withFileGroup(manager.getFileGroup()) |
| <a class="jxr_linenumber" name="L589" href="#L589">589</a> .build(); |
| <a class="jxr_linenumber" name="L590" href="#L590">590</a> <em class="jxr_comment">// @formatter:on</em> |
| <a class="jxr_linenumber" name="L591" href="#L591">591</a> compressAction = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/CompositeAction.html">CompositeAction</a>(Arrays.asList(compressAction, posixAttributeViewAction), false); |
| <a class="jxr_linenumber" name="L592" href="#L592">592</a> } |
| <a class="jxr_linenumber" name="L593" href="#L593">593</a> |
| <a class="jxr_linenumber" name="L594" href="#L594">594</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/FileRenameAction.html">FileRenameAction</a> renameAction = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/FileRenameAction.html">FileRenameAction</a>(<strong class="jxr_keyword">new</strong> File(currentFileName), <strong class="jxr_keyword">new</strong> File(renameTo), |
| <a class="jxr_linenumber" name="L595" href="#L595">595</a> manager.isRenameEmptyFiles()); |
| <a class="jxr_linenumber" name="L596" href="#L596">596</a> |
| <a class="jxr_linenumber" name="L597" href="#L597">597</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Action.html">Action</a> asyncAction = merge(compressAction, customActions, stopCustomActionsOnError); |
| <a class="jxr_linenumber" name="L598" href="#L598">598</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/RolloverDescriptionImpl.html">RolloverDescriptionImpl</a>(currentFileName, false, renameAction, asyncAction); |
| <a class="jxr_linenumber" name="L599" href="#L599">599</a> } |
| <a class="jxr_linenumber" name="L600" href="#L600">600</a> |
| <a class="jxr_linenumber" name="L601" href="#L601">601</a> @Override |
| <a class="jxr_linenumber" name="L602" href="#L602">602</a> <strong class="jxr_keyword">public</strong> String toString() { |
| <a class="jxr_linenumber" name="L603" href="#L603">603</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"DefaultRolloverStrategy(min="</span> + minIndex + <span class="jxr_string">", max="</span> + maxIndex + <span class="jxr_string">", useMax="</span> + useMax + <span class="jxr_string">")"</span>; |
| <a class="jxr_linenumber" name="L604" href="#L604">604</a> } |
| <a class="jxr_linenumber" name="L605" href="#L605">605</a> |
| <a class="jxr_linenumber" name="L606" href="#L606">606</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 1999–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
