org.apache.logging.log4j.core.util

Class AbstractWatcher

java.lang.Object

org.apache.logging.log4j.core.util.AbstractWatcher

All Implemented Interfaces:

Watcher

Direct Known Subclasses:

ConfigurationFileWatcher, HttpWatcher, WrappedFileWatcher

public abstract class AbstractWatcher
extends java.lang.Object
implements Watcher

Watcher for configuration files. Causes a reconfiguration when a file changes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractWatcher.ReconfigurationRunnable Helper class for triggering a reconfiguration in a background thread.

Field Summary

Fields

Modifier and Type	Field and Description
private Configuration	configuration
private java.util.List<ConfigurationListener>	configurationListeners
private Reconfigurable	reconfigurable
private Source	source
private Log4jThreadFactory	threadFactory

Fields inherited from interface org.apache.logging.log4j.core.util.Watcher

CATEGORY, ELEMENT_TYPE

Constructor Summary

Constructors

Constructor and Description
AbstractWatcher(Configuration configuration, Reconfigurable reconfigurable, java.util.List<ConfigurationListener> configurationListeners)

Method Summary

Modifier and Type	Method and Description
Configuration	getConfiguration()
abstract long	getLastModified() Returns the time the source was last modified or 0 if it is not available.
java.util.List<ConfigurationListener>	getListeners() Returns the list of listeners for this configuration.
Source	getSource() Returns the Source being monitored.
abstract boolean	isModified() Periodically called to determine if the configuration has been modified.
void	modified() Called when the configuration has been modified.
void	watching(Source source) Called when the Watcher is registered.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.logging.log4j.core.util.Watcher

newWatcher

Field Detail

reconfigurable

private final Reconfigurable reconfigurable

configurationListeners

private final java.util.List<ConfigurationListener> configurationListeners

threadFactory

private final Log4jThreadFactory threadFactory

configuration

private final Configuration configuration

source

private Source source

Constructor Detail

AbstractWatcher

public AbstractWatcher(Configuration configuration,
                       Reconfigurable reconfigurable,
                       java.util.List<ConfigurationListener> configurationListeners)

Method Detail

getListeners

public java.util.List<ConfigurationListener> getListeners()

Description copied from interface: Watcher

Returns the list of listeners for this configuration.

Specified by:

getListeners in interface Watcher

Returns:

The list of listeners.

modified

public void modified()

Description copied from interface: Watcher

Called when the configuration has been modified.

Specified by:

modified in interface Watcher

getConfiguration

public Configuration getConfiguration()

getLastModified

public abstract long getLastModified()

Description copied from interface: Watcher

Returns the time the source was last modified or 0 if it is not available.

Specified by:

getLastModified in interface Watcher

Returns:

the time the source was last modified.

isModified

public abstract boolean isModified()

Description copied from interface: Watcher

Periodically called to determine if the configuration has been modified.

Specified by:

isModified in interface Watcher

Returns:

true if the configuration was modified, false otherwise.

watching

public void watching(Source source)

Description copied from interface: Watcher

Called when the Watcher is registered.

Specified by:

watching in interface Watcher

Parameters:

source - the Source that is being watched.

getSource

public Source getSource()

Description copied from interface: Watcher

Returns the Source being monitored.

Specified by:

getSource in interface Watcher

Returns:

the Source.