org.usefultoys.slf4j.watcher

Class WatcherConfig

java.lang.Object

org.usefultoys.slf4j.watcher.WatcherConfig

public class WatcherConfig
extends Object

Centralized configuration holder for controlling the the behavior of the Watcher and WatcherData behavior.

This class exposes configurable properties that influence how the session-related logging behaves at runtime. It supports reading initial values from system properties during application startup, allowing applications to externalize configuration.

These properties should ideally be defined before invoking any method from this library, to ensure consistent behavior. Some properties can be modified dynamically at runtime, although care should be taken in concurrent environments.

This class is intended as a utility container and is not meant to be instantiated.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	dataEnabled Whether the watcher writes encoded data messages to log.
String	dataPrefix Prefix added to the logger name used for encoded data messages.
String	dataSuffix Suffix added to the logger name used for encoded data messages.
long	delayMilliseconds Initial delay before the first status report by WatcherSingleton.DEFAULT_WATCHER, in milliseconds.
String	messagePrefix Prefix added to the logger name used for human-readable messages.
String	messageSuffix Suffix added to the logger name used for human-readable messages.
String	name Logger name used by WatcherSingleton.DEFAULT_WATCHER to write messages.
long	periodMilliseconds Interval between subsequent status reports by WatcherSingleton.DEFAULT_WATCHER, in milliseconds.
String	PROP_DATA_ENABLED
String	PROP_DATA_PREFIX
String	PROP_DATA_SUFFIX
String	PROP_DELAY
String	PROP_MESSAGE_PREFIX
String	PROP_MESSAGE_SUFFIX
String	PROP_NAME
String	PROP_PERIOD

Constructor Summary

Constructors

Constructor and Description
WatcherConfig()

Method Summary

Modifier and Type	Method and Description
void	init()

Methods inherited from class java.lang.Object

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

Field Detail

PROP_NAME

public final String PROP_NAME

See Also:

Constant Field Values

PROP_DELAY

public final String PROP_DELAY

See Also:

Constant Field Values

PROP_PERIOD

public final String PROP_PERIOD

See Also:

Constant Field Values

PROP_DATA_PREFIX

public final String PROP_DATA_PREFIX

See Also:

Constant Field Values

PROP_DATA_SUFFIX

public final String PROP_DATA_SUFFIX

See Also:

Constant Field Values

PROP_DATA_ENABLED

public final String PROP_DATA_ENABLED

See Also:

Constant Field Values

PROP_MESSAGE_PREFIX

public final String PROP_MESSAGE_PREFIX

See Also:

Constant Field Values

PROP_MESSAGE_SUFFIX

public final String PROP_MESSAGE_SUFFIX

See Also:

Constant Field Values

name

public String name

Logger name used by WatcherSingleton.DEFAULT_WATCHER to write messages.

Value is read from system property slf4jtoys.watcher.name, defaulting to "watcher".

delayMilliseconds

public long delayMilliseconds

Initial delay before the first status report by WatcherSingleton.DEFAULT_WATCHER, in milliseconds.

Value is read from system property slf4jtoys.watcher.delay, defaulting to 60000 (1 minute). The value can be suffixed with ms, s, m, or h.

You may assign a new value at runtime, but restarting the default watcher is required for the change to take effect.

periodMilliseconds

public long periodMilliseconds

Interval between subsequent status reports by WatcherSingleton.DEFAULT_WATCHER, in milliseconds.

Value is read from system property slf4jtoys.watcher.period, defaulting to 600000 (10 minutes). The value can be suffixed with ms, s, m, or h.

You may assign a new value at runtime, but restarting the default watcher is required for the change to take effect.

dataPrefix

public String dataPrefix

Prefix added to the logger name used for encoded data messages.

By default, encoded and human-readable messages are written to the same logger. Setting a prefix allows directing encoded data to a different logger.

Example: with prefix data., a logger a.b.c.MyClass becomes data.a.b.c.MyClass for encoded data.

Value is read from system property slf4jtoys.watcher.data.prefix, defaulting to an empty string.

dataSuffix

public String dataSuffix

Suffix added to the logger name used for encoded data messages.

By default, encoded and human-readable messages are written to the same logger. Setting a suffix allows directing encoded data to a different logger.

Example: with suffix .data, a logger a.b.c.MyClass becomes a.b.c.MyClass.data for encoded data.

Value is read from system property slf4jtoys.watcher.data.suffix, defaulting to an empty string.

dataEnabled

public boolean dataEnabled

Whether the watcher writes encoded data messages to log.

Value is read from system property slf4jtoys.watcher.message.prefix, defaulting to false.

You may assign a new value at runtime.

messagePrefix

public String messagePrefix

Prefix added to the logger name used for human-readable messages.

By default, encoded and human-readable messages are written to the same logger. Setting a prefix allows directing readable messages to a different logger.

Example: with prefix message., a logger a.b.c.MyClass becomes message.a.b.c.MyClass for readable messages.

Value is read from system property slf4jtoys.watcher.message.prefix, defaulting to an empty string.

messageSuffix

public String messageSuffix

Suffix added to the logger name used for human-readable messages.

By default, encoded and human-readable messages are written to the same logger. Setting a suffix allows directing readable messages to a different logger.

Example: with suffix .message, a logger a.b.c.MyClass becomes a.b.c.MyClass.message for readable messages.

Value is read from system property slf4jtoys.watcher.message.suffix, defaulting to an empty string.

Constructor Detail

WatcherConfig

public WatcherConfig()

Method Detail

init

public void init()