| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>FileManager (Apache Log4j Core 2.23.1 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.logging.log4j.core.appender, class: FileManager"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.logging.log4j.core.appender</a></div> |
| <h1 title="Class FileManager" class="title">Class FileManager</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender.AbstractManager</a> |
| <div class="inheritance"><a href="OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender.OutputStreamManager</a> |
| <div class="inheritance">org.apache.logging.log4j.core.appender.FileManager</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="../layout/ByteBufferDestination.html" title="interface in org.apache.logging.log4j.core.layout">ByteBufferDestination</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="rolling/RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">FileManager</span> |
| <span class="extends-implements">extends <a href="OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamManager</a></span></div> |
| <div class="block">Manages actual File I/O for File Appenders.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.core.appender.AbstractManager">Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.<a href="AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></h2> |
| <code><a href="AbstractManager.AbstractFactoryData.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager.AbstractFactoryData</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.appender.OutputStreamManager">Fields inherited from class org.apache.logging.log4j.core.appender.<a href="OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamManager</a></h3> |
| <code><a href="OutputStreamManager.html#byteBuffer">byteBuffer</a>, <a href="OutputStreamManager.html#layout">layout</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.appender.AbstractManager">Fields inherited from class org.apache.logging.log4j.core.appender.<a href="AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></h3> |
| <code><a href="AbstractManager.html#count">count</a>, <a href="AbstractManager.html#LOGGER">LOGGER</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.io.OutputStream,boolean,boolean,java.lang.String,org.apache.logging.log4j.core.Layout,boolean,java.nio.ByteBuffer)" class="member-name-link">FileManager</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fileName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a> os, |
| boolean append, |
| boolean locking, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> advertiseURI, |
| <a href="../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" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| boolean writeHeader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buffer)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> </div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.io.OutputStream,boolean,boolean,java.lang.String,org.apache.logging.log4j.core.Layout,int,boolean)" class="member-name-link">FileManager</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fileName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a> os, |
| boolean append, |
| boolean locking, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> advertiseURI, |
| <a href="../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" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| int bufferSize, |
| boolean writeHeader)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> </div> |
| </div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(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)" class="member-name-link">FileManager</a><wbr>(<a href="../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" title="class or interface in java.lang" class="external-link">String</a> fileName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a> os, |
| boolean append, |
| boolean locking, |
| boolean createOnDemand, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> advertiseURI, |
| <a href="../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" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| boolean writeHeader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buffer)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> </div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(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)" class="member-name-link">FileManager</a><wbr>(<a href="../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" title="class or interface in java.lang" class="external-link">String</a> fileName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a> os, |
| boolean append, |
| boolean locking, |
| boolean createOnDemand, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> advertiseURI, |
| <a href="../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" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> filePermissions, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fileOwner, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fileGroup, |
| boolean writeHeader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buffer)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createOutputStream()" class="member-name-link">createOutputStream</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createParentDir(java.io.File)" class="member-name-link">createParentDir</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> file)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#defineAttributeView(java.nio.file.Path)" class="member-name-link">defineAttributeView</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBufferSize()" class="member-name-link">getBufferSize</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the buffer size to use if the appender was configured with BufferedIO=true, otherwise returns a negative |
| number.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContentFormat()" class="member-name-link">getContentFormat</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">FileManager's content format is specified by: <code>Key: "fileURI" Value: provided "advertiseURI" param</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFileGroup()" class="member-name-link">getFileGroup</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns file group if defined and the OS supports POSIX/group file attribute view, |
| null otherwise.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FileManager.html" title="class in org.apache.logging.log4j.core.appender">FileManager</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#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)" class="member-name-link">getFileManager</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">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" title="class or interface in java.lang" class="external-link">String</a> advertiseUri, |
| <a href="../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" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| int bufferSize, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> filePermissions, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fileOwner, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fileGroup, |
| <a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the FileManager.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFileName()" class="member-name-link">getFileName</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the name of the File being managed.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFileOwner()" class="member-name-link">getFileOwner</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns file owner if defined and the OS supports owner file attribute view, |
| null otherwise.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/attribute/PosixFilePermission.html" title="class or interface in java.nio.file.attribute" class="external-link">PosixFilePermission</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFilePermissions()" class="member-name-link">getFilePermissions</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns POSIX file permissions if defined and the OS supports POSIX file attribute, |
| null otherwise.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAppend()" class="member-name-link">isAppend</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the append status.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAttributeViewEnabled()" class="member-name-link">isAttributeViewEnabled</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns true if file attribute view enabled for this file manager.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCreateOnDemand()" class="member-name-link">isCreateOnDemand</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the lazy-create.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isLocking()" class="member-name-link">isLocking</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the lock status.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#write(byte%5B%5D,int,int,boolean)" class="member-name-link">write</a><wbr>(byte[] bytes, |
| int offset, |
| int length, |
| boolean immediateFlush)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Some output streams synchronize writes while others do not.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#writeToDestination(byte%5B%5D,int,int)" class="member-name-link">writeToDestination</a><wbr>(byte[] bytes, |
| int offset, |
| int length)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Overrides <a href="OutputStreamManager.html#writeToDestination(byte%5B%5D,int,int)"><code>OutputStreamManager.writeToDestination(byte[], int, int)</code></a> to add support for file locking.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.appender.OutputStreamManager">Methods inherited from class org.apache.logging.log4j.core.appender.<a href="OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamManager</a></h3> |
| <code><a href="OutputStreamManager.html#closeOutputStream()">closeOutputStream</a>, <a href="OutputStreamManager.html#drain(java.nio.ByteBuffer)">drain</a>, <a href="OutputStreamManager.html#flush()">flush</a>, <a href="OutputStreamManager.html#flushBuffer(java.nio.ByteBuffer)">flushBuffer</a>, <a href="OutputStreamManager.html#flushDestination()">flushDestination</a>, <a href="OutputStreamManager.html#getByteBuffer()">getByteBuffer</a>, <a href="OutputStreamManager.html#getManager(java.lang.String,T,org.apache.logging.log4j.core.appender.ManagerFactory)">getManager</a>, <a href="OutputStreamManager.html#getOutputStream()">getOutputStream</a>, <a href="OutputStreamManager.html#hasOutputStream()">hasOutputStream</a>, <a href="OutputStreamManager.html#isOpen()">isOpen</a>, <a href="OutputStreamManager.html#releaseSub(long,java.util.concurrent.TimeUnit)">releaseSub</a>, <a href="OutputStreamManager.html#setOutputStream(java.io.OutputStream)">setOutputStream</a>, <a href="OutputStreamManager.html#skipFooter(boolean)">skipFooter</a>, <a href="OutputStreamManager.html#write(byte%5B%5D)">write</a>, <a href="OutputStreamManager.html#write(byte%5B%5D,boolean)">write</a>, <a href="OutputStreamManager.html#write(byte%5B%5D,int,int)">write</a>, <a href="OutputStreamManager.html#writeBytes(byte%5B%5D,int,int)">writeBytes</a>, <a href="OutputStreamManager.html#writeBytes(java.nio.ByteBuffer)">writeBytes</a>, <a href="OutputStreamManager.html#writeFooter()">writeFooter</a>, <a href="OutputStreamManager.html#writeHeader(java.io.OutputStream)">writeHeader</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.appender.AbstractManager">Methods inherited from class org.apache.logging.log4j.core.appender.<a href="AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></h3> |
| <code><a href="AbstractManager.html#close()">close</a>, <a href="AbstractManager.html#getCount()">getCount</a>, <a href="AbstractManager.html#getLoggerContext()">getLoggerContext</a>, <a href="AbstractManager.html#getManager(java.lang.String,org.apache.logging.log4j.core.appender.ManagerFactory,T)">getManager</a>, <a href="AbstractManager.html#getName()">getName</a>, <a href="AbstractManager.html#getStrSubstitutor()">getStrSubstitutor</a>, <a href="AbstractManager.html#hasManager(java.lang.String)">hasManager</a>, <a href="AbstractManager.html#log(org.apache.logging.log4j.Level,java.lang.String,java.lang.Throwable)">log</a>, <a href="AbstractManager.html#logDebug(java.lang.String,java.lang.Throwable)">logDebug</a>, <a href="AbstractManager.html#logError(java.lang.String,java.lang.Throwable)">logError</a>, <a href="AbstractManager.html#logger()">logger</a>, <a href="AbstractManager.html#logWarn(java.lang.String,java.lang.Throwable)">logWarn</a>, <a href="AbstractManager.html#narrow(java.lang.Class,org.apache.logging.log4j.core.appender.AbstractManager)">narrow</a>, <a href="AbstractManager.html#release()">release</a>, <a href="AbstractManager.html#stop(long,java.util.concurrent.TimeUnit)">stop</a>, <a href="AbstractManager.html#updateData(java.lang.Object)">updateData</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.io.OutputStream,boolean,boolean,java.lang.String,org.apache.logging.log4j.core.Layout,int,boolean)"> |
| <h3>FileManager</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">protected</span> <span class="element-name">FileManager</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fileName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a> os, |
| boolean append, |
| boolean locking, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> advertiseURI, |
| <a href="../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" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| int bufferSize, |
| boolean writeHeader)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.io.OutputStream,boolean,boolean,java.lang.String,org.apache.logging.log4j.core.Layout,boolean,java.nio.ByteBuffer)"> |
| <h3>FileManager</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">protected</span> <span class="element-name">FileManager</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fileName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a> os, |
| boolean append, |
| boolean locking, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> advertiseURI, |
| <a href="../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" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| boolean writeHeader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buffer)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>2.6</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(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)"> |
| <h3>FileManager</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">protected</span> <span class="element-name">FileManager</span><wbr><span class="parameters">(<a href="../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" title="class or interface in java.lang" class="external-link">String</a> fileName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a> os, |
| boolean append, |
| boolean locking, |
| boolean createOnDemand, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> advertiseURI, |
| <a href="../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" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| boolean writeHeader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buffer)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>2.7</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(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)"> |
| <h3>FileManager</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">FileManager</span><wbr><span class="parameters">(<a href="../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" title="class or interface in java.lang" class="external-link">String</a> fileName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a> os, |
| boolean append, |
| boolean locking, |
| boolean createOnDemand, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> advertiseURI, |
| <a href="../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" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> filePermissions, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fileOwner, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fileGroup, |
| boolean writeHeader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buffer)</span></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>2.9</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="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)"> |
| <h3>getFileManager</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FileManager.html" title="class in org.apache.logging.log4j.core.appender">FileManager</a></span> <span class="element-name">getFileManager</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">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" title="class or interface in java.lang" class="external-link">String</a> advertiseUri, |
| <a href="../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" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| int bufferSize, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> filePermissions, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fileOwner, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fileGroup, |
| <a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</span></div> |
| <div class="block">Returns the FileManager.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>A FileManager for the File.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createOutputStream()"> |
| <h3>createOutputStream</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a></span> <span class="element-name">createOutputStream</span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="OutputStreamManager.html#createOutputStream()">createOutputStream</a></code> in class <code><a href="OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamManager</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createParentDir(java.io.File)"> |
| <h3>createParentDir</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">createParentDir</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> file)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="defineAttributeView(java.nio.file.Path)"> |
| <h3>defineAttributeView</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">defineAttributeView</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="write(byte[],int,int,boolean)"> |
| <h3>write</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">write</span><wbr><span class="parameters">(byte[] bytes, |
| int offset, |
| int length, |
| boolean immediateFlush)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="OutputStreamManager.html#write(byte%5B%5D,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 class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="OutputStreamManager.html#write(byte%5B%5D,int,int,boolean)">write</a></code> in class <code><a href="OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamManager</a></code></dd> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeToDestination(byte[],int,int)"> |
| <h3>writeToDestination</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">writeToDestination</span><wbr><span class="parameters">(byte[] bytes, |
| int offset, |
| int length)</span></div> |
| <div class="block">Overrides <a href="OutputStreamManager.html#writeToDestination(byte%5B%5D,int,int)"><code>OutputStreamManager.writeToDestination(byte[], int, int)</code></a> to add support for file locking.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="OutputStreamManager.html#writeToDestination(byte%5B%5D,int,int)">writeToDestination</a></code> in class <code><a href="OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamManager</a></code></dd> |
| <dt>Parameters:</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>Since:</dt> |
| <dd>2.8</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFileName()"> |
| <h3>getFileName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getFileName</span>()</div> |
| <div class="block">Returns the name of the File being managed.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The name of the File being managed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isAppend()"> |
| <h3>isAppend</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isAppend</span>()</div> |
| <div class="block">Returns the append status.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the file will be appended to, false if it is overwritten.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isCreateOnDemand()"> |
| <h3>isCreateOnDemand</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isCreateOnDemand</span>()</div> |
| <div class="block">Returns the lazy-create.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the file will be lazy-created.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isLocking()"> |
| <h3>isLocking</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isLocking</span>()</div> |
| <div class="block">Returns the lock status.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the file will be locked when writing, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBufferSize()"> |
| <h3>getBufferSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getBufferSize</span>()</div> |
| <div class="block">Returns the buffer size to use if the appender was configured with BufferedIO=true, otherwise returns a negative |
| number.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the buffer size, or a negative number if the output stream is not buffered</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFilePermissions()"> |
| <h3>getFilePermissions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/attribute/PosixFilePermission.html" title="class or interface in java.nio.file.attribute" class="external-link">PosixFilePermission</a>></span> <span class="element-name">getFilePermissions</span>()</div> |
| <div class="block">Returns POSIX file permissions if defined and the OS supports POSIX file attribute, |
| null otherwise.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>File POSIX permissions</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/attribute/PosixFileAttributeView.html" title="class or interface in java.nio.file.attribute" class="external-link"><code>PosixFileAttributeView</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFileOwner()"> |
| <h3>getFileOwner</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getFileOwner</span>()</div> |
| <div class="block">Returns file owner if defined and the OS supports owner file attribute view, |
| null otherwise.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>File owner</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/attribute/FileOwnerAttributeView.html" title="class or interface in java.nio.file.attribute" class="external-link"><code>FileOwnerAttributeView</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFileGroup()"> |
| <h3>getFileGroup</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getFileGroup</span>()</div> |
| <div class="block">Returns file group if defined and the OS supports POSIX/group file attribute view, |
| null otherwise.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>File group</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/attribute/PosixFileAttributeView.html" title="class or interface in java.nio.file.attribute" class="external-link"><code>PosixFileAttributeView</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isAttributeViewEnabled()"> |
| <h3>isAttributeViewEnabled</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isAttributeViewEnabled</span>()</div> |
| <div class="block">Returns true if file attribute view enabled for this file manager.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>True if POSIX or owner supported and defined false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContentFormat()"> |
| <h3>getContentFormat</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getContentFormat</span>()</div> |
| <div class="block">FileManager's content format is specified by: <code>Key: "fileURI" Value: provided "advertiseURI" param</code>.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractManager.html#getContentFormat()">getContentFormat</a></code> in class <code><a href="AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Map of content format keys supporting FileManager</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><p align="center"> Copyright © 1999-2024 <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> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
