| <!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>FileManager 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/FileManager.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; |
| <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.FileOutputStream; |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.IOException; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.OutputStream; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.Serializable; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.nio.ByteBuffer; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.nio.channels.FileChannel; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.nio.channels.FileLock; |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.nio.file.FileSystems; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.nio.file.Files; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.nio.file.Path; |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.nio.file.Paths; |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.nio.file.attribute.FileOwnerAttributeView; |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.nio.file.attribute.FileTime; |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> java.nio.file.attribute.PosixFileAttributeView; |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> java.nio.file.attribute.PosixFilePermission; |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> java.nio.file.attribute.PosixFilePermissions; |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> java.util.Date; |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> java.util.HashMap; |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> java.util.Set; |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.Layout; |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.LoggerContext; |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.Configuration; |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.util.Constants; |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.util.FileUtils; |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> |
| <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"> * Manages actual File I/O for File Appenders.</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html">FileManager</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html">OutputStreamManager</a> { |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html">FileManagerFactory</a> FACTORY = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html">FileManagerFactory</a>(); |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> isAppend; |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> createOnDemand; |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> isLocking; |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String advertiseURI; |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> bufferSize; |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Set<PosixFilePermission> filePermissions; |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String fileOwner; |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String fileGroup; |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> attributeViewEnabled; |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * @deprecated</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> @Deprecated |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html">FileManager</a>(<strong class="jxr_keyword">final</strong> String fileName, <strong class="jxr_keyword">final</strong> OutputStream os, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> append, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> locking, |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">final</strong> String advertiseURI, <strong class="jxr_keyword">final</strong> Layout<? <strong class="jxr_keyword">extends</strong> Serializable> layout, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> bufferSize, |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> writeHeader) { |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">this</strong>(fileName, os, append, locking, advertiseURI, layout, writeHeader, ByteBuffer.wrap(<strong class="jxr_keyword">new</strong> byte[bufferSize])); |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> } |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * @deprecated</em> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * @since 2.6</em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> @Deprecated |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html">FileManager</a>(<strong class="jxr_keyword">final</strong> String fileName, <strong class="jxr_keyword">final</strong> OutputStream os, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> append, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> locking, |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">final</strong> String advertiseURI, <strong class="jxr_keyword">final</strong> Layout<? <strong class="jxr_keyword">extends</strong> Serializable> layout, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> writeHeader, |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">final</strong> ByteBuffer buffer) { |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">super</strong>(os, fileName, layout, writeHeader, buffer); |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">this</strong>.isAppend = append; |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">this</strong>.createOnDemand = false; |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">this</strong>.isLocking = locking; |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">this</strong>.advertiseURI = advertiseURI; |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">this</strong>.bufferSize = buffer.capacity(); |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">this</strong>.filePermissions = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">this</strong>.fileOwner = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">this</strong>.fileGroup = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">this</strong>.attributeViewEnabled = false; |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> } |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * @deprecated</em> |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @since 2.7</em> |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> @Deprecated |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html">FileManager</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html">LoggerContext</a> loggerContext, <strong class="jxr_keyword">final</strong> String fileName, <strong class="jxr_keyword">final</strong> OutputStream os, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> append, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> locking, |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> createOnDemand, <strong class="jxr_keyword">final</strong> String advertiseURI, <strong class="jxr_keyword">final</strong> Layout<? <strong class="jxr_keyword">extends</strong> Serializable> layout, |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> writeHeader, <strong class="jxr_keyword">final</strong> ByteBuffer buffer) { |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">super</strong>(loggerContext, os, fileName, createOnDemand, layout, writeHeader, buffer); |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">this</strong>.isAppend = append; |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">this</strong>.createOnDemand = createOnDemand; |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">this</strong>.isLocking = locking; |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">this</strong>.advertiseURI = advertiseURI; |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">this</strong>.bufferSize = buffer.capacity(); |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">this</strong>.filePermissions = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">this</strong>.fileOwner = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">this</strong>.fileGroup = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">this</strong>.attributeViewEnabled = false; |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> } |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * @since 2.9</em> |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html">FileManager</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html">LoggerContext</a> loggerContext, <strong class="jxr_keyword">final</strong> String fileName, <strong class="jxr_keyword">final</strong> OutputStream os, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> append, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> locking, |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> createOnDemand, <strong class="jxr_keyword">final</strong> String advertiseURI, <strong class="jxr_keyword">final</strong> Layout<? <strong class="jxr_keyword">extends</strong> Serializable> layout, |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">final</strong> String filePermissions, <strong class="jxr_keyword">final</strong> String fileOwner, <strong class="jxr_keyword">final</strong> String fileGroup, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> writeHeader, |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">final</strong> ByteBuffer buffer) { |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">super</strong>(loggerContext, os, fileName, createOnDemand, layout, writeHeader, buffer); |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">this</strong>.isAppend = append; |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">this</strong>.createOnDemand = createOnDemand; |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">this</strong>.isLocking = locking; |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">this</strong>.advertiseURI = advertiseURI; |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">this</strong>.bufferSize = buffer.capacity(); |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">final</strong> Set<String> views = FileSystems.getDefault().supportedFileAttributeViews(); |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">if</strong> (views.contains(<span class="jxr_string">"posix"</span>)) { |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">this</strong>.filePermissions = filePermissions != <strong class="jxr_keyword">null</strong> ? PosixFilePermissions.fromString(filePermissions) : <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">this</strong>.fileGroup = fileGroup; |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">this</strong>.filePermissions = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">this</strong>.fileGroup = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">if</strong> (filePermissions != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> LOGGER.warn(<span class="jxr_string">"Posix file attribute permissions defined but it is not supported by this files system."</span>); |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> } |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">if</strong> (fileGroup != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> LOGGER.warn(<span class="jxr_string">"Posix file attribute group defined but it is not supported by this files system."</span>); |
| <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">if</strong> (views.contains(<span class="jxr_string">"owner"</span>)) { |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">this</strong>.fileOwner = fileOwner; |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">this</strong>.fileOwner = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">if</strong> (fileOwner != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> LOGGER.warn(<span class="jxr_string">"Owner file attribute defined but it is not supported by this files system."</span>); |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> } |
| <a class="jxr_linenumber" name="L151" href="#L151">151</a> } |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_comment">// Supported and defined</em> |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">this</strong>.attributeViewEnabled = <strong class="jxr_keyword">this</strong>.filePermissions != <strong class="jxr_keyword">null</strong> || <strong class="jxr_keyword">this</strong>.fileOwner != <strong class="jxr_keyword">null</strong> || <strong class="jxr_keyword">this</strong>.fileGroup != <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> } |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> |
| <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"> * Returns the FileManager.</em> |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * @param fileName The name of the file to manage.</em> |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * @param append true if the file should be appended to, false if it should be overwritten.</em> |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * @param locking true if the file should be locked while writing, false otherwise.</em> |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * @param bufferedIo true if the contents should be buffered as they are written.</em> |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * @param createOnDemand true if you want to lazy-create the file (a.k.a. on-demand.)</em> |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * @param advertiseUri the URI to use when advertising the file</em> |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * @param layout The layout</em> |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * @param bufferSize buffer size for buffered IO</em> |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * @param filePermissions File permissions</em> |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * @param fileOwner File owner</em> |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * @param fileGroup File group</em> |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * @param configuration The configuration.</em> |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * @return A FileManager for the File.</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html">FileManager</a> getFileManager(<strong class="jxr_keyword">final</strong> String fileName, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> append, <strong class="jxr_keyword">boolean</strong> locking, |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> bufferedIo, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> createOnDemand, <strong class="jxr_keyword">final</strong> String advertiseUri, |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">final</strong> Layout<? <strong class="jxr_keyword">extends</strong> Serializable> layout, |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> bufferSize, <strong class="jxr_keyword">final</strong> String filePermissions, <strong class="jxr_keyword">final</strong> String fileOwner, <strong class="jxr_keyword">final</strong> String fileGroup, |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> configuration) { |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">if</strong> (locking && bufferedIo) { |
| <a class="jxr_linenumber" name="L180" href="#L180">180</a> locking = false; |
| <a class="jxr_linenumber" name="L181" href="#L181">181</a> } |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">return</strong> narrow(FileManager.<strong class="jxr_keyword">class</strong>, getManager(fileName, <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/WriterAppender.html">FactoryData</a>(append, locking, bufferedIo, bufferSize, |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> createOnDemand, advertiseUri, layout, filePermissions, fileOwner, fileGroup, configuration), FACTORY)); |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> } |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> @Override |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">protected</strong> OutputStream createOutputStream() <strong class="jxr_keyword">throws</strong> IOException { |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">final</strong> String filename = getFileName(); |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> LOGGER.debug(<span class="jxr_string">"Now writing to {} at {}"</span>, filename, <strong class="jxr_keyword">new</strong> Date()); |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">final</strong> File file = <strong class="jxr_keyword">new</strong> File(filename); |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">final</strong> FileOutputStream fos = <strong class="jxr_keyword">new</strong> FileOutputStream(file, isAppend); |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">if</strong> (file.exists() && file.length() == 0) { |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> FileTime now = FileTime.fromMillis(System.currentTimeMillis()); |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> Files.setAttribute(file.toPath(), <span class="jxr_string">"creationTime"</span>, now); |
| <a class="jxr_linenumber" name="L196" href="#L196">196</a> } <strong class="jxr_keyword">catch</strong> (Exception ex) { |
| <a class="jxr_linenumber" name="L197" href="#L197">197</a> LOGGER.warn(<span class="jxr_string">"Unable to set current file tiem for {}"</span>, filename); |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> } |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> } |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> defineAttributeView(Paths.get(filename)); |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">return</strong> fos; |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> } |
| <a class="jxr_linenumber" name="L203" href="#L203">203</a> |
| <a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> defineAttributeView(<strong class="jxr_keyword">final</strong> Path path) { |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">if</strong> (attributeViewEnabled) { |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_comment">// FileOutputStream may not create new file on all jvm</em> |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> path.toFile().createNewFile(); |
| <a class="jxr_linenumber" name="L209" href="#L209">209</a> |
| <a class="jxr_linenumber" name="L210" href="#L210">210</a> FileUtils.defineFilePosixAttributeView(path, filePermissions, fileOwner, fileGroup); |
| <a class="jxr_linenumber" name="L211" href="#L211">211</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> Exception e) { |
| <a class="jxr_linenumber" name="L212" href="#L212">212</a> LOGGER.error(<span class="jxr_string">"Could not define attribute view on path \"{}\" got {}"</span>, path, e.getMessage(), e); |
| <a class="jxr_linenumber" name="L213" href="#L213">213</a> } |
| <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> |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> @Override |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> write(<strong class="jxr_keyword">final</strong> byte[] bytes, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> offset, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> length, |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> immediateFlush) { |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">if</strong> (isLocking) { |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L222" href="#L222">222</a> @SuppressWarnings(<span class="jxr_string">"resource"</span>) |
| <a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">final</strong> FileChannel channel = ((FileOutputStream) getOutputStream()).getChannel(); |
| <a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_comment"> * Lock the whole file. This could be optimized to only lock from the current file position. Note that</em> |
| <a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_comment"> * locking may be advisory on some systems and mandatory on others, so locking just from the current</em> |
| <a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_comment"> * position would allow reading on systems where locking is mandatory. Also, Java 6 will throw an</em> |
| <a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_comment"> * exception if the region of the file is already locked by another FileChannel in the same JVM.</em> |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_comment"> * Hopefully, that will be avoided since every file should have a single file manager - unless two</em> |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_comment"> * different files strings are configured that somehow map to the same file.</em> |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">try</strong> (<strong class="jxr_keyword">final</strong> FileLock lock = channel.lock(0, Long.MAX_VALUE, false)) { |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">super</strong>.write(bytes, offset, length, immediateFlush); |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> } |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException ex) { |
| <a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/AppenderLoggingException.html">AppenderLoggingException</a>(<span class="jxr_string">"Unable to obtain lock on "</span> + getName(), ex); |
| <a class="jxr_linenumber" name="L237" href="#L237">237</a> } |
| <a class="jxr_linenumber" name="L238" href="#L238">238</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">super</strong>.write(bytes, offset, length, immediateFlush); |
| <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> |
| <a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> * Overrides {@link OutputStreamManager#writeToDestination(byte[], int, int)} to add support for file locking.</em> |
| <a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> * @param bytes the array containing data</em> |
| <a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * @param offset from where to write</em> |
| <a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> * @param length how many bytes to write</em> |
| <a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> * @since 2.8</em> |
| <a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L251" href="#L251">251</a> @Override |
| <a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> writeToDestination(<strong class="jxr_keyword">final</strong> byte[] bytes, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> offset, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> length) { |
| <a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">if</strong> (isLocking) { |
| <a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L255" href="#L255">255</a> @SuppressWarnings(<span class="jxr_string">"resource"</span>) |
| <a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong class="jxr_keyword">final</strong> FileChannel channel = ((FileOutputStream) getOutputStream()).getChannel(); |
| <a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_comment"> * Lock the whole file. This could be optimized to only lock from the current file position. Note that</em> |
| <a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_comment"> * locking may be advisory on some systems and mandatory on others, so locking just from the current</em> |
| <a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_comment"> * position would allow reading on systems where locking is mandatory. Also, Java 6 will throw an</em> |
| <a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_comment"> * exception if the region of the file is already locked by another FileChannel in the same JVM.</em> |
| <a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_comment"> * Hopefully, that will be avoided since every file should have a single file manager - unless two</em> |
| <a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_comment"> * different files strings are configured that somehow map to the same file.</em> |
| <a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong class="jxr_keyword">try</strong> (<strong class="jxr_keyword">final</strong> FileLock lock = channel.lock(0, Long.MAX_VALUE, false)) { |
| <a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">super</strong>.writeToDestination(bytes, offset, length); |
| <a class="jxr_linenumber" name="L267" href="#L267">267</a> } |
| <a class="jxr_linenumber" name="L268" href="#L268">268</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException ex) { |
| <a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/AppenderLoggingException.html">AppenderLoggingException</a>(<span class="jxr_string">"Unable to obtain lock on "</span> + getName(), ex); |
| <a class="jxr_linenumber" name="L270" href="#L270">270</a> } |
| <a class="jxr_linenumber" name="L271" href="#L271">271</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">super</strong>.writeToDestination(bytes, offset, length); |
| <a class="jxr_linenumber" name="L273" href="#L273">273</a> } |
| <a class="jxr_linenumber" name="L274" href="#L274">274</a> } |
| <a class="jxr_linenumber" name="L275" href="#L275">275</a> |
| <a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> * Returns the name of the File being managed.</em> |
| <a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> * @return The name of the File being managed.</em> |
| <a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">public</strong> String getFileName() { |
| <a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">return</strong> getName(); |
| <a class="jxr_linenumber" name="L282" href="#L282">282</a> } |
| <a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * Returns the append status.</em> |
| <a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> * @return true if the file will be appended to, false if it is overwritten.</em> |
| <a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isAppend() { |
| <a class="jxr_linenumber" name="L288" href="#L288">288</a> <strong class="jxr_keyword">return</strong> isAppend; |
| <a class="jxr_linenumber" name="L289" href="#L289">289</a> } |
| <a class="jxr_linenumber" name="L290" href="#L290">290</a> |
| <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> <em class="jxr_javadoccomment"> * Returns the lazy-create.</em> |
| <a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> * @return true if the file will be lazy-created.</em> |
| <a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isCreateOnDemand() { |
| <a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">return</strong> createOnDemand; |
| <a class="jxr_linenumber" name="L297" href="#L297">297</a> } |
| <a class="jxr_linenumber" name="L298" href="#L298">298</a> |
| <a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> * Returns the lock status.</em> |
| <a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> * @return true if the file will be locked when writing, false otherwise.</em> |
| <a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isLocking() { |
| <a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong class="jxr_keyword">return</strong> isLocking; |
| <a class="jxr_linenumber" name="L305" href="#L305">305</a> } |
| <a class="jxr_linenumber" name="L306" href="#L306">306</a> |
| <a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> * Returns the buffer size to use if the appender was configured with BufferedIO=true, otherwise returns a negative</em> |
| <a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> * number.</em> |
| <a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment"> * @return the buffer size, or a negative number if the output stream is not buffered</em> |
| <a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L312" href="#L312">312</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getBufferSize() { |
| <a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">return</strong> bufferSize; |
| <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"> * Returns posix file permissions if defined and the OS supports posix file attribute,</em> |
| <a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> * null otherwise.</em> |
| <a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> * @return File posix permissions</em> |
| <a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> * @see PosixFileAttributeView</em> |
| <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> <strong class="jxr_keyword">public</strong> Set<PosixFilePermission> getFilePermissions() { |
| <a class="jxr_linenumber" name="L323" href="#L323">323</a> <strong class="jxr_keyword">return</strong> filePermissions; |
| <a class="jxr_linenumber" name="L324" href="#L324">324</a> } |
| <a class="jxr_linenumber" name="L325" href="#L325">325</a> |
| <a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> * Returns file owner if defined and the OS supports owner file attribute view,</em> |
| <a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * null otherwise.</em> |
| <a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * @return File owner</em> |
| <a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * @see FileOwnerAttributeView</em> |
| <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> <strong class="jxr_keyword">public</strong> String getFileOwner() { |
| <a class="jxr_linenumber" name="L333" href="#L333">333</a> <strong class="jxr_keyword">return</strong> fileOwner; |
| <a class="jxr_linenumber" name="L334" href="#L334">334</a> } |
| <a class="jxr_linenumber" name="L335" href="#L335">335</a> |
| <a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> * Returns file group if defined and the OS supports posix/group file attribute view,</em> |
| <a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_javadoccomment"> * null otherwise.</em> |
| <a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_javadoccomment"> * @return File group</em> |
| <a class="jxr_linenumber" name="L340" href="#L340">340</a> <em class="jxr_javadoccomment"> * @see PosixFileAttributeView</em> |
| <a class="jxr_linenumber" name="L341" href="#L341">341</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">public</strong> String getFileGroup() { |
| <a class="jxr_linenumber" name="L343" href="#L343">343</a> <strong class="jxr_keyword">return</strong> fileGroup; |
| <a class="jxr_linenumber" name="L344" href="#L344">344</a> } |
| <a class="jxr_linenumber" name="L345" href="#L345">345</a> |
| <a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_javadoccomment"> * Returns true if file attribute view enabled for this file manager.</em> |
| <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"> * @return True if posix or owner supported and defined false otherwise.</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isAttributeViewEnabled() { |
| <a class="jxr_linenumber" name="L352" href="#L352">352</a> <strong class="jxr_keyword">return</strong> attributeViewEnabled; |
| <a class="jxr_linenumber" name="L353" href="#L353">353</a> } |
| <a class="jxr_linenumber" name="L354" href="#L354">354</a> |
| <a class="jxr_linenumber" name="L355" href="#L355">355</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L356" href="#L356">356</a> <em class="jxr_javadoccomment"> * FileManager's content format is specified by: <code>Key: "fileURI" Value: provided "advertiseURI" param</code>.</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> <em class="jxr_javadoccomment"> * @return Map of content format keys supporting FileManager</em> |
| <a class="jxr_linenumber" name="L359" href="#L359">359</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L360" href="#L360">360</a> @Override |
| <a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">public</strong> Map<String, String> getContentFormat() { |
| <a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong class="jxr_keyword">final</strong> Map<String, String> result = <strong class="jxr_keyword">new</strong> HashMap<>(<strong class="jxr_keyword">super</strong>.getContentFormat()); |
| <a class="jxr_linenumber" name="L363" href="#L363">363</a> result.put(<span class="jxr_string">"fileURI"</span>, advertiseURI); |
| <a class="jxr_linenumber" name="L364" href="#L364">364</a> <strong class="jxr_keyword">return</strong> result; |
| <a class="jxr_linenumber" name="L365" href="#L365">365</a> } |
| <a class="jxr_linenumber" name="L366" href="#L366">366</a> |
| <a class="jxr_linenumber" name="L367" href="#L367">367</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_javadoccomment"> * Factory Data.</em> |
| <a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L370" href="#L370">370</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/WriterAppender.html">FactoryData</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/ConfigurationFactoryData.html">ConfigurationFactoryData</a> { |
| <a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> append; |
| <a class="jxr_linenumber" name="L372" href="#L372">372</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> locking; |
| <a class="jxr_linenumber" name="L373" href="#L373">373</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> bufferedIo; |
| <a class="jxr_linenumber" name="L374" href="#L374">374</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> bufferSize; |
| <a class="jxr_linenumber" name="L375" href="#L375">375</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> createOnDemand; |
| <a class="jxr_linenumber" name="L376" href="#L376">376</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String advertiseURI; |
| <a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Layout<? <strong class="jxr_keyword">extends</strong> Serializable> layout; |
| <a class="jxr_linenumber" name="L378" href="#L378">378</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String filePermissions; |
| <a class="jxr_linenumber" name="L379" href="#L379">379</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String fileOwner; |
| <a class="jxr_linenumber" name="L380" href="#L380">380</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String fileGroup; |
| <a class="jxr_linenumber" name="L381" href="#L381">381</a> |
| <a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_javadoccomment"> * Constructor.</em> |
| <a class="jxr_linenumber" name="L384" href="#L384">384</a> <em class="jxr_javadoccomment"> * @param append Append status.</em> |
| <a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_javadoccomment"> * @param locking Locking status.</em> |
| <a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment"> * @param bufferedIo Buffering flag.</em> |
| <a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment"> * @param bufferSize Buffer size.</em> |
| <a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment"> * @param createOnDemand if you want to lazy-create the file (a.k.a. on-demand.)</em> |
| <a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> * @param advertiseURI the URI to use when advertising the file</em> |
| <a class="jxr_linenumber" name="L390" href="#L390">390</a> <em class="jxr_javadoccomment"> * @param layout The layout</em> |
| <a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_javadoccomment"> * @param filePermissions File permissions</em> |
| <a class="jxr_linenumber" name="L392" href="#L392">392</a> <em class="jxr_javadoccomment"> * @param fileOwner File owner</em> |
| <a class="jxr_linenumber" name="L393" href="#L393">393</a> <em class="jxr_javadoccomment"> * @param fileGroup File group</em> |
| <a class="jxr_linenumber" name="L394" href="#L394">394</a> <em class="jxr_javadoccomment"> * @param configuration the configuration</em> |
| <a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/WriterAppender.html">FactoryData</a>(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> append, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> locking, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> bufferedIo, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> bufferSize, |
| <a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> createOnDemand, <strong class="jxr_keyword">final</strong> String advertiseURI, <strong class="jxr_keyword">final</strong> Layout<? <strong class="jxr_keyword">extends</strong> Serializable> layout, |
| <a class="jxr_linenumber" name="L398" href="#L398">398</a> <strong class="jxr_keyword">final</strong> String filePermissions, <strong class="jxr_keyword">final</strong> String fileOwner, <strong class="jxr_keyword">final</strong> String fileGroup, |
| <a class="jxr_linenumber" name="L399" href="#L399">399</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> configuration) { |
| <a class="jxr_linenumber" name="L400" href="#L400">400</a> <strong class="jxr_keyword">super</strong>(configuration); |
| <a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong class="jxr_keyword">this</strong>.append = append; |
| <a class="jxr_linenumber" name="L402" href="#L402">402</a> <strong class="jxr_keyword">this</strong>.locking = locking; |
| <a class="jxr_linenumber" name="L403" href="#L403">403</a> <strong class="jxr_keyword">this</strong>.bufferedIo = bufferedIo; |
| <a class="jxr_linenumber" name="L404" href="#L404">404</a> <strong class="jxr_keyword">this</strong>.bufferSize = bufferSize; |
| <a class="jxr_linenumber" name="L405" href="#L405">405</a> <strong class="jxr_keyword">this</strong>.createOnDemand = createOnDemand; |
| <a class="jxr_linenumber" name="L406" href="#L406">406</a> <strong class="jxr_keyword">this</strong>.advertiseURI = advertiseURI; |
| <a class="jxr_linenumber" name="L407" href="#L407">407</a> <strong class="jxr_keyword">this</strong>.layout = layout; |
| <a class="jxr_linenumber" name="L408" href="#L408">408</a> <strong class="jxr_keyword">this</strong>.filePermissions = filePermissions; |
| <a class="jxr_linenumber" name="L409" href="#L409">409</a> <strong class="jxr_keyword">this</strong>.fileOwner = fileOwner; |
| <a class="jxr_linenumber" name="L410" href="#L410">410</a> <strong class="jxr_keyword">this</strong>.fileGroup = fileGroup; |
| <a class="jxr_linenumber" name="L411" href="#L411">411</a> } |
| <a class="jxr_linenumber" name="L412" href="#L412">412</a> } |
| <a class="jxr_linenumber" name="L413" href="#L413">413</a> |
| <a class="jxr_linenumber" name="L414" href="#L414">414</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L415" href="#L415">415</a> <em class="jxr_javadoccomment"> * Factory to create a FileManager.</em> |
| <a class="jxr_linenumber" name="L416" href="#L416">416</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L417" href="#L417">417</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html">FileManagerFactory</a> <strong class="jxr_keyword">implements</strong> ManagerFactory<FileManager, FactoryData> { |
| <a class="jxr_linenumber" name="L418" href="#L418">418</a> |
| <a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment"> * Creates a FileManager.</em> |
| <a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_javadoccomment"> * @param name The name of the File.</em> |
| <a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_javadoccomment"> * @param data The FactoryData</em> |
| <a class="jxr_linenumber" name="L423" href="#L423">423</a> <em class="jxr_javadoccomment"> * @return The FileManager for the File.</em> |
| <a class="jxr_linenumber" name="L424" href="#L424">424</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L425" href="#L425">425</a> @Override |
| <a class="jxr_linenumber" name="L426" href="#L426">426</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html">FileManager</a> createManager(<strong class="jxr_keyword">final</strong> String name, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/WriterAppender.html">FactoryData</a> data) { |
| <a class="jxr_linenumber" name="L427" href="#L427">427</a> <strong class="jxr_keyword">final</strong> File file = <strong class="jxr_keyword">new</strong> File(name); |
| <a class="jxr_linenumber" name="L428" href="#L428">428</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L429" href="#L429">429</a> FileUtils.makeParentDirs(file); |
| <a class="jxr_linenumber" name="L430" href="#L430">430</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> writeHeader = !data.append || !file.exists(); |
| <a class="jxr_linenumber" name="L431" href="#L431">431</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> actualSize = data.bufferedIo ? data.bufferSize : Constants.ENCODER_BYTE_BUFFER_SIZE; |
| <a class="jxr_linenumber" name="L432" href="#L432">432</a> <strong class="jxr_keyword">final</strong> ByteBuffer byteBuffer = ByteBuffer.wrap(<strong class="jxr_keyword">new</strong> byte[actualSize]); |
| <a class="jxr_linenumber" name="L433" href="#L433">433</a> <strong class="jxr_keyword">final</strong> FileOutputStream fos = data.createOnDemand ? <strong class="jxr_keyword">null</strong> : <strong class="jxr_keyword">new</strong> FileOutputStream(file, data.append); |
| <a class="jxr_linenumber" name="L434" href="#L434">434</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html">FileManager</a> fm = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html">FileManager</a>(data.getLoggerContext(), name, fos, data.append, data.locking, |
| <a class="jxr_linenumber" name="L435" href="#L435">435</a> data.createOnDemand, data.advertiseURI, data.layout, |
| <a class="jxr_linenumber" name="L436" href="#L436">436</a> data.filePermissions, data.fileOwner, data.fileGroup, writeHeader, byteBuffer); |
| <a class="jxr_linenumber" name="L437" href="#L437">437</a> <strong class="jxr_keyword">if</strong> (fos != <strong class="jxr_keyword">null</strong> && fm.attributeViewEnabled) { |
| <a class="jxr_linenumber" name="L438" href="#L438">438</a> fm.defineAttributeView(file.toPath()); |
| <a class="jxr_linenumber" name="L439" href="#L439">439</a> } |
| <a class="jxr_linenumber" name="L440" href="#L440">440</a> <strong class="jxr_keyword">return</strong> fm; |
| <a class="jxr_linenumber" name="L441" href="#L441">441</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException ex) { |
| <a class="jxr_linenumber" name="L442" href="#L442">442</a> LOGGER.error(<span class="jxr_string">"FileManager ("</span> + name + <span class="jxr_string">") "</span> + ex, ex); |
| <a class="jxr_linenumber" name="L443" href="#L443">443</a> } |
| <a class="jxr_linenumber" name="L444" href="#L444">444</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L445" href="#L445">445</a> } |
| <a class="jxr_linenumber" name="L446" href="#L446">446</a> } |
| <a class="jxr_linenumber" name="L447" href="#L447">447</a> |
| <a class="jxr_linenumber" name="L448" href="#L448">448</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> |
