blob: fe714444666f79bd459f16304d6e096bc44469c6 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Tue Feb 25 21:03:13 MST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.logging.log4j.core.appender.rolling.action (Apache Log4j Core 2.13.1 API)</title>
<meta name="date" content="2020-02-25">
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.logging.log4j.core.appender.rolling.action (Apache Log4j Core 2.13.1 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/logging/log4j/core/appender/routing/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/logging/log4j/core/appender/rolling/action/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.logging.log4j.core.appender.rolling.action</h1>
<div class="docSummary">
<div class="block">Support classes for the Rolling File Appender.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Action.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action">Action</a></td>
<td class="colLast">
<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>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PathCondition.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action">PathCondition</a></td>
<td class="colLast">
<div class="block">Filter that accepts or rejects a candidate <code>Path</code> for deletion.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PathSorter.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action">PathSorter</a></td>
<td class="colLast">
<div class="block">Defines the interface of classes that can sort Paths.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">AbstractAction</a></td>
<td class="colLast">
<div class="block">Abstract base class for implementations of Action.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">AbstractPathAction</a></td>
<td class="colLast">
<div class="block">Abstract action for processing files that are accepted by the specified PathFilters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/CommonsCompressAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">CommonsCompressAction</a></td>
<td class="colLast">
<div class="block">Compresses a file using bzip2 compression.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/CompositeAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">CompositeAction</a></td>
<td class="colLast">
<div class="block">A group of Actions to be executed in sequence.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">DeleteAction</a></td>
<td class="colLast">
<div class="block">Rollover or scheduled action for deleting old log files that are accepted by the specified PathFilters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/DeletingVisitor.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">DeletingVisitor</a></td>
<td class="colLast">
<div class="block">FileVisitor that deletes files that are accepted by all PathFilters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Duration.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">Duration</a></td>
<td class="colLast">
<div class="block">Simplified implementation of the <a href="https://en.wikipedia.org/wiki/ISO_8601#Durations">ISO-8601 Durations</a>
standard.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/FileRenameAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">FileRenameAction</a></td>
<td class="colLast">
<div class="block">File rename action.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/GzCompressAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">GzCompressAction</a></td>
<td class="colLast">
<div class="block">Compresses a file using GZ compression.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/IfAccumulatedFileCount.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">IfAccumulatedFileCount</a></td>
<td class="colLast">
<div class="block">PathCondition that accepts paths after some count threshold is exceeded during the file tree walk.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/IfAccumulatedFileSize.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">IfAccumulatedFileSize</a></td>
<td class="colLast">
<div class="block">PathCondition that accepts paths after the accumulated file size threshold is exceeded during the file tree walk.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/IfAll.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">IfAll</a></td>
<td class="colLast">
<div class="block">Composite <code>PathCondition</code> that only accepts objects that are accepted by <em>all</em> component conditions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/IfAny.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">IfAny</a></td>
<td class="colLast">
<div class="block">Composite <code>PathCondition</code> that accepts objects that are accepted by <em>any</em> component conditions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/IfFileName.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">IfFileName</a></td>
<td class="colLast">
<div class="block">PathCondition that accepts files for deletion if their relative path matches either a glob pattern or a regular
expression.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/IfLastModified.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">IfLastModified</a></td>
<td class="colLast">
<div class="block">PathCondition that accepts paths that are older than the specified duration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/IfNot.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">IfNot</a></td>
<td class="colLast">
<div class="block">Wrapper <code>PathCondition</code> that accepts objects that are rejected by the wrapped component filter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PathSortByModificationTime.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">PathSortByModificationTime</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/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>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PathWithAttributes.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">PathWithAttributes</a></td>
<td class="colLast">
<div class="block">Tuple of a <code>Path</code> and <code>BasicFileAttributes</code>, used for sorting.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PosixViewAttributeAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">PosixViewAttributeAction</a></td>
<td class="colLast">
<div class="block">File posix attribute view action.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PosixViewAttributeAction.Builder.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">PosixViewAttributeAction.Builder</a></td>
<td class="colLast">
<div class="block">Builder for the posix view attribute action.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/ScriptCondition.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">ScriptCondition</a></td>
<td class="colLast">
<div class="block">A condition of the <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/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>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/SortingVisitor.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">SortingVisitor</a></td>
<td class="colLast">
<div class="block">FileVisitor that sorts files.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/ZipCompressAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">ZipCompressAction</a></td>
<td class="colLast">
<div class="block">Compresses a file using Zip compression.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.logging.log4j.core.appender.rolling.action Description">Package org.apache.logging.log4j.core.appender.rolling.action Description</h2>
<div class="block">Support classes for the Rolling File Appender.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/logging/log4j/core/appender/routing/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/logging/log4j/core/appender/rolling/action/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><p align="center">Copyright &#169; 1999-2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br /> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.</p></small></p>
</body>
</html>