Package org.forgerock.opendj.server.config.server

Interface DebugTargetCfg

  • All Superinterfaces:
    Configuration
    public interface DebugTargetCfg
extends Configuration
    A server-side interface for querying Debug Target settings.

    Debug Targets define the types of messages logged by the debug logPublisher.

    • Method Detail

      • configurationClass

        Class<? extends DebugTargetCfg> configurationClass()
        Gets the configuration class associated with this Debug Target.
        Specified by:
        configurationClass in interface Configuration
        Returns:
        Returns the configuration class associated with this Debug Target.

      • addChangeListener

        void addChangeListener​(ConfigurationChangeListener<DebugTargetCfg> listener)
        Register to be notified when this Debug Target is changed.
        Parameters:
        listener - The Debug Target configuration change listener.

      • removeChangeListener

        void removeChangeListener​(ConfigurationChangeListener<DebugTargetCfg> listener)
        Deregister an existing Debug Target configuration change listener.
        Parameters:
        listener - The Debug Target configuration change listener.

      • isDebugExceptionsOnly

        boolean isDebugExceptionsOnly()
        Gets the "debug-exceptions-only" property.

        Indicates whether only logs with exception should be logged.

        Default value: false

        Returns:
        Returns the value of the "debug-exceptions-only" property.

      • getDebugScope

        String getDebugScope()
        Gets the "debug-scope" property.

        Specifies the fully-qualified OpenDJ Java package, class, or method affected by the settings in this target definition. Use the number character (#) to separate the class name and the method name (that is, org.opends.server.core.DirectoryServer#startUp).

        Returns:
        Returns the value of the "debug-scope" property.

      • isEnabled

        boolean isEnabled()
        Gets the "enabled" property.

        Indicates whether the Debug Target is enabled.

        Returns:
        Returns the value of the "enabled" property.

      • isIncludeThrowableCause

        boolean isIncludeThrowableCause()
        Gets the "include-throwable-cause" property.

        Specifies the property to indicate whether to include the cause of exceptions in exception thrown and caught messages.

        Default value: false

        Returns:
        Returns the value of the "include-throwable-cause" property.

      • isOmitMethodEntryArguments

        boolean isOmitMethodEntryArguments()
        Gets the "omit-method-entry-arguments" property.

        Specifies the property to indicate whether to include method arguments in debug messages.

        Default value: false

        Returns:
        Returns the value of the "omit-method-entry-arguments" property.

      • isOmitMethodReturnValue

        boolean isOmitMethodReturnValue()
        Gets the "omit-method-return-value" property.

        Specifies the property to indicate whether to include the return value in debug messages.

        Default value: false

        Returns:
        Returns the value of the "omit-method-return-value" property.

      • getThrowableStackFrames

        int getThrowableStackFrames()
        Gets the "throwable-stack-frames" property.

        Specifies the property to indicate the number of stack frames to include in the stack trace for method entry and exception thrown messages.

        Default value: 0

        Returns:
        Returns the value of the "throwable-stack-frames" property.