Package wt.servlet

Interface SessionMonitorMBean

All Superinterfaces:
DeluxeStatsMonitorMBean, RawStatisticsProviderMBean, SelfEmailingMBean
All Known Implementing Classes:
SessionMonitor
public interface SessionMonitorMBean extends DeluxeStatsMonitorMBean, RawStatisticsProviderMBean
Monitors servlet sessions

Supported API: true

Extendable: true

  • Field Details

    • MAX_AVG_SESSIONS_NOTIF_TYPE

      static final String MAX_AVG_SESSIONS_NOTIF_TYPE
      Type of notification produced when MaxAverageActiveSessionsThreshold is exceeded

      Supported API: true

  • Method Details

    • getActiveSessions

      int getActiveSessions()
      Number of currently active sessions

      Supported API: true

    • getActiveUserCount

      int getActiveUserCount()
      Number of unique users known to have currently active sessions

      Supported API: true

    • getActiveUsers

      String[] getActiveUsers()
      Names of users known to have currently active sessions

      Supported API: true

    • getMaxSecondsSinceSessionAccessed

      double getMaxSecondsSinceSessionAccessed()
      Period (in seconds) since the longest idle active session was accessed

      Supported API: true

    • getAveSecondsSinceSessionAccessed

      double getAveSecondsSinceSessionAccessed()
      Average period (in seconds) since currently active sessions have been accessed

      Supported API: true

    • getMaxAverageActiveSessionsThreshold

      int getMaxAverageActiveSessionsThreshold()
      Maximum average session concurrency before log messages become warnings and notifications are sent when this statistic is maintained for a summary interval

      Supported API: true

    • setMaxAverageActiveSessionsThreshold

      void setMaxAverageActiveSessionsThreshold(int maxAverageActiveRequestThreshold)
      Maximum average session concurrency before log messages become warnings and notifications are sent when this statistic is maintained for a summary interval

      Supported API: true

    • getSessionLoggerName

      String getSessionLoggerName()
      Name of session logger

      Supported API: true

    • getSessionLoggerLevel

      String getSessionLoggerLevel()
      Session logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

      Supported API: true

    • setSessionLoggerLevel

      void setSessionLoggerLevel(String level)
      Session logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

      Supported API: true

    • getSessionLoggerOutputAttributes

      String getSessionLoggerOutputAttributes()
      List of SessionMBean attributes to be output to request log

      Supported API: true

    • setSessionLoggerOutputAttributes

      void setSessionLoggerOutputAttributes(String sessionLoggerOutputAttributes)
      List of SessionMBean attributes to be output to request log

      Supported API: true

    • getSessionLoggerOutputAttributesSupported

      String[] getSessionLoggerOutputAttributesSupported()
      List of attributes supported for use in SessionLoggerOutputAttributes

      Supported API: true

    • isSessionLoggerUseShortFormat

      boolean isSessionLoggerUseShortFormat()
      Whether short format (which contains only attribute values, not names) is used for session logging

      Supported API: true

    • setSessionLoggerUseShortFormat

      void setSessionLoggerUseShortFormat(boolean sessionLoggerUseShortFormat)
      Whether short format (which contains only attribute values, not names) is used for session logging

      Supported API: true

    • isSessionLoggerMultiLineFormat

      boolean isSessionLoggerMultiLineFormat()
      Whether multi-line format is used for session logging

      Supported API: true

    • setSessionLoggerMultiLineFormat

      void setSessionLoggerMultiLineFormat(boolean sessionLoggerMultiLineFormat)
      Whether multi-line format is used for session logging

      Supported API: true

    • getSessionLoggerSeparatorString

      String getSessionLoggerSeparatorString()
      Item separator string used in session log format

      Supported API: true

    • setSessionLoggerSeparatorString

      void setSessionLoggerSeparatorString(String sessionLoggerSeparatorString)
      Item separator string used in session log format

      Supported API: true

    • getSessionLoggerFormatString

      String getSessionLoggerFormatString()
      Low-level (java.util.Formatter) session log format string; if specified, overrides SessionLoggerUseShortFormat and SessionLoggerSeparatorString

      Supported API: true

    • setSessionLoggerFormatString

      void setSessionLoggerFormatString(String sessionLoggerFormatString)
      Low-level (java.util.Formatter) session log format string; if specified, overrides SessionLoggerUseShortFormat and SessionLoggerSeparatorString

      Supported API: true

    • isSessionRegistrationEnabled

      boolean isSessionRegistrationEnabled()
      Whether sessions are automatically registered and unregistered as JMX MBeans as they are received and completed; enabling this can adversely affect performance

      Supported API: true

    • setSessionRegistrationEnabled

      void setSessionRegistrationEnabled(boolean sessionRegistrationEnabled)
      Whether sessions are automatically registered and unregistered as JMX MBeans as they are received and completed; enabling this can adversely affect performance

      Supported API: true

    • estimateTotalSize

      @MBeanOperationImpact(0) long estimateTotalSize()
      Estimates in memory size (in bytes) of sessions by serializing them.

      Supported API: true

    • estimateAttributeSizes

      @MBeanOperationImpact(0) TabularData estimateAttributeSizes() throws Exception
      Estimates in memory size (in bytes) of sessions' attributes by serializing them.

      Supported API: true
      Throws:
      Exception

    • getActiveSessionAttributes

      @MBeanOperationImpact(0) AttributeList[] getActiveSessionAttributes(String[] attributeNames)
      Returns array of AttributeLists containing requested attributes, one for each active session.

      Supported API: true
      Parameters:
      attributeNames - Names of JMX (not servlet API) attributes (of wt.servlet.SessionMBean) to retrieve; null implies all attributes

    • getActiveSessionAttributes

      @MBeanOperationImpact(0) AttributeList[] getActiveSessionAttributes(String[] attributeNames, SessionMBeanFilter filter)
      Returns array of AttributeLists containing requested attributes, one for each active session that passes the specified filter.

      Supported API: true
      Parameters:
      attributeNames - Names of JMX (not servlet API) attributes (of wt.servlet.SessionMBean) to retrieve; null implies all attributes
      filter - Filter that determines which sessions to include data for; if null, data is included for all active sessions

    • getActiveSessionAttributes

      @MBeanOperationImpact(0) AttributeList getActiveSessionAttributes(String sessionId, String[] attributeNames)
      Returns AttributeList containing requested attributes for specified active session.

      Supported API: true
      Parameters:
      sessionId - Id of session to get attributes of
      attributeNames - Names of JMX (not servlet API) attributes (of wt.servlet.SessionMBean) to retrieve; null implies all attributes

    • handleUserSessionsOnPasswordChangeForFBA

      @MBeanOperationImpact(0) void handleUserSessionsOnPasswordChangeForFBA(String sessionUser, List<String> principalWithItsAliases) throws WTException
      Destroys all active sessions of a given beanUser.

      Supported API: true
      Parameters:
      sessionUser - A user who is changing the password.
      principalWithItsAliases - A list of user & its aliases(if available) whose password is being changed.
      Throws:
      WTException