blob: 55d9642303a2ea0c7cc7b945a874be2ad7068762 [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>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="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache license, Version 2.0</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * limitations under the license.</em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.core.appender.rolling;
<a class="jxr_linenumber" name="18" href="#18">18</a>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.Logger;
<a class="jxr_linenumber" name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.appender.rolling.helper.Action;
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.appender.rolling.helper.FileRenameAction;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.appender.rolling.helper.GZCompressAction;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.appender.rolling.helper.ZipCompressAction;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.Configuration;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.Plugin;
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginAttr;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginFactory;
<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.lookup.StrSubstitutor;
<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.status.StatusLogger;
<a class="jxr_linenumber" name="31" href="#31">31</a>
<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="35" href="#35">35</a>
<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * When rolling over, &lt;code&gt;FixedWindowRollingPolicy&lt;/code&gt; renames files</em>
<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * according to a fixed window algorithm as described below.</em>
<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * &lt;p&gt;The &lt;b&gt;ActiveFileName&lt;/b&gt; property, which is required, represents the name</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * of the file where current logging output will be written.</em>
<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * The &lt;b&gt;FileNamePattern&lt;/b&gt; option represents the file name pattern for the</em>
<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * archived (rolled over) log files. If present, the &lt;b&gt;FileNamePattern&lt;/b&gt;</em>
<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * option must include an integer token, that is the string "%i" somewhere</em>
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * within the pattern.</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * &lt;p&gt;Let &lt;em&gt;max&lt;/em&gt; and &lt;em&gt;min&lt;/em&gt; represent the values of respectively</em>
<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * the &lt;b&gt;MaxIndex&lt;/b&gt; and &lt;b&gt;MinIndex&lt;/b&gt; options. Let "foo.log" be the value</em>
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * of the &lt;b&gt;ActiveFile&lt;/b&gt; option and "foo.%i.log" the value of</em>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * &lt;b&gt;FileNamePattern&lt;/b&gt;. Then, when rolling over, the file</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * &lt;code&gt;foo.&lt;em&gt;max&lt;/em&gt;.log&lt;/code&gt; will be deleted, the file</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * &lt;code&gt;foo.&lt;em&gt;max-1&lt;/em&gt;.log&lt;/code&gt; will be renamed as</em>
<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * &lt;code&gt;foo.&lt;em&gt;max&lt;/em&gt;.log&lt;/code&gt;, the file &lt;code&gt;foo.&lt;em&gt;max-2&lt;/em&gt;.log&lt;/code&gt;</em>
<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * renamed as &lt;code&gt;foo.&lt;em&gt;max-1&lt;/em&gt;.log&lt;/code&gt;, and so on,</em>
<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * the file &lt;code&gt;foo.&lt;em&gt;min+1&lt;/em&gt;.log&lt;/code&gt; renamed as</em>
<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * &lt;code&gt;foo.&lt;em&gt;min+2&lt;/em&gt;.log&lt;/code&gt;. Lastly, the active file &lt;code&gt;foo.log&lt;/code&gt;</em>
<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * will be renamed as &lt;code&gt;foo.&lt;em&gt;min&lt;/em&gt;.log&lt;/code&gt; and a new active file name</em>
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * &lt;code&gt;foo.log&lt;/code&gt; will be created.</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * &lt;p&gt;Given that this rollover algorithm requires as many file renaming</em>
<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * operations as the window size, large window sizes are discouraged. The</em>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * current implementation will automatically reduce the window size to 12 when</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * larger values are specified by the user.</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> @Plugin(name = <span class="jxr_string">"DefaultRolloverStrategy"</span>, type = <span class="jxr_string">"Core"</span>, printObject = <strong class="jxr_keyword">true</strong>)
<a class="jxr_linenumber" name="66" href="#66">66</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">implements</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/RolloverStrategy.html">RolloverStrategy</a> {
<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * Allow subclasses access to the status logger without creating another instance.</em>
<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="70" href="#70">70</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = StatusLogger.getLogger();
<a class="jxr_linenumber" name="71" href="#71">71</a>
<a class="jxr_linenumber" name="72" href="#72">72</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="73" href="#73">73</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="74" href="#74">74</a>
<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * Index for oldest retained log file.</em>
<a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="78" href="#78">78</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="79" href="#79">79</a>
<a class="jxr_linenumber" name="80" href="#80">80</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * Index for most recent log file.</em>
<a class="jxr_linenumber" name="82" href="#82">82</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="83" href="#83">83</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="84" href="#84">84</a>
<a class="jxr_linenumber" name="85" href="#85">85</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html">StrSubstitutor</a> subst;
<a class="jxr_linenumber" name="86" href="#86">86</a>
<a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * Constructs a new instance.</em>
<a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @param min The minimum index.</em>
<a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * @param max The maximum index.</em>
<a class="jxr_linenumber" name="91" href="#91">91</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/DefaultRolloverStrategy.html">DefaultRolloverStrategy</a>(<strong class="jxr_keyword">int</strong> min, <strong class="jxr_keyword">int</strong> max, <a href="../../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html">StrSubstitutor</a> subst) {
<a class="jxr_linenumber" name="93" href="#93">93</a> minIndex = min;
<a class="jxr_linenumber" name="94" href="#94">94</a> maxIndex = max;
<a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">this</strong>.subst = subst;
<a class="jxr_linenumber" name="96" href="#96">96</a> }
<a class="jxr_linenumber" name="97" href="#97">97</a>
<a class="jxr_linenumber" name="98" href="#98">98</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * Perform the rollover.</em>
<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * @param manager The RollingFileManager name for current active log file.</em>
<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * @return A RolloverDescription.</em>
<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * @throws SecurityException if an error occurs.</em>
<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="104" href="#104">104</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/RolloverDescription.html">RolloverDescription</a> rollover(<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="105" href="#105">105</a> <strong class="jxr_keyword">if</strong> (maxIndex &gt;= 0) {
<a class="jxr_linenumber" name="106" href="#106">106</a> <strong class="jxr_keyword">int</strong> purgeStart = minIndex;
<a class="jxr_linenumber" name="107" href="#107">107</a>
<a class="jxr_linenumber" name="108" href="#108">108</a> <strong class="jxr_keyword">if</strong> (!purge(purgeStart, maxIndex, manager)) {
<a class="jxr_linenumber" name="109" href="#109">109</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="110" href="#110">110</a> }
<a class="jxr_linenumber" name="111" href="#111">111</a>
<a class="jxr_linenumber" name="112" href="#112">112</a> StringBuilder buf = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="113" href="#113">113</a> manager.getProcessor().formatFileName(purgeStart, buf);
<a class="jxr_linenumber" name="114" href="#114">114</a> String currentFileName = manager.getFileName();
<a class="jxr_linenumber" name="115" href="#115">115</a>
<a class="jxr_linenumber" name="116" href="#116">116</a> String renameTo = subst.replace(buf);
<a class="jxr_linenumber" name="117" href="#117">117</a> String compressedName = renameTo;
<a class="jxr_linenumber" name="118" href="#118">118</a> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/helper/Action.html">Action</a> compressAction = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="119" href="#119">119</a>
<a class="jxr_linenumber" name="120" href="#120">120</a> <strong class="jxr_keyword">if</strong> (renameTo.endsWith(<span class="jxr_string">".gz"</span>)) {
<a class="jxr_linenumber" name="121" href="#121">121</a> renameTo = renameTo.substring(0, renameTo.length() - 3);
<a class="jxr_linenumber" name="122" href="#122">122</a> compressAction = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/helper/GZCompressAction.html">GZCompressAction</a>(<strong class="jxr_keyword">new</strong> File(renameTo), <strong class="jxr_keyword">new</strong> File(compressedName), <strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="123" href="#123">123</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (renameTo.endsWith(<span class="jxr_string">".zip"</span>)) {
<a class="jxr_linenumber" name="124" href="#124">124</a> renameTo = renameTo.substring(0, renameTo.length() - 4);
<a class="jxr_linenumber" name="125" href="#125">125</a> compressAction = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/helper/ZipCompressAction.html">ZipCompressAction</a>(<strong class="jxr_keyword">new</strong> File(renameTo), <strong class="jxr_keyword">new</strong> File(compressedName), <strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="126" href="#126">126</a> }
<a class="jxr_linenumber" name="127" href="#127">127</a>
<a class="jxr_linenumber" name="128" href="#128">128</a> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/helper/FileRenameAction.html">FileRenameAction</a> renameAction =
<a class="jxr_linenumber" name="129" href="#129">129</a> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/helper/FileRenameAction.html">FileRenameAction</a>(<strong class="jxr_keyword">new</strong> File(currentFileName), <strong class="jxr_keyword">new</strong> File(renameTo), false);
<a class="jxr_linenumber" name="130" href="#130">130</a>
<a class="jxr_linenumber" name="131" href="#131">131</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, compressAction);
<a class="jxr_linenumber" name="132" href="#132">132</a> }
<a class="jxr_linenumber" name="133" href="#133">133</a>
<a class="jxr_linenumber" name="134" href="#134">134</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="135" href="#135">135</a> }
<a class="jxr_linenumber" name="136" href="#136">136</a>
<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * Purge and rename old log files in preparation for rollover</em>
<a class="jxr_linenumber" name="139" href="#139">139</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * @param lowIndex low index</em>
<a class="jxr_linenumber" name="141" href="#141">141</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="142" href="#142">142</a> <em class="jxr_javadoccomment"> * @param manager The RollingFileManager</em>
<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * @return true if purge was successful and rollover should be attempted.</em>
<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="145" href="#145">145</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</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, <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/RollingFileManager.html">RollingFileManager</a> manager) {
<a class="jxr_linenumber" name="146" href="#146">146</a> <strong class="jxr_keyword">int</strong> suffixLength = 0;
<a class="jxr_linenumber" name="147" href="#147">147</a>
<a class="jxr_linenumber" name="148" href="#148">148</a> List&lt;FileRenameAction&gt; renames = <strong class="jxr_keyword">new</strong> ArrayList&lt;FileRenameAction&gt;();
<a class="jxr_linenumber" name="149" href="#149">149</a> StringBuilder buf = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="150" href="#150">150</a> manager.getProcessor().formatFileName(lowIndex, buf);
<a class="jxr_linenumber" name="151" href="#151">151</a>
<a class="jxr_linenumber" name="152" href="#152">152</a> String lowFilename = subst.replace(buf);
<a class="jxr_linenumber" name="153" href="#153">153</a>
<a class="jxr_linenumber" name="154" href="#154">154</a> <strong class="jxr_keyword">if</strong> (lowFilename.endsWith(<span class="jxr_string">".gz"</span>)) {
<a class="jxr_linenumber" name="155" href="#155">155</a> suffixLength = 3;
<a class="jxr_linenumber" name="156" href="#156">156</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (lowFilename.endsWith(<span class="jxr_string">".zip"</span>)) {
<a class="jxr_linenumber" name="157" href="#157">157</a> suffixLength = 4;
<a class="jxr_linenumber" name="158" href="#158">158</a> }
<a class="jxr_linenumber" name="159" href="#159">159</a>
<a class="jxr_linenumber" name="160" href="#160">160</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = lowIndex; i &lt;= highIndex; i++) {
<a class="jxr_linenumber" name="161" href="#161">161</a> File toRename = <strong class="jxr_keyword">new</strong> File(lowFilename);
<a class="jxr_linenumber" name="162" href="#162">162</a> <strong class="jxr_keyword">boolean</strong> isBase = false;
<a class="jxr_linenumber" name="163" href="#163">163</a>
<a class="jxr_linenumber" name="164" href="#164">164</a> <strong class="jxr_keyword">if</strong> (suffixLength &gt; 0) {
<a class="jxr_linenumber" name="165" href="#165">165</a> File toRenameBase =
<a class="jxr_linenumber" name="166" href="#166">166</a> <strong class="jxr_keyword">new</strong> File(lowFilename.substring(0, lowFilename.length() - suffixLength));
<a class="jxr_linenumber" name="167" href="#167">167</a>
<a class="jxr_linenumber" name="168" href="#168">168</a> <strong class="jxr_keyword">if</strong> (toRename.exists()) {
<a class="jxr_linenumber" name="169" href="#169">169</a> <strong class="jxr_keyword">if</strong> (toRenameBase.exists()) {
<a class="jxr_linenumber" name="170" href="#170">170</a> toRenameBase.delete();
<a class="jxr_linenumber" name="171" href="#171">171</a> }
<a class="jxr_linenumber" name="172" href="#172">172</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="173" href="#173">173</a> toRename = toRenameBase;
<a class="jxr_linenumber" name="174" href="#174">174</a> isBase = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="175" href="#175">175</a> }
<a class="jxr_linenumber" name="176" href="#176">176</a> }
<a class="jxr_linenumber" name="177" href="#177">177</a>
<a class="jxr_linenumber" name="178" href="#178">178</a> <strong class="jxr_keyword">if</strong> (toRename.exists()) {
<a class="jxr_linenumber" name="179" href="#179">179</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="180" href="#180">180</a> <em class="jxr_comment">// if at upper index then</em>
<a class="jxr_linenumber" name="181" href="#181">181</a> <em class="jxr_comment">// attempt to delete last file</em>
<a class="jxr_linenumber" name="182" href="#182">182</a> <em class="jxr_comment">// if that fails then abandon purge</em>
<a class="jxr_linenumber" name="183" href="#183">183</a> <strong class="jxr_keyword">if</strong> (i == highIndex) {
<a class="jxr_linenumber" name="184" href="#184">184</a> <strong class="jxr_keyword">if</strong> (!toRename.delete()) {
<a class="jxr_linenumber" name="185" href="#185">185</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="186" href="#186">186</a> }
<a class="jxr_linenumber" name="187" href="#187">187</a>
<a class="jxr_linenumber" name="188" href="#188">188</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="189" href="#189">189</a> }
<a class="jxr_linenumber" name="190" href="#190">190</a>
<a class="jxr_linenumber" name="191" href="#191">191</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="192" href="#192">192</a> <em class="jxr_comment">// if intermediate index</em>
<a class="jxr_linenumber" name="193" href="#193">193</a> <em class="jxr_comment">// add a rename action to the list</em>
<a class="jxr_linenumber" name="194" href="#194">194</a> buf.setLength(0);
<a class="jxr_linenumber" name="195" href="#195">195</a> manager.getProcessor().formatFileName(i + 1, buf);
<a class="jxr_linenumber" name="196" href="#196">196</a>
<a class="jxr_linenumber" name="197" href="#197">197</a> String highFilename = subst.replace(buf);
<a class="jxr_linenumber" name="198" href="#198">198</a> String renameTo = highFilename;
<a class="jxr_linenumber" name="199" href="#199">199</a>
<a class="jxr_linenumber" name="200" href="#200">200</a> <strong class="jxr_keyword">if</strong> (isBase) {
<a class="jxr_linenumber" name="201" href="#201">201</a> renameTo = highFilename.substring(0, highFilename.length() - suffixLength);
<a class="jxr_linenumber" name="202" href="#202">202</a> }
<a class="jxr_linenumber" name="203" href="#203">203</a>
<a class="jxr_linenumber" name="204" href="#204">204</a> renames.add(<strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/helper/FileRenameAction.html">FileRenameAction</a>(toRename, <strong class="jxr_keyword">new</strong> File(renameTo), <strong class="jxr_keyword">true</strong>));
<a class="jxr_linenumber" name="205" href="#205">205</a> lowFilename = highFilename;
<a class="jxr_linenumber" name="206" href="#206">206</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="207" href="#207">207</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="208" href="#208">208</a> }
<a class="jxr_linenumber" name="209" href="#209">209</a> }
<a class="jxr_linenumber" name="210" href="#210">210</a>
<a class="jxr_linenumber" name="211" href="#211">211</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="212" href="#212">212</a> <em class="jxr_comment">// work renames backwards</em>
<a class="jxr_linenumber" name="213" href="#213">213</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="214" href="#214">214</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = renames.size() - 1; i &gt;= 0; i--) {
<a class="jxr_linenumber" name="215" href="#215">215</a> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/helper/Action.html">Action</a> action = renames.get(i);
<a class="jxr_linenumber" name="216" href="#216">216</a>
<a class="jxr_linenumber" name="217" href="#217">217</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="218" href="#218">218</a> <strong class="jxr_keyword">if</strong> (!action.execute()) {
<a class="jxr_linenumber" name="219" href="#219">219</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="220" href="#220">220</a> }
<a class="jxr_linenumber" name="221" href="#221">221</a> } <strong class="jxr_keyword">catch</strong> (Exception ex) {
<a class="jxr_linenumber" name="222" href="#222">222</a> LOGGER.warn(<span class="jxr_string">"Exception during purge in RollingFileAppender"</span>, ex);
<a class="jxr_linenumber" name="223" href="#223">223</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="224" href="#224">224</a> }
<a class="jxr_linenumber" name="225" href="#225">225</a> }
<a class="jxr_linenumber" name="226" href="#226">226</a>
<a class="jxr_linenumber" name="227" href="#227">227</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="228" href="#228">228</a> }
<a class="jxr_linenumber" name="229" href="#229">229</a>
<a class="jxr_linenumber" name="230" href="#230">230</a> @Override
<a class="jxr_linenumber" name="231" href="#231">231</a> <strong class="jxr_keyword">public</strong> String toString() {
<a class="jxr_linenumber" name="232" href="#232">232</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">")"</span>;
<a class="jxr_linenumber" name="233" href="#233">233</a> }
<a class="jxr_linenumber" name="234" href="#234">234</a>
<a class="jxr_linenumber" name="235" href="#235">235</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="236" href="#236">236</a> <em class="jxr_javadoccomment"> * Create the DefaultRolloverStrategy.</em>
<a class="jxr_linenumber" name="237" href="#237">237</a> <em class="jxr_javadoccomment"> * @param max The maximum number of files to keep.</em>
<a class="jxr_linenumber" name="238" href="#238">238</a> <em class="jxr_javadoccomment"> * @param min The minimum number of files to keep.</em>
<a class="jxr_linenumber" name="239" href="#239">239</a> <em class="jxr_javadoccomment"> * @param config The Configuration.</em>
<a class="jxr_linenumber" name="240" href="#240">240</a> <em class="jxr_javadoccomment"> * @return A DefaultRolloverStrategy.</em>
<a class="jxr_linenumber" name="241" href="#241">241</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="242" href="#242">242</a> @PluginFactory
<a class="jxr_linenumber" name="243" href="#243">243</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(@PluginAttr(<span class="jxr_string">"max"</span>) String max,
<a class="jxr_linenumber" name="244" href="#244">244</a> @PluginAttr(<span class="jxr_string">"min"</span>) String min,
<a class="jxr_linenumber" name="245" href="#245">245</a> @PluginConfiguration <a href="../../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config) {
<a class="jxr_linenumber" name="246" href="#246">246</a>
<a class="jxr_linenumber" name="247" href="#247">247</a> <strong class="jxr_keyword">int</strong> minIndex;
<a class="jxr_linenumber" name="248" href="#248">248</a> <strong class="jxr_keyword">if</strong> (min != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="249" href="#249">249</a> minIndex = Integer.parseInt(min);
<a class="jxr_linenumber" name="250" href="#250">250</a> <strong class="jxr_keyword">if</strong> (minIndex &lt; 1) {
<a class="jxr_linenumber" name="251" href="#251">251</a> LOGGER.error(<span class="jxr_string">"Minimum window size too small. Limited to "</span> + MIN_WINDOW_SIZE);
<a class="jxr_linenumber" name="252" href="#252">252</a> minIndex = MIN_WINDOW_SIZE;
<a class="jxr_linenumber" name="253" href="#253">253</a> }
<a class="jxr_linenumber" name="254" href="#254">254</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="255" href="#255">255</a> minIndex = MIN_WINDOW_SIZE;
<a class="jxr_linenumber" name="256" href="#256">256</a> }
<a class="jxr_linenumber" name="257" href="#257">257</a> <strong class="jxr_keyword">int</strong> maxIndex;
<a class="jxr_linenumber" name="258" href="#258">258</a> <strong class="jxr_keyword">if</strong> (max != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="259" href="#259">259</a> maxIndex = Integer.parseInt(max);
<a class="jxr_linenumber" name="260" href="#260">260</a> <strong class="jxr_keyword">if</strong> (maxIndex &lt; minIndex) {
<a class="jxr_linenumber" name="261" href="#261">261</a> maxIndex = minIndex &lt; DEFAULT_WINDOW_SIZE ? DEFAULT_WINDOW_SIZE : minIndex;
<a class="jxr_linenumber" name="262" href="#262">262</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="263" href="#263">263</a> }
<a class="jxr_linenumber" name="264" href="#264">264</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="265" href="#265">265</a> maxIndex = DEFAULT_WINDOW_SIZE;
<a class="jxr_linenumber" name="266" href="#266">266</a> }
<a class="jxr_linenumber" name="267" href="#267">267</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, config.getSubst());
<a class="jxr_linenumber" name="268" href="#268">268</a> }
<a class="jxr_linenumber" name="269" href="#269">269</a>
<a class="jxr_linenumber" name="270" href="#270">270</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>