public interface DebugLogPublisherCfg extends LogPublisherCfg
Debug Log Publishers are responsible for distributing debug log messages from the debug logger to a destination.
Modifier and Type | Method and Description |
---|---|
void |
addDebugChangeListener(ConfigurationChangeListener<DebugLogPublisherCfg> listener)
Register to be notified when this Debug Log Publisher is changed.
|
void |
addDebugTargetAddListener(ConfigurationAddListener<DebugTargetCfg> listener)
Registers to be notified when new Debug Targets are added.
|
void |
addDebugTargetDeleteListener(ConfigurationDeleteListener<DebugTargetCfg> listener)
Registers to be notified when existing Debug Targets are deleted.
|
Class<? extends DebugLogPublisherCfg> |
configurationClass()
Gets the configuration class associated with this Debug Log Publisher.
|
DebugTargetCfg |
getDebugTarget(String name)
Gets the named Debug Target.
|
int |
getDefaultThrowableStackFrames()
Gets the "default-throwable-stack-frames" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
boolean |
isDefaultDebugExceptionsOnly()
Gets the "default-debug-exceptions-only" property.
|
boolean |
isDefaultIncludeThrowableCause()
Gets the "default-include-throwable-cause" property.
|
boolean |
isDefaultOmitMethodEntryArguments()
Gets the "default-omit-method-entry-arguments" property.
|
boolean |
isDefaultOmitMethodReturnValue()
Gets the "default-omit-method-return-value" property.
|
String[] |
listDebugTargets()
Lists the Debug Targets.
|
void |
removeDebugChangeListener(ConfigurationChangeListener<DebugLogPublisherCfg> listener)
Deregister an existing Debug Log Publisher configuration change listener.
|
void |
removeDebugTargetAddListener(ConfigurationAddListener<DebugTargetCfg> listener)
Deregisters an existing Debug Target configuration add listener.
|
void |
removeDebugTargetDeleteListener(ConfigurationDeleteListener<DebugTargetCfg> listener)
Deregisters an existing Debug Target configuration delete listener.
|
addChangeListener, isEnabled, removeChangeListener
dn, name
Class<? extends DebugLogPublisherCfg> configurationClass()
configurationClass
in interface Configuration
configurationClass
in interface LogPublisherCfg
void addDebugChangeListener(ConfigurationChangeListener<DebugLogPublisherCfg> listener)
listener
- The Debug Log Publisher configuration change listener.void removeDebugChangeListener(ConfigurationChangeListener<DebugLogPublisherCfg> listener)
listener
- The Debug Log Publisher configuration change listener.boolean isDefaultDebugExceptionsOnly()
Indicates whether only logs with exception should be logged.
boolean isDefaultIncludeThrowableCause()
Indicates whether to include the cause of exceptions in exception thrown and caught messages logged by default.
boolean isDefaultOmitMethodEntryArguments()
Indicates whether to include method arguments in debug messages logged by default.
boolean isDefaultOmitMethodReturnValue()
Indicates whether to include the return value in debug messages logged by default.
int getDefaultThrowableStackFrames()
Indicates the number of stack frames to include in the stack trace for method entry and exception thrown messages.
String getJavaClass()
The fully-qualified name of the Java class that provides the Debug Log Publisher implementation.
getJavaClass
in interface LogPublisherCfg
String[] listDebugTargets()
DebugTargetCfg getDebugTarget(String name) throws ConfigException
name
- The name of the Debug Target to retrieve.ConfigException
- If the Debug Target could not be found or it
could not be successfully decoded.void addDebugTargetAddListener(ConfigurationAddListener<DebugTargetCfg> listener) throws ConfigException
listener
- The Debug Target configuration add listener.ConfigException
- If the add listener could not be registered.void removeDebugTargetAddListener(ConfigurationAddListener<DebugTargetCfg> listener)
listener
- The Debug Target configuration add listener.void addDebugTargetDeleteListener(ConfigurationDeleteListener<DebugTargetCfg> listener) throws ConfigException
listener
- The Debug Target configuration delete listener.ConfigException
- If the delete listener could not be registered.void removeDebugTargetDeleteListener(ConfigurationDeleteListener<DebugTargetCfg> listener)
listener
- The Debug Target configuration delete listener.Copyright 2010-2020 ForgeRock AS.