Google Git
Sign in
apache / logging-log4j-site / d0d0de55986756593c08e5d2b8059541eacaf428 / . / log4j-2.0-alpha1-SNAPSHOT / log4j-core / xref / org / apache / logging / log4j / core / appender / rolling / helper / GZCompressAction.html
blob: 5563de5b0e797d853ba378ba4e043b9ce0fc204a [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>GZCompressAction 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/helper/GZCompressAction.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.helper;
<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> java.io.BufferedOutputStream;
<a class="jxr_linenumber" name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.FileOutputStream;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="24" href="#24">24</a>
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.zip.GZIPOutputStream;
<a class="jxr_linenumber" name="26" href="#26">26</a>
<a class="jxr_linenumber" name="27" href="#27">27</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * Compresses a file using GZ compression.</em>
<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/helper/GZCompressAction.html">GZCompressAction</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/helper/ActionBase.html">ActionBase</a> {
<a class="jxr_linenumber" name="31" href="#31">31</a>
<a class="jxr_linenumber" name="32" href="#32">32</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> BUF_SIZE = 8102;
<a class="jxr_linenumber" name="33" href="#33">33</a>
<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * Source file.</em>
<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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> File source;
<a class="jxr_linenumber" name="38" href="#38">38</a>
<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * Destination file.</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="42" href="#42">42</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> File destination;
<a class="jxr_linenumber" name="43" href="#43">43</a>
<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * If true, attempt to delete file on completion.</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="47" href="#47">47</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> deleteSource;
<a class="jxr_linenumber" name="48" href="#48">48</a>
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * Create new instance of GZCompressAction.</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * @param source file to compress, may not be null.</em>
<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @param destination compressed file, may not be null.</em>
<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @param deleteSource if true, attempt to delete file on completion. Failure to delete</em>
<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * does not cause an exception to be thrown or affect return value.</em>
<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="57" href="#57">57</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/helper/GZCompressAction.html">GZCompressAction</a>(<strong class="jxr_keyword">final</strong> File source, <strong class="jxr_keyword">final</strong> File destination, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> deleteSource) {
<a class="jxr_linenumber" name="58" href="#58">58</a> <strong class="jxr_keyword">if</strong> (source == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="59" href="#59">59</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"source"</span>);
<a class="jxr_linenumber" name="60" href="#60">60</a> }
<a class="jxr_linenumber" name="61" href="#61">61</a>
<a class="jxr_linenumber" name="62" href="#62">62</a> <strong class="jxr_keyword">if</strong> (destination == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="63" href="#63">63</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"destination"</span>);
<a class="jxr_linenumber" name="64" href="#64">64</a> }
<a class="jxr_linenumber" name="65" href="#65">65</a>
<a class="jxr_linenumber" name="66" href="#66">66</a> <strong class="jxr_keyword">this</strong>.source = source;
<a class="jxr_linenumber" name="67" href="#67">67</a> <strong class="jxr_keyword">this</strong>.destination = destination;
<a class="jxr_linenumber" name="68" href="#68">68</a> <strong class="jxr_keyword">this</strong>.deleteSource = deleteSource;
<a class="jxr_linenumber" name="69" href="#69">69</a> }
<a class="jxr_linenumber" name="70" href="#70">70</a>
<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * Compress.</em>
<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @return true if successfully compressed.</em>
<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * @throws IOException on IO exception.</em>
<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="77" href="#77">77</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> execute() <strong class="jxr_keyword">throws</strong> IOException {
<a class="jxr_linenumber" name="78" href="#78">78</a> <strong class="jxr_keyword">return</strong> execute(source, destination, deleteSource);
<a class="jxr_linenumber" name="79" href="#79">79</a> }
<a class="jxr_linenumber" name="80" href="#80">80</a>
<a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * Compress a file.</em>
<a class="jxr_linenumber" name="83" href="#83">83</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * @param source file to compress, may not be null.</em>
<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @param destination compressed file, may not be null.</em>
<a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * @param deleteSource if true, attempt to delete file on completion. Failure to delete</em>
<a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * does not cause an exception to be thrown or affect return value.</em>
<a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @return true if source file compressed.</em>
<a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @throws IOException on IO exception.</em>
<a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="91" href="#91">91</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> execute(<strong class="jxr_keyword">final</strong> File source, <strong class="jxr_keyword">final</strong> File destination, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> deleteSource)
<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">throws</strong> IOException {
<a class="jxr_linenumber" name="93" href="#93">93</a> <strong class="jxr_keyword">if</strong> (source.exists()) {
<a class="jxr_linenumber" name="94" href="#94">94</a> FileInputStream fis = <strong class="jxr_keyword">new</strong> FileInputStream(source);
<a class="jxr_linenumber" name="95" href="#95">95</a> FileOutputStream fos = <strong class="jxr_keyword">new</strong> FileOutputStream(destination);
<a class="jxr_linenumber" name="96" href="#96">96</a> GZIPOutputStream gzos = <strong class="jxr_keyword">new</strong> GZIPOutputStream(fos);
<a class="jxr_linenumber" name="97" href="#97">97</a> BufferedOutputStream os = <strong class="jxr_keyword">new</strong> BufferedOutputStream(gzos);
<a class="jxr_linenumber" name="98" href="#98">98</a> byte[] inbuf = <strong class="jxr_keyword">new</strong> byte[BUF_SIZE];
<a class="jxr_linenumber" name="99" href="#99">99</a> <strong class="jxr_keyword">int</strong> n;
<a class="jxr_linenumber" name="100" href="#100">100</a>
<a class="jxr_linenumber" name="101" href="#101">101</a> <strong class="jxr_keyword">while</strong> ((n = fis.read(inbuf)) != -1) {
<a class="jxr_linenumber" name="102" href="#102">102</a> os.write(inbuf, 0, n);
<a class="jxr_linenumber" name="103" href="#103">103</a> }
<a class="jxr_linenumber" name="104" href="#104">104</a>
<a class="jxr_linenumber" name="105" href="#105">105</a> os.close();
<a class="jxr_linenumber" name="106" href="#106">106</a> fis.close();
<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> (deleteSource &amp;&amp; !source.delete()) {
<a class="jxr_linenumber" name="109" href="#109">109</a> LOGGER.warn(<span class="jxr_string">"Unable to delete "</span> + source.toString() + <span class="jxr_string">"."</span>);
<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> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="113" href="#113">113</a> }
<a class="jxr_linenumber" name="114" href="#114">114</a>
<a class="jxr_linenumber" name="115" href="#115">115</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="116" href="#116">116</a> }
<a class="jxr_linenumber" name="117" href="#117">117</a>
<a class="jxr_linenumber" name="118" href="#118">118</a>
<a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * Capture exception.</em>
<a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * @param ex exception.</em>
<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="124" href="#124">124</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> reportException(<strong class="jxr_keyword">final</strong> Exception ex) {
<a class="jxr_linenumber" name="125" href="#125">125</a> LOGGER.warn(<span class="jxr_string">"Exception during compression of '"</span> + source.toString() + <span class="jxr_string">"'."</span>, ex);
<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> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>