Package wt.method.jmx

Interface FilteredMCLoggerMBean

All Superinterfaces:
SelfEmailingMBean
All Known Implementing Classes:
FilteredMCLogger
public interface FilteredMCLoggerMBean extends SelfEmailingMBean
Allows selective logging of method contexts that match specific criteria.

Supported API: true

Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAccessLogDetailPatternToLog()
    Regular expression which method context access log detail must match in order to be logged; when this is null/empty no target method filter will be applied

    Supported API: true
    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
    getTargetClassPatternToLog()
    Regular expression which method context target class must match in order to be logged; when this is null/empty no target class filter will be applied

    Supported API: true
    String
    getTargetMethodPatternToLog()
    Regular expression which method context target method must match in order to be logged; when this is null/empty no target method filter will be 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 method context data should be logged as a wt.method.MethodContextMBean or instead formatted as specified by the MethodContextMonitor MBean's ContextLogger* attributes (and thus as an AttributeListWrapper).
    void
    setAccessLogDetailPatternToLog(String accessLogDetailPatternToLog)
    Regular expression which method context access log detail must match in order to be logged; when this is null/empty no target method filter will be applied

    Supported API: true
    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 method context data should be logged as a wt.method.MethodContextMBean or instead formatted as specified by the MethodContextMonitor MBean's ContextLogger* 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
    setTargetClassPatternToLog(String targetClassPatternToLog)
    Regular expression which method context target class must match in order to be logged; when this is null/empty no target class filter will be applied

    Supported API: true
    void
    setTargetMethodPatternToLog(String targetMethodPatternToLog)
    Regular expression which method context target method must match in order to be logged; when this is null/empty no target method filter will be 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

    • getTargetClassPatternToLog

      String getTargetClassPatternToLog()
      Regular expression which method context target class must match in order to be logged; when this is null/empty no target class filter will be applied

      Supported API: true

    • setTargetClassPatternToLog

      void setTargetClassPatternToLog(String targetClassPatternToLog)
      Regular expression which method context target class must match in order to be logged; when this is null/empty no target class filter will be applied

      Supported API: true

    • getTargetMethodPatternToLog

      String getTargetMethodPatternToLog()
      Regular expression which method context target method must match in order to be logged; when this is null/empty no target method filter will be applied

      Supported API: true

    • setTargetMethodPatternToLog

      void setTargetMethodPatternToLog(String targetMethodPatternToLog)
      Regular expression which method context target method must match in order to be logged; when this is null/empty no target method filter will be applied

      Supported API: true

    • getAccessLogDetailPatternToLog

      String getAccessLogDetailPatternToLog()
      Regular expression which method context access log detail must match in order to be logged; when this is null/empty no target method filter will be applied

      Supported API: true

    • setAccessLogDetailPatternToLog

      void setAccessLogDetailPatternToLog(String accessLogDetailPatternToLog)
      Regular expression which method context access log detail must match in order to be logged; when this is null/empty no target method filter will be applied

      Supported API: true

    • isLogAsDynamicMBean

      boolean isLogAsDynamicMBean()
      Whether method context data should be logged as a wt.method.MethodContextMBean or instead formatted as specified by the MethodContextMonitor MBean's ContextLogger* attributes (and thus as an AttributeListWrapper). Normally the latter approach is useful in order to allow selection of method context data to log and formatting thereof, but in cases one might wish to log as a MethodContextMBean 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 method context data should be logged as a wt.method.MethodContextMBean or instead formatted as specified by the MethodContextMonitor MBean's ContextLogger* attributes (and thus as an AttributeListWrapper). Normally the latter approach is useful in order to allow selection of method context data to log and formatting thereof, but in cases one might wish to log as a MethodContextMBean in order to allow a log4j Appender like wt.log4j.jmx.AsyncJDBCAppender to independently select the data of interest.

      Supported API: true