blob: a7d6d7e5fcca7ab59fd4a21fb01e2c0f7d135df5 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.logging.log4j.core.appender.rolling.action (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.action">
<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:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</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.action" class="title">Package org.apache.logging.log4j.core.appender.rolling.action</h1>
</div>
<hr>
<div class="package-signature"><span class="annotations">@Export
@Version("2.20.2")
</span>package <span class="element-name">org.apache.logging.log4j.core.appender.rolling.action</span></div>
<section class="package-description" id="package-description">
<div class="block">Support classes for the Rolling File Appender.</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.rolling</a></div>
<div class="col-last even-row-color">
<div class="block">Rolling File Appender and support classes.</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></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="AbstractAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">AbstractAction</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Abstract base class for implementations of Action.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AbstractPathAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">AbstractPathAction</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Abstract action for processing files that are accepted by the specified PathFilters.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Action.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action">Action</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">The Action interface should be implemented by any class that performs
file system actions for RollingFileAppenders after the close of
the active log file.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CommonsCompressAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">CommonsCompressAction</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Compresses a file using bzip2 compression.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CompositeAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">CompositeAction</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A group of Actions to be executed in sequence.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DeleteAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">DeleteAction</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Rollover or scheduled action for deleting old log files that are accepted by the specified PathFilters.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DeletingVisitor.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">DeletingVisitor</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">FileVisitor that deletes files that are accepted by all PathFilters.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Duration.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">Duration</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Simplified implementation of the <a href="https://en.wikipedia.org/wiki/ISO_8601#Durations">ISO-8601 Durations</a>
standard.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="FileRenameAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">FileRenameAction</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">File rename action.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="GzCompressAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">GzCompressAction</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Compresses a file using GZ compression.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="IfAccumulatedFileCount.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">IfAccumulatedFileCount</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">PathCondition that accepts paths after some count threshold is exceeded during the file tree walk.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="IfAccumulatedFileSize.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">IfAccumulatedFileSize</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">PathCondition that accepts paths after the accumulated file size threshold is exceeded during the file tree walk.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="IfAll.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">IfAll</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Composite <code>PathCondition</code> that only accepts objects that are accepted by <em>all</em> component conditions.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="IfAny.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">IfAny</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Composite <code>PathCondition</code> that accepts objects that are accepted by <em>any</em> component conditions.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="IfFileName.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">IfFileName</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">PathCondition that accepts files for deletion if their relative path matches either a glob pattern or a regular
expression.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="IfLastModified.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">IfLastModified</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">PathCondition that accepts paths that are older than the specified duration.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="IfNot.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">IfNot</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Wrapper <code>PathCondition</code> that accepts objects that are rejected by the wrapped component filter.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="PathCondition.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action">PathCondition</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Filter that accepts or rejects a candidate <code>Path</code> for deletion.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="PathSortByModificationTime.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">PathSortByModificationTime</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block"><a href="PathSorter.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action"><code>PathSorter</code></a> that sorts path by their LastModified attribute.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="PathSorter.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action">PathSorter</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Defines the interface of classes that can sort Paths.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="PathWithAttributes.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">PathWithAttributes</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Tuple of a <code>Path</code> and <code>BasicFileAttributes</code>, used for sorting.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PosixViewAttributeAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">PosixViewAttributeAction</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">File POSIX attribute view action.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="PosixViewAttributeAction.Builder.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">PosixViewAttributeAction.Builder</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Builder for the POSIX view attribute action.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ScriptCondition.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">ScriptCondition</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A condition of the <a href="DeleteAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action"><code>DeleteAction</code></a> where a user-provided script selects the files to delete from a provided
list.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SortingVisitor.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">SortingVisitor</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">FileVisitor that sorts files.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ZipCompressAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">ZipCompressAction</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Compresses a file using Zip compression.</div>
</div>
</div>
</div>
</div>
</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>