| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ScriptCondition (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, class: ScriptCondition"> |
| <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/ScriptCondition.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>Nested | </li> |
| <li>Field | </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.rolling.action</a></div> |
| <h1 title="Class ScriptCondition" class="title">Class ScriptCondition</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">org.apache.logging.log4j.core.appender.rolling.action.ScriptCondition</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations"><a href="../../../config/plugins/Plugin.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@Plugin</a>(<a href="../../../config/plugins/Plugin.html#name()">name</a>="ScriptCondition", |
| <a href="../../../config/plugins/Plugin.html#category()">category</a>="Core", |
| <a href="../../../config/plugins/Plugin.html#printObject()">printObject</a>=true) |
| </span><span class="modifiers">public class </span><span class="element-name type-name-label">ScriptCondition</span> |
| <span class="extends-implements">extends <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></span></div> |
| <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. The specified script may be a <a href="../../../script/Script.html" title="class in org.apache.logging.log4j.core.script"><code>Script</code></a>, a <a href="../../../script/ScriptFile.html" title="class in org.apache.logging.log4j.core.script"><code>ScriptFile</code></a> or a <a href="../../../script/ScriptRef.html" title="class in org.apache.logging.log4j.core.script"><code>ScriptRef</code></a>.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#createCondition(org.apache.logging.log4j.core.script.AbstractScript,org.apache.logging.log4j.core.config.Configuration)"><code>createCondition(AbstractScript, Configuration)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== 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 two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.core.script.AbstractScript,org.apache.logging.log4j.core.config.Configuration)" class="member-name-link">ScriptCondition</a><wbr>(<a href="../../../script/AbstractScript.html" title="class in org.apache.logging.log4j.core.script">AbstractScript</a> script, |
| <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"> |
| <div class="block">Constructs a new ScriptCondition.</div> |
| </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-tab1 method-summary-table-tab4"><code>static <a href="ScriptCondition.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">ScriptCondition</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createCondition(org.apache.logging.log4j.core.script.AbstractScript,org.apache.logging.log4j.core.config.Configuration)" class="member-name-link">createCondition</a><wbr>(<a href="../../../script/AbstractScript.html" title="class in org.apache.logging.log4j.core.script">AbstractScript</a> script, |
| <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">Creates the ScriptCondition.</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/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PathWithAttributes.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">PathWithAttributes</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#selectFilesToDelete(java.nio.file.Path,java.util.List)" class="member-name-link">selectFilesToDelete</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> basePath, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PathWithAttributes.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">PathWithAttributes</a>> candidates)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Executes the script</div> |
| </div> |
| </div> |
| </div> |
| </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>(org.apache.logging.log4j.core.script.AbstractScript,org.apache.logging.log4j.core.config.Configuration)"> |
| <h3>ScriptCondition</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ScriptCondition</span><wbr><span class="parameters">(<a href="../../../script/AbstractScript.html" title="class in org.apache.logging.log4j.core.script">AbstractScript</a> script, |
| <a href="../../../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</span></div> |
| <div class="block">Constructs a new ScriptCondition.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>script</code> - the script that can select files to delete</dd> |
| <dd><code>configuration</code> - configuration containing the StrSubstitutor passed to the script</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="selectFilesToDelete(java.nio.file.Path,java.util.List)"> |
| <h3>selectFilesToDelete</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/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PathWithAttributes.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">PathWithAttributes</a>></span> <span class="element-name">selectFilesToDelete</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> basePath, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PathWithAttributes.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">PathWithAttributes</a>> candidates)</span></div> |
| <div class="block">Executes the script</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>basePath</code> - base directory for files to delete</dd> |
| <dd><code>candidates</code> - a list of paths, that can be deleted by the script</dd> |
| <dt>Returns:</dt> |
| <dd>a list of paths selected to delete by the script execution</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createCondition(org.apache.logging.log4j.core.script.AbstractScript,org.apache.logging.log4j.core.config.Configuration)"> |
| <h3>createCondition</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../../config/plugins/PluginFactory.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginFactory</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="ScriptCondition.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">ScriptCondition</a></span> <span class="element-name">createCondition</span><wbr><span class="parameters">(<a href="../../../config/plugins/PluginElement.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginElement</a>("Script") |
| <a href="../../../script/AbstractScript.html" title="class in org.apache.logging.log4j.core.script">AbstractScript</a> script, |
| <a href="../../../config/plugins/PluginConfiguration.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginConfiguration</a> |
| <a href="../../../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</span></div> |
| <div class="block">Creates the ScriptCondition.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>script</code> - The script to run. This may be a <a href="../../../script/Script.html" title="class in org.apache.logging.log4j.core.script"><code>Script</code></a>, a <a href="../../../script/ScriptFile.html" title="class in org.apache.logging.log4j.core.script"><code>ScriptFile</code></a> or a <a href="../../../script/ScriptRef.html" title="class in org.apache.logging.log4j.core.script"><code>ScriptRef</code></a>. The |
| script must return a <code>List<PathWithAttributes></code>. When the script is executed, it is provided the |
| following bindings: |
| <ul> |
| <li>basePath - the directory from where the <a href="DeleteAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action"><code>Delete</code></a> action started scanning for |
| files to delete. Can be used to relativize the paths in the pathList.</li> |
| <li>pathList - a <code>java.util.List</code> containing <a href="PathWithAttributes.html" title="class in org.apache.logging.log4j.core.appender.rolling.action"><code>PathWithAttributes</code></a> objects. (The script is |
| free to modify and return this list.)</li> |
| <li>substitutor - a <a href="../../../lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup"><code>StrSubstitutor</code></a> that can be used to look up variables embedded in the base |
| dir or other properties |
| <li>statusLogger - the <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/status/StatusLogger.html" title="class or interface in org.apache.logging.log4j.status" class="external-link"><code>StatusLogger</code></a> that can be used to log events during script execution |
| <li>any properties declared in the configuration</li> |
| </ul></dd> |
| <dd><code>configuration</code> - the configuration</dd> |
| <dt>Returns:</dt> |
| <dd>A ScriptCondition.</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> |
