Class WatchManager
java.lang.Object
org.apache.logging.log4j.core.AbstractLifeCycle
org.apache.logging.log4j.core.util.WatchManager
- All Implemented Interfaces:
LifeCycle
,LifeCycle2
Manages
FileWatcher
s.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle
LifeCycle.State
-
Field Summary
Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle
DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Return the ConfigurationWaatchers.getId()
int
Gets how often this manager checks for file modifications.Deprecated.use getConfigurationWatchers.boolean
void
reset()
Resets all file monitors to their current last modified time.void
Resets the file monitor for the given file being watched to its current last modified time.void
Resets the configuration monitor for the given file being watched to its current last modified time.void
setIntervalSeconds
(int intervalSeconds) void
start()
boolean
Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.toString()
void
Unwatches the given file.void
unwatchFile
(File file) Unwatches the given file.void
Watches the given file.void
watchFile
(File file, FileWatcher fileWatcher) Watches the given file.Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle
equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stop
-
Constructor Details
-
WatchManager
-
-
Method Details
-
checkFiles
public void checkFiles() -
getConfigurationWatchers
Return the ConfigurationWaatchers.- Returns:
- the ConfigurationWatchers.
- Since:
- 2.11.2
-
getId
-
getIntervalSeconds
public int getIntervalSeconds()Gets how often this manager checks for file modifications.- Returns:
- how often, in seconds, this manager checks for file modifications.
-
getWatchers
Deprecated.use getConfigurationWatchers.Returns a Map of the file watchers.- Returns:
- A Map of the file watchers.
-
hasEventListeners
public boolean hasEventListeners() -
reset
public void reset()Resets all file monitors to their current last modified time. If this manager does not watch any file, nothing happens.This allows you to start, stop, reset and start again a manager, without triggering file modified events if the a watched file has changed during the period of time when the manager was stopped.
- Since:
- 2.11.0
-
reset
Resets the file monitor for the given file being watched to its current last modified time. If this manager does not watch the given file, nothing happens.This allows you to start, stop, reset and start again a manager, without triggering file modified events if the given watched file has changed during the period of time when the manager was stopped.
- Parameters:
file
- the file for the monitor to reset.- Since:
- 2.11.0
-
reset
Resets the configuration monitor for the given file being watched to its current last modified time. If this manager does not watch the given configuration, nothing happens.This allows you to start, stop, reset and start again a manager, without triggering file modified events if the given watched configuration has changed during the period of time when the manager was stopped.
- Parameters:
source
- the Source for the monitor to reset.- Since:
- 2.12.0
-
setIntervalSeconds
public void setIntervalSeconds(int intervalSeconds) -
start
public void start()- Specified by:
start
in interfaceLifeCycle
- Overrides:
start
in classAbstractLifeCycle
-
stop
Description copied from interface:LifeCycle2
Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.- Specified by:
stop
in interfaceLifeCycle2
- Overrides:
stop
in classAbstractLifeCycle
- Parameters:
timeout
- the maximum time to waittimeUnit
- the time unit of the timeout argument- Returns:
- true if the receiver was stopped cleanly and normally, false otherwise.
-
toString
-
unwatch
Unwatches the given file.- Parameters:
source
- the Source to stop watching. the file to stop watching.- Since:
- 2.12.0
-
unwatchFile
Unwatches the given file.- Parameters:
file
- the file to stop watching.- Since:
- 2.11.0
-
watch
Watches the given file.- Parameters:
source
- the source to watch.watcher
- the watcher to notify of file changes.
-
watchFile
Watches the given file.- Parameters:
file
- the file to watch.fileWatcher
- the watcher to notify of file changes.
-