| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Watcher (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.util, interface: Watcher"> |
| <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/Watcher.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><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li>Constr | </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.util</a></div> |
| <h1 title="Interface Watcher" class="title">Interface Watcher</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractWatcher.html" title="class in org.apache.logging.log4j.core.util">AbstractWatcher</a></code>, <code><a href="../config/ConfigurationFileWatcher.html" title="class in org.apache.logging.log4j.core.config">ConfigurationFileWatcher</a></code>, <code><a href="../config/HttpWatcher.html" title="class in org.apache.logging.log4j.core.config">HttpWatcher</a></code>, <code><a href="WrappedFileWatcher.html" title="class in org.apache.logging.log4j.core.util">WrappedFileWatcher</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Watcher</span></div> |
| <div class="block">Watches for changes in a Source and performs an action when it is modified.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="WatchManager.html" title="class in org.apache.logging.log4j.core.util"><code>WatchManager</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</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">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <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"><code><a href="#CATEGORY" class="member-name-link">CATEGORY</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <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"><code><a href="#ELEMENT_TYPE" class="member-name-link">ELEMENT_TYPE</a></code></div> |
| <div class="col-last odd-row-color"> </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-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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab2 method-summary-table-tab3"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLastModified()" class="member-name-link">getLastModified</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the time the source was last modified or 0 if it is not available.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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="../config/ConfigurationListener.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationListener</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getListeners()" class="member-name-link">getListeners</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the list of listeners for this configuration.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Source.html" title="class in org.apache.logging.log4j.core.util">Source</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSource()" class="member-name-link">getSource</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the Source being monitored.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isModified()" class="member-name-link">isModified</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Periodically called to determine if the configuration has been modified.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#modified()" class="member-name-link">modified</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Called when the configuration has been modified.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Watcher.html" title="interface in org.apache.logging.log4j.core.util">Watcher</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newWatcher(org.apache.logging.log4j.core.config.Reconfigurable,java.util.List,long)" class="member-name-link">newWatcher</a><wbr>(<a href="../config/Reconfigurable.html" title="interface in org.apache.logging.log4j.core.config">Reconfigurable</a> reconfigurable, |
| <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="../config/ConfigurationListener.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationListener</a>> listeners, |
| long lastModifiedMillis)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a new Watcher by copying the original and using the new Reconfigurable and listeners.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#watching(org.apache.logging.log4j.core.util.Source)" class="member-name-link">watching</a><wbr>(<a href="Source.html" title="class in org.apache.logging.log4j.core.util">Source</a> source)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Called when the Watcher is registered.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="CATEGORY"> |
| <h3>CATEGORY</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><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></span> <span class="element-name">CATEGORY</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.util.Watcher.CATEGORY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ELEMENT_TYPE"> |
| <h3>ELEMENT_TYPE</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><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></span> <span class="element-name">ELEMENT_TYPE</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.util.Watcher.ELEMENT_TYPE">Constant Field Values</a></li> |
| </ul> |
| </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="getListeners()"> |
| <h3>getListeners</h3> |
| <div class="member-signature"><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="../config/ConfigurationListener.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationListener</a>></span> <span class="element-name">getListeners</span>()</div> |
| <div class="block">Returns the list of listeners for this configuration.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The list of listeners.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="modified()"> |
| <h3>modified</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">modified</span>()</div> |
| <div class="block">Called when the configuration has been modified.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isModified()"> |
| <h3>isModified</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isModified</span>()</div> |
| <div class="block">Periodically called to determine if the configuration has been modified.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the configuration was modified, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLastModified()"> |
| <h3>getLastModified</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name">getLastModified</span>()</div> |
| <div class="block">Returns the time the source was last modified or 0 if it is not available.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the time the source was last modified.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="watching(org.apache.logging.log4j.core.util.Source)"> |
| <h3>watching</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">watching</span><wbr><span class="parameters">(<a href="Source.html" title="class in org.apache.logging.log4j.core.util">Source</a> source)</span></div> |
| <div class="block">Called when the Watcher is registered.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the Source that is being watched.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSource()"> |
| <h3>getSource</h3> |
| <div class="member-signature"><span class="return-type"><a href="Source.html" title="class in org.apache.logging.log4j.core.util">Source</a></span> <span class="element-name">getSource</span>()</div> |
| <div class="block">Returns the Source being monitored.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the Source.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newWatcher(org.apache.logging.log4j.core.config.Reconfigurable,java.util.List,long)"> |
| <h3>newWatcher</h3> |
| <div class="member-signature"><span class="return-type"><a href="Watcher.html" title="interface in org.apache.logging.log4j.core.util">Watcher</a></span> <span class="element-name">newWatcher</span><wbr><span class="parameters">(<a href="../config/Reconfigurable.html" title="interface in org.apache.logging.log4j.core.config">Reconfigurable</a> reconfigurable, |
| <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="../config/ConfigurationListener.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationListener</a>> listeners, |
| long lastModifiedMillis)</span></div> |
| <div class="block">Creates a new Watcher by copying the original and using the new Reconfigurable and listeners.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>reconfigurable</code> - The Reconfigurable.</dd> |
| <dd><code>listeners</code> - the listeners.</dd> |
| <dd><code>lastModifiedMillis</code> - The time the resource was last modified in milliseconds.</dd> |
| <dt>Returns:</dt> |
| <dd>A new Watcher.</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> |
