Package wt.servlet

Interface FilteredRequestLoggerMBean

All Superinterfaces:
SelfEmailingMBean
All Known Implementing Classes:
FilteredRequestLogger
public interface FilteredRequestLoggerMBean extends SelfEmailingMBean
Allows selective logging of servlet requests that match specific criteria.

Supported API: true

Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getLoggerLevel()
    Logging level; valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

    Supported API: true
    String
    getLoggerName()
    Name of logger this MBean uses

    Supported API: true
    String
    getName()
    Name of this MBean

    Supported API: true
    String
    getURIPatternToLog()
    Regular expression which request's ContextRelativeRequestURI must match in order to be logged; when this is null/empty no request URI filter is applied

    Supported API: true
    String
    getUserNamesToLog()
    User names for which requests should be logged; when this is null/empty, no user name filter is applied

    Supported API: true
    boolean
    isEnabled()
    Whether this MBean is enabled; when disabled this MBean will not log, irrespective of the LoggerLevel setting

    Supported API: true
    boolean
    isLogAsDynamicMBean()
    Whether servlet request data should be logged as a wt.servlet.RequestMBean or instead formatted as specified by the ServletRequestMonitor MBean's RequestLogger* attributes (and thus as an AttributeListWrapper).
    void
    setEnabled(boolean enabled)
    Whether this MBean is enabled; when disabled this MBean will not log, irrespective of the LoggerLevel setting

    Supported API: true
    void
    setLogAsDynamicMBean(boolean logAsDynamicMBean)
    Whether servlet request data should be logged as a wt.servlet.RequestMBean or instead formatted as specified by the ServletRequestMonitor MBean's RequestLogger* attributes (and thus as an AttributeListWrapper).
    void
    setLoggerLevel(String level)
    Logging level; valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

    Supported API: true
    void
    setURIPatternToLog(String uriPatternToLog)
    Regular expression which request's ContextRelativeRequestURI must match in order to be logged; when this is null/empty no request URI filter is applied

    Supported API: true
    void
    setUserNamesToLog(String userNames)
    User names for which requests should be logged; when this is null/empty, no user name filter is applied

    Supported API: true

    Methods inherited from interface wt.jmx.core.mbeans.SelfEmailingMBean

    emailThisMBean

  • Method Details

    • getName

      String getName()
      Name of this MBean

      Supported API: true

    • isEnabled

      boolean isEnabled()
      Whether this MBean is enabled; when disabled this MBean will not log, irrespective of the LoggerLevel setting

      Supported API: true

    • setEnabled

      void setEnabled(boolean enabled)
      Whether this MBean is enabled; when disabled this MBean will not log, irrespective of the LoggerLevel setting

      Supported API: true

    • getLoggerName

      String getLoggerName()
      Name of logger this MBean uses

      Supported API: true

    • getLoggerLevel

      String getLoggerLevel()
      Logging level; valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

      Supported API: true

    • setLoggerLevel

      void setLoggerLevel(String level)
      Logging level; valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

      Supported API: true

    • getUserNamesToLog

      String getUserNamesToLog()
      User names for which requests should be logged; when this is null/empty, no user name filter is applied

      Supported API: true

    • setUserNamesToLog

      void setUserNamesToLog(String userNames)
      User names for which requests should be logged; when this is null/empty, no user name filter is applied

      Supported API: true

    • getURIPatternToLog

      String getURIPatternToLog()
      Regular expression which request's ContextRelativeRequestURI must match in order to be logged; when this is null/empty no request URI filter is applied

      Supported API: true

    • setURIPatternToLog

      void setURIPatternToLog(String uriPatternToLog)
      Regular expression which request's ContextRelativeRequestURI must match in order to be logged; when this is null/empty no request URI filter is applied

      Supported API: true

    • isLogAsDynamicMBean

      boolean isLogAsDynamicMBean()
      Whether servlet request data should be logged as a wt.servlet.RequestMBean or instead formatted as specified by the ServletRequestMonitor MBean's RequestLogger* attributes (and thus as an AttributeListWrapper). Normally the latter approach is useful in order to allow selection of servlet request data to log and formatting thereof, but in cases one might wish to log as a RequestMBean in order to allow a log4j Appender like wt.log4j.jmx.AsyncJDBCAppender to independently select the data of interest.

      Supported API: true

    • setLogAsDynamicMBean

      void setLogAsDynamicMBean(boolean logAsDynamicMBean)
      Whether servlet request data should be logged as a wt.servlet.RequestMBean or instead formatted as specified by the ServletRequestMonitor MBean's RequestLogger* attributes (and thus as an AttributeListWrapper). Normally the latter approach is useful in order to allow selection of servlet request data to log and formatting thereof, but in cases one might wish to log as a RequestMBean in order to allow a log4j Appender like wt.log4j.jmx.AsyncJDBCAppender to independently select the data of interest.

      Supported API: true