blob: f6d0c104a527c975a273033a77bce0615af8474f [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Class org.apache.logging.log4j.core.appender.rolling.RollingFileManager (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="use: package: org.apache.logging.log4j.core.appender.rolling, class: RollingFileManager">
<meta name="generator" content="javadoc/ClassUseWriter">
<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-use-page">
<script type="text/javascript">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><a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">Class</a></li>
<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<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="Uses of Class org.apache.logging.log4j.core.appender.rolling.RollingFileManager" class="title">Uses of Class<br>org.apache.logging.log4j.core.appender.rolling.RollingFileManager</h1>
</div>
<div class="caption"><span>Packages that use <a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a></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="#org.apache.logging.log4j.core.appender.rolling">org.apache.logging.log4j.core.appender.rolling</a></div>
<div class="col-last even-row-color">
<div class="block">Rolling File Appender and support classes.</div>
</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.logging.log4j.core.appender.rolling">
<h2>Uses of <a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a> in <a href="../package-summary.html">org.apache.logging.log4j.core.appender.rolling</a></h2>
<div class="caption"><span>Subclasses of <a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a> in <a href="../package-summary.html">org.apache.logging.log4j.core.appender.rolling</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../RollingRandomAccessFileManager.html" class="type-name-link" title="class in org.apache.logging.log4j.core.appender.rolling">RollingRandomAccessFileManager</a></code></div>
<div class="col-last even-row-color">
<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>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.logging.log4j.core.appender.rolling</a> that return <a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a></span></div>
<div class="summary-table three-column-summary">
<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"><code>static <a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">RollingFileManager.</span><code><a href="../RollingFileManager.html#getFileManager(java.lang.String,java.lang.String,boolean,boolean,org.apache.logging.log4j.core.appender.rolling.TriggeringPolicy,org.apache.logging.log4j.core.appender.rolling.RolloverStrategy,java.lang.String,org.apache.logging.log4j.core.Layout,int,boolean,boolean,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>&nbsp;fileName,
<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>&nbsp;pattern,
boolean&nbsp;append,
boolean&nbsp;bufferedIO,
<a href="../TriggeringPolicy.html" title="interface in org.apache.logging.log4j.core.appender.rolling">TriggeringPolicy</a>&nbsp;policy,
<a href="../RolloverStrategy.html" title="interface in org.apache.logging.log4j.core.appender.rolling">RolloverStrategy</a>&nbsp;strategy,
<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>&nbsp;advertiseURI,
<a href="../../../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a>&lt;? 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>&gt;&nbsp;layout,
int&nbsp;bufferSize,
boolean&nbsp;immediateFlush,
boolean&nbsp;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>&nbsp;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>&nbsp;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>&nbsp;fileGroup,
<a href="../../../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&nbsp;configuration)</code></div>
<div class="col-last even-row-color">
<div class="block">Returns a RollingFileManager.</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.logging.log4j.core.appender.rolling</a> with parameters of type <a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a></span></div>
<div class="summary-table three-column-summary">
<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"><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"><span class="type-name-label">DirectFileRolloverStrategy.</span><code><a href="../DirectFileRolloverStrategy.html#getCurrentFileName(org.apache.logging.log4j.core.appender.rolling.RollingFileManager)" class="member-name-link">getCurrentFileName</a><wbr>(<a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a>&nbsp;manager)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><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"><span class="type-name-label">DirectWriteRolloverStrategy.</span><code><a href="../DirectWriteRolloverStrategy.html#getCurrentFileName(org.apache.logging.log4j.core.appender.rolling.RollingFileManager)" class="member-name-link">getCurrentFileName</a><wbr>(<a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a>&nbsp;manager)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedMap.html" title="class or interface in java.util" class="external-link">SortedMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</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>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">AbstractRolloverStrategy.</span><code><a href="../AbstractRolloverStrategy.html#getEligibleFiles(org.apache.logging.log4j.core.appender.rolling.RollingFileManager)" class="member-name-link">getEligibleFiles</a><wbr>(<a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a>&nbsp;manager)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedMap.html" title="class or interface in java.util" class="external-link">SortedMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</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>&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">AbstractRolloverStrategy.</span><code><a href="../AbstractRolloverStrategy.html#getEligibleFiles(org.apache.logging.log4j.core.appender.rolling.RollingFileManager,boolean)" class="member-name-link">getEligibleFiles</a><wbr>(<a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a>&nbsp;manager,
boolean&nbsp;isAscending)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">CompositeTriggeringPolicy.</span><code><a href="../CompositeTriggeringPolicy.html#initialize(org.apache.logging.log4j.core.appender.rolling.RollingFileManager)" class="member-name-link">initialize</a><wbr>(<a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a>&nbsp;manager)</code></div>
<div class="col-last even-row-color">
<div class="block">Initializes the policy.</div>
</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">CronTriggeringPolicy.</span><code><a href="../CronTriggeringPolicy.html#initialize(org.apache.logging.log4j.core.appender.rolling.RollingFileManager)" class="member-name-link">initialize</a><wbr>(<a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a>&nbsp;aManager)</code></div>
<div class="col-last odd-row-color">
<div class="block">Initializes the policy.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">NoOpTriggeringPolicy.</span><code><a href="../NoOpTriggeringPolicy.html#initialize(org.apache.logging.log4j.core.appender.rolling.RollingFileManager)" class="member-name-link">initialize</a><wbr>(<a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a>&nbsp;manager)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">OnStartupTriggeringPolicy.</span><code><a href="../OnStartupTriggeringPolicy.html#initialize(org.apache.logging.log4j.core.appender.rolling.RollingFileManager)" class="member-name-link">initialize</a><wbr>(<a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a>&nbsp;manager)</code></div>
<div class="col-last odd-row-color">
<div class="block">Provide the RollingFileManager to the policy.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">SizeBasedTriggeringPolicy.</span><code><a href="../SizeBasedTriggeringPolicy.html#initialize(org.apache.logging.log4j.core.appender.rolling.RollingFileManager)" class="member-name-link">initialize</a><wbr>(<a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a>&nbsp;aManager)</code></div>
<div class="col-last even-row-color">
<div class="block">Initialize the TriggeringPolicy.</div>
</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">TimeBasedTriggeringPolicy.</span><code><a href="../TimeBasedTriggeringPolicy.html#initialize(org.apache.logging.log4j.core.appender.rolling.RollingFileManager)" class="member-name-link">initialize</a><wbr>(<a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a>&nbsp;aManager)</code></div>
<div class="col-last odd-row-color">
<div class="block">Initializes the policy.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">TriggeringPolicy.</span><code><a href="../TriggeringPolicy.html#initialize(org.apache.logging.log4j.core.appender.rolling.RollingFileManager)" class="member-name-link">initialize</a><wbr>(<a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a>&nbsp;manager)</code></div>
<div class="col-last even-row-color">
<div class="block">Initializes this triggering policy.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../RolloverDescription.html" title="interface in org.apache.logging.log4j.core.appender.rolling">RolloverDescription</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">DefaultRolloverStrategy.</span><code><a href="../DefaultRolloverStrategy.html#rollover(org.apache.logging.log4j.core.appender.rolling.RollingFileManager)" class="member-name-link">rollover</a><wbr>(<a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a>&nbsp;manager)</code></div>
<div class="col-last odd-row-color">
<div class="block">Performs the rollover.</div>
</div>
<div class="col-first even-row-color"><code><a href="../RolloverDescription.html" title="interface in org.apache.logging.log4j.core.appender.rolling">RolloverDescription</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">DirectWriteRolloverStrategy.</span><code><a href="../DirectWriteRolloverStrategy.html#rollover(org.apache.logging.log4j.core.appender.rolling.RollingFileManager)" class="member-name-link">rollover</a><wbr>(<a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a>&nbsp;manager)</code></div>
<div class="col-last even-row-color">
<div class="block">Performs the rollover.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../RolloverDescription.html" title="interface in org.apache.logging.log4j.core.appender.rolling">RolloverDescription</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">RolloverStrategy.</span><code><a href="../RolloverStrategy.html#rollover(org.apache.logging.log4j.core.appender.rolling.RollingFileManager)" class="member-name-link">rollover</a><wbr>(<a href="../RollingFileManager.html" title="class in org.apache.logging.log4j.core.appender.rolling">RollingFileManager</a>&nbsp;manager)</code></div>
<div class="col-last odd-row-color">
<div class="block">Prepare for a rollover.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><p align="center"> Copyright &copy; 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>