| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>org.apache.logging.log4j.core.appender.rolling (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.rolling"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <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="package-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 class="nav-bar-cell1-rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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#package">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</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"> |
| <div class="header"> |
| <h1 title="Package org.apache.logging.log4j.core.appender.rolling" class="title">Package org.apache.logging.log4j.core.appender.rolling</h1> |
| </div> |
| <hr> |
| <div class="package-signature"><span class="annotations">@Export |
| @Version("2.21.1") |
| </span>package <span class="element-name">org.apache.logging.log4j.core.appender.rolling</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Rolling File Appender and support classes.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="../package-summary.html">org.apache.logging.log4j.core.appender</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Log4j 2 Appenders.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="action/package-summary.html">org.apache.logging.log4j.core.appender.rolling.action</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Support classes for the Rolling File Appender.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="../db/package-summary.html">org.apache.logging.log4j.core.appender.db</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The classes in this package and sub packages provide appenders for various types of databases and methods for |
| accessing databases.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="../mom/package-summary.html">org.apache.logging.log4j.core.appender.mom</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Message oriented middleware appenders.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="../nosql/package-summary.html">org.apache.logging.log4j.core.appender.nosql</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The NoSQL Appender supports writing log events to NoSQL databases.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="../rewrite/package-summary.html">org.apache.logging.log4j.core.appender.rewrite</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Apache Flume Appender.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="../routing/package-summary.html">org.apache.logging.log4j.core.appender.routing</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Apache Flume Appender.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enums</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractRolloverStrategy.html" title="class in org.apache.logging.log4j.core.appender.rolling">AbstractRolloverStrategy</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AbstractTriggeringPolicy.html" title="class in org.apache.logging.log4j.core.appender.rolling">AbstractTriggeringPolicy</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Abstract convenience class for triggering policies that extend <a href="../../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core"><code>AbstractLifeCycle</code></a> and implement |
| <a href="TriggeringPolicy.html" title="interface in org.apache.logging.log4j.core.appender.rolling"><code>TriggeringPolicy</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="CompositeTriggeringPolicy.html" title="class in org.apache.logging.log4j.core.appender.rolling">CompositeTriggeringPolicy</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Triggering policy that wraps other triggering policies.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CronTriggeringPolicy.html" title="class in org.apache.logging.log4j.core.appender.rolling">CronTriggeringPolicy</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Rolls a file over based on a cron schedule.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultRolloverStrategy.html" title="class in org.apache.logging.log4j.core.appender.rolling">DefaultRolloverStrategy</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">When rolling over, <code>DefaultRolloverStrategy</code> renames files according to an algorithm as described below.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultRolloverStrategy.Builder.html" title="class in org.apache.logging.log4j.core.appender.rolling">DefaultRolloverStrategy.Builder</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Builds DefaultRolloverStrategy instances.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="DirectFileRolloverStrategy.html" title="interface in org.apache.logging.log4j.core.appender.rolling">DirectFileRolloverStrategy</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Created by rgoers on 1/12/17.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DirectWriteRolloverStrategy.html" title="class in org.apache.logging.log4j.core.appender.rolling">DirectWriteRolloverStrategy</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">When rolling over, <code>DirectWriteRolloverStrategy</code> writes directly to the file as resolved by the file |
| pattern.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DirectWriteRolloverStrategy.Builder.html" title="class in org.apache.logging.log4j.core.appender.rolling">DirectWriteRolloverStrategy.Builder</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Builds DirectWriteRolloverStrategy instances.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="FileExtension.html" title="enum in org.apache.logging.log4j.core.appender.rolling">FileExtension</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Enumerates over supported file extensions for compression.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="FileSize.html" title="class in org.apache.logging.log4j.core.appender.rolling">FileSize</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">FileSize utility class.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="NoOpTriggeringPolicy.html" title="class in org.apache.logging.log4j.core.appender.rolling">NoOpTriggeringPolicy</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="OnStartupTriggeringPolicy.html" title="class in org.apache.logging.log4j.core.appender.rolling">OnStartupTriggeringPolicy</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Triggers a rollover on every restart, but only if the file size is greater than zero.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PatternProcessor.html" title="class in org.apache.logging.log4j.core.appender.rolling">PatternProcessor</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Parses the rollover pattern.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">The Rolling File Manager.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RollingRandomAccessFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingRandomAccessFileManager</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Extends RollingFileManager but instead of using a buffered output stream, this class uses a <code>ByteBuffer</code> and a |
| <code>RandomAccessFile</code> to do the I/O.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="RolloverDescription.html" title="interface in org.apache.logging.log4j.core.appender.rolling">RolloverDescription</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Description of actions needed to complete rollover.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RolloverDescriptionImpl.html" title="class in org.apache.logging.log4j.core.appender.rolling">RolloverDescriptionImpl</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Description of actions needed to complete rollover.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab3"><a href="RolloverFrequency.html" title="enum in org.apache.logging.log4j.core.appender.rolling">RolloverFrequency</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab3"> |
| <div class="block">Enumeration of rollover frequency values.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="RolloverListener.html" title="interface in org.apache.logging.log4j.core.appender.rolling">RolloverListener</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Implementations of this interface that are registered with the RollingFileManager will be notified before and |
| after a rollover occurs.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="RolloverStrategy.html" title="interface in org.apache.logging.log4j.core.appender.rolling">RolloverStrategy</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">A <code>RollingPolicy</code> specifies the actions taken on a logging file rollover.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SizeBasedTriggeringPolicy.html" title="class in org.apache.logging.log4j.core.appender.rolling">SizeBasedTriggeringPolicy</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="TimeBasedTriggeringPolicy.html" title="class in org.apache.logging.log4j.core.appender.rolling">TimeBasedTriggeringPolicy</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Rolls a file over based on time.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TimeBasedTriggeringPolicy.Builder.html" title="class in org.apache.logging.log4j.core.appender.rolling">TimeBasedTriggeringPolicy.Builder</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="TriggeringPolicy.html" title="interface in org.apache.logging.log4j.core.appender.rolling">TriggeringPolicy</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">A <code>TriggeringPolicy</code> controls the conditions under which rollover |
| occurs.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </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> |