Interface RequestLogger

• Field Summary

  Fields
  Modifier and Type

  Field

  Description

  static final long

  ALL_CONTENT

  Indicates that all content is copied to the log.

  static final long

  NO_CONTENT

  Indicates that no content is copied to the log (the default).

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  void

  close()

  Close the log.

  <T> T

  copyContent(T content)

  Copies content to the log during request processing up to the length limit specified for the logger.

  void

  flush()

  Send buffered output to the log destination.

  long

  getContentMax()

  Returns how much content is copied to the log.

  PrintStream

  getPrintStream()

  Returns the underlying PrintStream used for logging.

  boolean

  isEnabled()

  Returns whether logging is active or suspended.

  void

  setContentMax(long length)

  Controls how much content is copied to the log (defaulting to NO_CONTENT).

  void

  setEnabled(boolean enabled)

  Suspend or resume logging.

• Field Details

  • NO_CONTENT

    static final long NO_CONTENT
    Indicates that no content is copied to the log (the default).

    See Also:

    • Constant Field Values

  • ALL_CONTENT

    static final long ALL_CONTENT
    Indicates that all content is copied to the log.

    See Also:

    • Constant Field Values

• Method Details

  • getContentMax

    long getContentMax()
    Returns how much content is copied to the log.

    Returns:

    the limit on copying content

  • setContentMax

    void setContentMax(long length)
    Controls how much content is copied to the log (defaulting to NO_CONTENT).

    Parameters:

    length - the limit on copying content

  • isEnabled

    boolean isEnabled()
    Returns whether logging is active or suspended.

    Returns:

    the enablement of logging

  • setEnabled

    void setEnabled(boolean enabled)
    Suspend or resume logging.

    Parameters:

    enabled - the enablement of logging

  • getPrintStream

    PrintStream getPrintStream()
    Returns the underlying PrintStream used for logging.

    Returns:

    the PrintStream for logging

  • copyContent

    <T> T copyContent(T content)
    Copies content to the log during request processing up to the length limit specified for the logger. Ordinarily, this method is called internally during reading content from the database or writing content to the database. You may, however, use this method directly if convenient.

    Type Parameters:

    T - the type to return

    Parameters:

    content - the copied content

    Returns:

    the copied content

  • flush

    void flush()
    Send buffered output to the log destination.

  • close

    void close()
    Close the log.

Copyright (c) 2010-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.