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

Interface DebugTargetCfgClient

  • All Superinterfaces:
    ConfigurationClient
    public interface DebugTargetCfgClient
extends ConfigurationClient
    A client-side interface for reading and modifying Debug Target settings.

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

    • Method Detail

      • isDebugExceptionsOnly

        ValueOrExpression<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.

      • setDebugExceptionsOnly

        void setDebugExceptionsOnly​(ValueOrExpression<Boolean> value)
                     throws PropertyException
        Sets the "debug-exceptions-only" property.

        Indicates whether only logs with exception should be logged.

        Parameters:
        value - The value of the "debug-exceptions-only" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getDebugScope

        @MandatoryProperty
ValueOrExpression<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.

      • setDebugScope

        @MandatoryProperty
void setDebugScope​(ValueOrExpression<String> value)
            throws PropertyException,
                   PropertyException
        Sets 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).

        This property is read-only and can only be modified during creation of a Debug Target.

        Parameters:
        value - The value of the "debug-scope" property.
        Throws:
        PropertyException - If the new value is invalid.
        PropertyException - If this Debug Target is not being initialized.

      • isIncludeThrowableCause

        ValueOrExpression<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.

      • setIncludeThrowableCause

        void setIncludeThrowableCause​(ValueOrExpression<Boolean> value)
                       throws PropertyException
        Sets the "include-throwable-cause" property.

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

        Parameters:
        value - The value of the "include-throwable-cause" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isOmitMethodEntryArguments

        ValueOrExpression<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.

      • setOmitMethodEntryArguments

        void setOmitMethodEntryArguments​(ValueOrExpression<Boolean> value)
                          throws PropertyException
        Sets the "omit-method-entry-arguments" property.

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

        Parameters:
        value - The value of the "omit-method-entry-arguments" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isOmitMethodReturnValue

        ValueOrExpression<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.

      • setOmitMethodReturnValue

        void setOmitMethodReturnValue​(ValueOrExpression<Boolean> value)
                       throws PropertyException
        Sets the "omit-method-return-value" property.

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

        Parameters:
        value - The value of the "omit-method-return-value" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getThrowableStackFrames

        ValueOrExpression<Integer> 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.

      • setThrowableStackFrames

        void setThrowableStackFrames​(ValueOrExpression<Integer> value)
                      throws PropertyException
        Sets 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.

        Parameters:
        value - The value of the "throwable-stack-frames" property.
        Throws:
        PropertyException - If the new value is invalid.