| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_144) on Sat Apr 25 12:11:38 MST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>FileManager (Apache Log4j Core 2.13.2 API)</title> |
| <meta name="date" content="2020-04-25"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FileManager (Apache Log4j Core 2.13.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FileManager.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/appender/FileAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/appender/HttpAppender.html" title="class in org.apache.logging.log4j.core.appender"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/appender/FileManager.html" target="_top">Frames</a></li> |
| <li><a href="FileManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.logging.log4j.core.appender.OutputStreamManager">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.logging.log4j.core.appender</div> |
| <h2 title="Class FileManager" class="title">Class FileManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender.AbstractManager</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender.OutputStreamManager</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.logging.log4j.core.appender.FileManager</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/ByteBufferDestination.html" title="interface in org.apache.logging.log4j.core.layout">ByteBufferDestination</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../org/apache/logging/log4j/core/appender/rolling/RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.51">FileManager</a> |
| extends <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamManager</a></pre> |
| <div class="block">Manages actual File I/O for File Appenders.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.logging.log4j.core.appender.OutputStreamManager"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.logging.log4j.core.appender.<a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamManager</a></h3> |
| <code><a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#byteBuffer">byteBuffer</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#layout">layout</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.logging.log4j.core.appender.AbstractManager"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.logging.log4j.core.appender.<a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></h3> |
| <code><a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#count">count</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#LOGGER">LOGGER</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#FileManager-org.apache.logging.log4j.core.LoggerContext-java.lang.String-java.io.OutputStream-boolean-boolean-boolean-java.lang.String-org.apache.logging.log4j.core.Layout-boolean-java.nio.ByteBuffer-">FileManager</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> loggerContext, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> os, |
| boolean append, |
| boolean locking, |
| boolean createOnDemand, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> advertiseURI, |
| <a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>> layout, |
| boolean writeHeader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> buffer)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#FileManager-org.apache.logging.log4j.core.LoggerContext-java.lang.String-java.io.OutputStream-boolean-boolean-boolean-java.lang.String-org.apache.logging.log4j.core.Layout-java.lang.String-java.lang.String-java.lang.String-boolean-java.nio.ByteBuffer-">FileManager</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> loggerContext, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> os, |
| boolean append, |
| boolean locking, |
| boolean createOnDemand, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> advertiseURI, |
| <a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>> layout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filePermissions, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileOwner, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileGroup, |
| boolean writeHeader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> buffer)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#FileManager-java.lang.String-java.io.OutputStream-boolean-boolean-java.lang.String-org.apache.logging.log4j.core.Layout-boolean-java.nio.ByteBuffer-">FileManager</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> os, |
| boolean append, |
| boolean locking, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> advertiseURI, |
| <a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>> layout, |
| boolean writeHeader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> buffer)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#FileManager-java.lang.String-java.io.OutputStream-boolean-boolean-java.lang.String-org.apache.logging.log4j.core.Layout-int-boolean-">FileManager</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> os, |
| boolean append, |
| boolean locking, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> advertiseURI, |
| <a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>> layout, |
| int bufferSize, |
| boolean writeHeader)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#createOutputStream--">createOutputStream</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#defineAttributeView-java.nio.file.Path-">defineAttributeView</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a> path)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#getBufferSize--">getBufferSize</a></span>()</code> |
| <div class="block">Returns the buffer size to use if the appender was configured with BufferedIO=true, otherwise returns a negative |
| number.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#getContentFormat--">getContentFormat</a></span>()</code> |
| <div class="block">FileManager's content format is specified by: <code>Key: "fileURI" Value: provided "advertiseURI" param</code>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#getFileGroup--">getFileGroup</a></span>()</code> |
| <div class="block">Returns file group if defined and the OS supports posix/group file attribute view, |
| null otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html" title="class in org.apache.logging.log4j.core.appender">FileManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#getFileManager-java.lang.String-boolean-boolean-boolean-boolean-java.lang.String-org.apache.logging.log4j.core.Layout-int-java.lang.String-java.lang.String-java.lang.String-org.apache.logging.log4j.core.config.Configuration-">getFileManager</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileName, |
| boolean append, |
| boolean locking, |
| boolean bufferedIo, |
| boolean createOnDemand, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> advertiseUri, |
| <a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>> layout, |
| int bufferSize, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filePermissions, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileOwner, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileGroup, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</code> |
| <div class="block">Returns the FileManager.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#getFileName--">getFileName</a></span>()</code> |
| <div class="block">Returns the name of the File being managed.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#getFileOwner--">getFileOwner</a></span>()</code> |
| <div class="block">Returns file owner if defined and the OS supports owner file attribute view, |
| null otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/attribute/PosixFilePermission.html?is-external=true" title="class or interface in java.nio.file.attribute">PosixFilePermission</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#getFilePermissions--">getFilePermissions</a></span>()</code> |
| <div class="block">Returns posix file permissions if defined and the OS supports posix file attribute, |
| null otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#isAppend--">isAppend</a></span>()</code> |
| <div class="block">Returns the append status.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#isAttributeViewEnabled--">isAttributeViewEnabled</a></span>()</code> |
| <div class="block">Returns true if file attribute view enabled for this file manager.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#isCreateOnDemand--">isCreateOnDemand</a></span>()</code> |
| <div class="block">Returns the lazy-create.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#isLocking--">isLocking</a></span>()</code> |
| <div class="block">Returns the lock status.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#write-byte:A-int-int-boolean-">write</a></span>(byte[] bytes, |
| int offset, |
| int length, |
| boolean immediateFlush)</code> |
| <div class="block">Some output streams synchronize writes while others do not.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html#writeToDestination-byte:A-int-int-">writeToDestination</a></span>(byte[] bytes, |
| int offset, |
| int length)</code> |
| <div class="block">Overrides <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#writeToDestination-byte:A-int-int-"><code>OutputStreamManager.writeToDestination(byte[], int, int)</code></a> to add support for file locking.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.logging.log4j.core.appender.OutputStreamManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.logging.log4j.core.appender.<a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamManager</a></h3> |
| <code><a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#closeOutputStream--">closeOutputStream</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#drain-java.nio.ByteBuffer-">drain</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#flush--">flush</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#flushBuffer-java.nio.ByteBuffer-">flushBuffer</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#flushDestination--">flushDestination</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#getByteBuffer--">getByteBuffer</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#getManager-java.lang.String-T-org.apache.logging.log4j.core.appender.ManagerFactory-">getManager</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#getOutputStream--">getOutputStream</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#hasOutputStream--">hasOutputStream</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#isOpen--">isOpen</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#releaseSub-long-java.util.concurrent.TimeUnit-">releaseSub</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#setOutputStream-java.io.OutputStream-">setOutputStream</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#skipFooter-boolean-">skipFooter</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#write-byte:A-">write</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#write-byte:A-boolean-">write</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#write-byte:A-int-int-">write</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#writeBytes-byte:A-int-int-">writeBytes</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#writeBytes-java.nio.ByteBuffer-">writeBytes</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#writeFooter--">writeFooter</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#writeHeader-java.io.OutputStream-">writeHeader</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.logging.log4j.core.appender.AbstractManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.logging.log4j.core.appender.<a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></h3> |
| <code><a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#close--">close</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#getCount--">getCount</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#getLoggerContext--">getLoggerContext</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#getName--">getName</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#hasManager-java.lang.String-">hasManager</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#log-org.apache.logging.log4j.Level-java.lang.String-java.lang.Throwable-">log</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#logDebug-java.lang.String-java.lang.Throwable-">logDebug</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#logError-java.lang.String-java.lang.Throwable-">logError</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#logger--">logger</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#logWarn-java.lang.String-java.lang.Throwable-">logWarn</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#narrow-java.lang.Class-org.apache.logging.log4j.core.appender.AbstractManager-">narrow</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#release--">release</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#stop-long-java.util.concurrent.TimeUnit-">stop</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#updateData-java.lang.Object-">updateData</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="FileManager-java.lang.String-java.io.OutputStream-boolean-boolean-java.lang.String-org.apache.logging.log4j.core.Layout-int-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FileManager</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| protected <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.69">FileManager</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> os, |
| boolean append, |
| boolean locking, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> advertiseURI, |
| <a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>> layout, |
| int bufferSize, |
| boolean writeHeader)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </li> |
| </ul> |
| <a name="FileManager-java.lang.String-java.io.OutputStream-boolean-boolean-java.lang.String-org.apache.logging.log4j.core.Layout-boolean-java.nio.ByteBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FileManager</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| protected <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.80">FileManager</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> os, |
| boolean append, |
| boolean locking, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> advertiseURI, |
| <a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>> layout, |
| boolean writeHeader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> buffer)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.6</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FileManager-org.apache.logging.log4j.core.LoggerContext-java.lang.String-java.io.OutputStream-boolean-boolean-boolean-java.lang.String-org.apache.logging.log4j.core.Layout-boolean-java.nio.ByteBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FileManager</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| protected <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.100">FileManager</a>(<a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> loggerContext, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> os, |
| boolean append, |
| boolean locking, |
| boolean createOnDemand, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> advertiseURI, |
| <a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>> layout, |
| boolean writeHeader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> buffer)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FileManager-org.apache.logging.log4j.core.LoggerContext-java.lang.String-java.io.OutputStream-boolean-boolean-boolean-java.lang.String-org.apache.logging.log4j.core.Layout-java.lang.String-java.lang.String-java.lang.String-boolean-java.nio.ByteBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>FileManager</h4> |
| <pre>protected <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.118">FileManager</a>(<a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> loggerContext, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> os, |
| boolean append, |
| boolean locking, |
| boolean createOnDemand, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> advertiseURI, |
| <a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>> layout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filePermissions, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileOwner, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileGroup, |
| boolean writeHeader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> buffer)</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.9</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getFileManager-java.lang.String-boolean-boolean-boolean-boolean-java.lang.String-org.apache.logging.log4j.core.Layout-int-java.lang.String-java.lang.String-java.lang.String-org.apache.logging.log4j.core.config.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFileManager</h4> |
| <pre>public static <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html" title="class in org.apache.logging.log4j.core.appender">FileManager</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.173">getFileManager</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileName, |
| boolean append, |
| boolean locking, |
| boolean bufferedIo, |
| boolean createOnDemand, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> advertiseUri, |
| <a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>> layout, |
| int bufferSize, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filePermissions, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileOwner, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fileGroup, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</pre> |
| <div class="block">Returns the FileManager.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fileName</code> - The name of the file to manage.</dd> |
| <dd><code>append</code> - true if the file should be appended to, false if it should be overwritten.</dd> |
| <dd><code>locking</code> - true if the file should be locked while writing, false otherwise.</dd> |
| <dd><code>bufferedIo</code> - true if the contents should be buffered as they are written.</dd> |
| <dd><code>createOnDemand</code> - true if you want to lazy-create the file (a.k.a. on-demand.)</dd> |
| <dd><code>advertiseUri</code> - the URI to use when advertising the file</dd> |
| <dd><code>layout</code> - The layout</dd> |
| <dd><code>bufferSize</code> - buffer size for buffered IO</dd> |
| <dd><code>filePermissions</code> - File permissions</dd> |
| <dd><code>fileOwner</code> - File owner</dd> |
| <dd><code>fileGroup</code> - File group</dd> |
| <dd><code>configuration</code> - The configuration.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A FileManager for the File.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createOutputStream--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createOutputStream</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.187">createOutputStream</a>() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#createOutputStream--">createOutputStream</a></code> in class <code><a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamManager</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="defineAttributeView-java.nio.file.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defineAttributeView</h4> |
| <pre>protected void <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.205">defineAttributeView</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a> path)</pre> |
| </li> |
| </ul> |
| <a name="write-byte:A-int-int-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>protected void <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.219">write</a>(byte[] bytes, |
| int offset, |
| int length, |
| boolean immediateFlush)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#write-byte:A-int-int-boolean-">OutputStreamManager</a></code></span></div> |
| <div class="block">Some output streams synchronize writes while others do not. Synchronizing here insures that |
| log events won't be intertwined.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#write-byte:A-int-int-boolean-">write</a></code> in class <code><a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bytes</code> - The serialized Log event.</dd> |
| <dd><code>offset</code> - The offset into the byte array.</dd> |
| <dd><code>length</code> - The number of bytes to write.</dd> |
| <dd><code>immediateFlush</code> - flushes immediately after writing.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeToDestination-byte:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeToDestination</h4> |
| <pre>protected void <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.253">writeToDestination</a>(byte[] bytes, |
| int offset, |
| int length)</pre> |
| <div class="block">Overrides <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#writeToDestination-byte:A-int-int-"><code>OutputStreamManager.writeToDestination(byte[], int, int)</code></a> to add support for file locking.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html#writeToDestination-byte:A-int-int-">writeToDestination</a></code> in class <code><a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bytes</code> - the array containing data</dd> |
| <dd><code>offset</code> - from where to write</dd> |
| <dd><code>length</code> - how many bytes to write</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.8</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFileName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFileName</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.281">getFileName</a>()</pre> |
| <div class="block">Returns the name of the File being managed.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The name of the File being managed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAppend--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAppend</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.288">isAppend</a>()</pre> |
| <div class="block">Returns the append status.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the file will be appended to, false if it is overwritten.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isCreateOnDemand--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCreateOnDemand</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.296">isCreateOnDemand</a>()</pre> |
| <div class="block">Returns the lazy-create.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the file will be lazy-created.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isLocking--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLocking</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.304">isLocking</a>()</pre> |
| <div class="block">Returns the lock status.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the file will be locked when writing, false otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBufferSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBufferSize</h4> |
| <pre>public int <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.313">getBufferSize</a>()</pre> |
| <div class="block">Returns the buffer size to use if the appender was configured with BufferedIO=true, otherwise returns a negative |
| number.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the buffer size, or a negative number if the output stream is not buffered</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFilePermissions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilePermissions</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/attribute/PosixFilePermission.html?is-external=true" title="class or interface in java.nio.file.attribute">PosixFilePermission</a>> <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.323">getFilePermissions</a>()</pre> |
| <div class="block">Returns posix file permissions if defined and the OS supports posix file attribute, |
| null otherwise.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>File posix permissions</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/attribute/PosixFileAttributeView.html?is-external=true" title="class or interface in java.nio.file.attribute"><code>PosixFileAttributeView</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFileOwner--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFileOwner</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.333">getFileOwner</a>()</pre> |
| <div class="block">Returns file owner if defined and the OS supports owner file attribute view, |
| null otherwise.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>File owner</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/attribute/FileOwnerAttributeView.html?is-external=true" title="class or interface in java.nio.file.attribute"><code>FileOwnerAttributeView</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFileGroup--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFileGroup</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.343">getFileGroup</a>()</pre> |
| <div class="block">Returns file group if defined and the OS supports posix/group file attribute view, |
| null otherwise.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>File group</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/attribute/PosixFileAttributeView.html?is-external=true" title="class or interface in java.nio.file.attribute"><code>PosixFileAttributeView</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAttributeViewEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAttributeViewEnabled</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.352">isAttributeViewEnabled</a>()</pre> |
| <div class="block">Returns true if file attribute view enabled for this file manager.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if posix or owner supported and defined false otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContentFormat--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getContentFormat</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/FileManager.html#line.362">getContentFormat</a>()</pre> |
| <div class="block">FileManager's content format is specified by: <code>Key: "fileURI" Value: provided "advertiseURI" param</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#getContentFormat--">getContentFormat</a></code> in class <code><a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Map of content format keys supporting FileManager</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FileManager.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/appender/FileAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/appender/HttpAppender.html" title="class in org.apache.logging.log4j.core.appender"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/appender/FileManager.html" target="_top">Frames</a></li> |
| <li><a href="FileManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.logging.log4j.core.appender.OutputStreamManager">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><p align="center">Copyright © 1999-2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br /> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.</p></small></p> |
| </body> |
| </html> |