Interface DebugLogPublisherCfg
-
- All Superinterfaces:
Configuration
,LogPublisherCfg
- All Known Subinterfaces:
FileBasedDebugLogPublisherCfg
public interface DebugLogPublisherCfg extends LogPublisherCfg
A server-side interface for querying Debug Log Publisher settings.Debug Log Publishers are responsible for distributing debug log messages from the debug logger to a destination.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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.-
Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name
-
Methods inherited from interface org.forgerock.opendj.server.config.server.LogPublisherCfg
addChangeListener, isEnabled, removeChangeListener
-
-
-
-
Method Detail
-
configurationClass
Class<? extends DebugLogPublisherCfg> configurationClass()
Gets the configuration class associated with this Debug Log Publisher.- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfaceLogPublisherCfg
- Returns:
- Returns the configuration class associated with this Debug Log Publisher.
-
addDebugChangeListener
void addDebugChangeListener(ConfigurationChangeListener<DebugLogPublisherCfg> listener)
Register to be notified when this Debug Log Publisher is changed.- Parameters:
listener
- The Debug Log Publisher configuration change listener.
-
removeDebugChangeListener
void removeDebugChangeListener(ConfigurationChangeListener<DebugLogPublisherCfg> listener)
Deregister an existing Debug Log Publisher configuration change listener.- Parameters:
listener
- The Debug Log Publisher configuration change listener.
-
isDefaultDebugExceptionsOnly
boolean isDefaultDebugExceptionsOnly()
Gets the "default-debug-exceptions-only" property.Indicates whether only logs with exception should be logged.
Default value:
false
- Returns:
- Returns the value of the "default-debug-exceptions-only" property.
-
isDefaultIncludeThrowableCause
boolean isDefaultIncludeThrowableCause()
Gets the "default-include-throwable-cause" property.Indicates whether to include the cause of exceptions in exception thrown and caught messages logged by default.
Default value:
true
- Returns:
- Returns the value of the "default-include-throwable-cause" property.
-
isDefaultOmitMethodEntryArguments
boolean isDefaultOmitMethodEntryArguments()
Gets the "default-omit-method-entry-arguments" property.Indicates whether to include method arguments in debug messages logged by default.
Default value:
false
- Returns:
- Returns the value of the "default-omit-method-entry-arguments" property.
-
isDefaultOmitMethodReturnValue
boolean isDefaultOmitMethodReturnValue()
Gets the "default-omit-method-return-value" property.Indicates whether to include the return value in debug messages logged by default.
Default value:
false
- Returns:
- Returns the value of the "default-omit-method-return-value" property.
-
getDefaultThrowableStackFrames
int getDefaultThrowableStackFrames()
Gets the "default-throwable-stack-frames" property.Indicates the number of stack frames to include in the stack trace for method entry and exception thrown messages.
Default value:
2147483647
- Returns:
- Returns the value of the "default-throwable-stack-frames" property.
-
getJavaClass
String getJavaClass()
Gets the "java-class" property.The fully-qualified name of the Java class that provides the Debug Log Publisher implementation.
Default value:
org.opends.server.loggers.DebugLogPublisher
- Specified by:
getJavaClass
in interfaceLogPublisherCfg
- Returns:
- Returns the value of the "java-class" property.
-
listDebugTargets
String[] listDebugTargets()
Lists the Debug Targets.- Returns:
- Returns an array containing the names of the Debug Targets.
-
getDebugTarget
DebugTargetCfg getDebugTarget(String name) throws ConfigException
Gets the named Debug Target.- Parameters:
name
- The name of the Debug Target to retrieve.- Returns:
- Returns the named Debug Target.
- Throws:
ConfigException
- If the Debug Target could not be found or it could not be successfully decoded.
-
addDebugTargetAddListener
void addDebugTargetAddListener(ConfigurationAddListener<DebugTargetCfg> listener) throws ConfigException
Registers to be notified when new Debug Targets are added.- Parameters:
listener
- The Debug Target configuration add listener.- Throws:
ConfigException
- If the add listener could not be registered.
-
removeDebugTargetAddListener
void removeDebugTargetAddListener(ConfigurationAddListener<DebugTargetCfg> listener)
Deregisters an existing Debug Target configuration add listener.- Parameters:
listener
- The Debug Target configuration add listener.
-
addDebugTargetDeleteListener
void addDebugTargetDeleteListener(ConfigurationDeleteListener<DebugTargetCfg> listener) throws ConfigException
Registers to be notified when existing Debug Targets are deleted.- Parameters:
listener
- The Debug Target configuration delete listener.- Throws:
ConfigException
- If the delete listener could not be registered.
-
removeDebugTargetDeleteListener
void removeDebugTargetDeleteListener(ConfigurationDeleteListener<DebugTargetCfg> listener)
Deregisters an existing Debug Target configuration delete listener.- Parameters:
listener
- The Debug Target configuration delete listener.
-
-