Package wt.servlet

Interface RequestMBean

All Known Implementing Classes:
Request
public interface RequestMBean
Detailed information related to a single servlet engine request.

Supported API: true

Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    String[]
    dumpStackTrace()
    Returns detailed information on the thread running this request (returns null after request has completed)

    Supported API: true
    void
    emailStackTrace(String addressesOrEmailList, String subject)
    E-mails detailed information on the thread running this request (only functions until request is completed)

    Supported API: true
    String
    getAuthType()
    Name of the authentication scheme used to protect the resource

    Supported API: true
    double
    getAverageActiveRequests()
    Get average requests active during this request

    Supported API: true
    long
    getBlockedCount()
    Number of times request thread was in BLOCKED state

    Supported API: true
    double
    getBlockedSeconds()
    Time request thread spent in BLOCKED state; -1 unless ThreadContentionMonitoringEnabled is set

    Supported API: true
    String
    getBlockingCallId()
    Id of a call (to another server process, for example) that this request is currently waiting upon, when the call has been specifically instrumented to register this (which is most often not the case)

    Supported API: true
    CompositeData
    getBlockingCallInfo()
    Information on call (to another server process, for example) that this request is currently waiting upon, when the call has been specifically instrumented to register this (which is most often not the case)

    Supported API: true
    String
    getBlockingCallTarget()
    Description of the target of a call (to another server process, for example) that this request is currently waiting upon, when the call has been specifically instrumented to register this (which is most often not the case)

    Supported API: true
    long
    getBytesAllocated()
    Estimated number of bytes allocated by the request thread during this request; -1 when this information is not available

    Supported API: true
    double
    getCompressionRatioAsPercent()
    Ratio of compressed to uncompressed bytes output as a percentage (100*ContentBytesOutput/UncompressedBytesOutput)

    Supported API: true
    long
    getContentBytesOutput()
    Number of bytes actually output to content body via the response output stream

    Supported API: true
    long
    getContentBytesRead()
    Number of bytes read from request content body via the request input stream; does not include reads by getParameter*() APIs

    Supported API: true
    long
    getContentCharsOutput()
    Number of characters actually output to content body via the response writer

    Supported API: true
    long
    getContentCharsRead()
    Approximate number of characters read from request content body via the request reader; does not include reads by getParameter*() APIs

    Supported API: true
    long
    getContentLength()
    Length of request body as specified in request headers

    Supported API: true
    String
    getContentType()
    Content type of the request as specified in request headers

    Supported API: true
    String
    getContextPath()
    Portion of the request URI that indicates the web application context of the request

    Supported API: true
    String
    getContextRelativeRequestURI()
    RequestURI relative to the web application context path

    Supported API: true
    CompositeData[]
    getCookieData()
    HTTP cookies

    Supported API: true
    String[]
    getCookies()
    HTTP cookies

    Supported API: true
    double
    getElapsedCpuSeconds()
    Elapsed CPU time of request thread during request

    Supported API: true
    double
    getElapsedProcessCpuSeconds()
    Elapsed CPU time of overall servlet engine process during request; only meaningful if ServletRequestMonitorMBean's ProcessCpuTimeMonitoringEnabled attribute is true

    Supported API: true
    double
    getElapsedSeconds()
    Elapsed time of request

    Supported API: true
    double
    getElapsedUserSeconds()
    Elapsed CPU time executing in user mode for request thread during request

    Supported API: true
    String
    getExceptionClass()
    Class name of exception thrown by request

    Supported API: true
    String
    getExceptionMessage()
    Message of exception thrown by request

    Supported API: true
    String[]
    getExceptionStackTrace()
    Stack trace of exception thrown by request

    Supported API: true
    String
    getId()
    Reference id of request

    Supported API: true
    long
    getIECalls()
    IE calls recorded as occurring from request thread during request

    Supported API: true
    double
    getIEElapsedSeconds()
    Elapsed time of IE calls recorded as occurring from request thread during request

    Supported API: true
    long
    getJNDICalls()
    JNDI calls recorded as occurring from request thread during request

    Supported API: true
    double
    getJNDIElapsedSeconds()
    Elapsed time of JNDI calls recorded as occurring from request thread during request

    Supported API: true
    String
    getMethod()
    Name of the HTTP method with which this request was made

    Supported API: true
    double
    getPercentageOfElapsedTimeInIE()
    Percentage of elapsed request time spent in IE calls

    Supported API: true
    double
    getPercentageOfElapsedTimeInJNDI()
    Percentage of elapsed request time spent in JNDI calls

    Supported API: true
    double
    getPercentageOfElapsedTimeInRMI()
    Percentage of elapsed request time spent in RMI calls

    Supported API: true
    double
    getPercentageOfElapsedTimeInSOAP()
    Percentage of elapsed request time spent in SOAP calls

    Supported API: true
    double
    getPercentageOfProcessCpuTime()
    Request CPU time as a percent of servlet engine process during request time frame; only meaningful if ServletRequestMonitorMBean's ProcessCpuTimeMonitoringEnabled attribute is true

    Supported API: true
    double
    getPercentageOfTotalCpuTime()
    Request CPU time as a percent of overall during request time frame

    Supported API: true
    double
    getProcessPercentageOfTotalCpuTime()
    Servlet engine process CPU time as a percent of overall during request time frame; only meaningful if ServletRequestMonitorMBean's ProcessCpuTimeMonitoringEnabled attribute is true

    Supported API: true
    String
    getProtocol()
    Name and version of the protocol the request uses

    Supported API: true
    String
    getQueryString()
    Query string that is contained in the request URL after the path

    Supported API: true
    String
    getRemoteAddr()
    Internet Protocol (IP) address of the client that sent the request

    Supported API: true
    String
    getRemoteUser()
    Login of the user making this request, if the user has been authenticated

    Supported API: true
    String
    getRequestedSessionId()
    Session ID specified by the client; may not be the same as the ID of the actual session in use

    Supported API: true
    TabularData
    getRequestHeaderData()
    HTTP request headers

    Supported API: true
    String[]
    getRequestHeaderNames()
    HTTP request header names

    Supported API: true
    String[]
    getRequestHeaders()
    HTTP request headers

    Supported API: true
    String[]
    getRequestHeaderValues(String headerName)
    Returns values for a specified HTTP request header

    Supported API: true
    TabularData
    getRequestParameterData()
    Servlet request parameters (contained in the query string and/or posted form data)

    Supported API: true
    String[]
    getRequestParameters()
    Servlet request parameters (contained in the query string and/or posted form data)

    Supported API: true
    String[]
    getRequestParameterValues(String paramName)
    Returns values for a specified servlet request parameter

    Supported API: true
    String
    getRequestURI()
    Part of this request's URL from the protocol name up to the query string in the first line of the HTTP request

    Supported API: true
    long
    getResponseContentLength()
    Length of the content body in the response according to the HTTP Content-Length header or -1 if not set

    Supported API: true
    String
    getResponseContentType()
    Content type of the response being sent to the client according to Content-Type header, if set

    Supported API: true
    long
    getRMICalls()
    RMI calls recorded as occurring from request thread during request

    Supported API: true
    double
    getRMIElapsedSeconds()
    Elapsed time of RMI calls recorded as occurring from request thread during request

    Supported API: true
    String
    getServletPath()
    Portion of the request URI that calls the servlet.
    String
    getSessionId()
    ID of session actually in use

    Supported API: true
    long
    getSOAPCalls()
    SOAP calls recorded as occurring from request thread during request

    Supported API: true
    double
    getSOAPElapsedSeconds()
    Elapsed time of SOAP calls recorded as occurring from request thread during request

    Supported API: true
    String[]
    getStackTrace()
    Detailed information on the thread running this request (returns null after request has completed)

    Supported API: true
    Timestamp
    getStartTime()
    Time application code started process request

    Supported API: true
    int
    getStatusCode()
    HTTP status code returned; -1 if not known

    Supported API: true
    String
    getStatusMessage()
    HTTP response status message

    Supported API: true
    long
    getThreadId()
    Id of the thread in which the request is running

    Supported API: true
    String
    getThreadName()
    Name of the thread in which the request is running

    Supported API: true
    double
    getThrottledSeconds()
    Time for which request has been throttled

    Supported API: true
    long
    getUncompressedBytesOutput()
    Number of bytes output to content body via the response output stream prior to compression

    Supported API: true
    String
    getUserAgent()
    User-agent of client that sent the request

    Supported API: true
    long
    getWaitedCount()
    Number of times request thread was in either WAITING or TIMED_WAITING state

    Supported API: true
    double
    getWaitedSeconds()
    Time request thread spent in either WAITING or TIMED_WAITING state; -1 unless ThreadContentionMonitoringEnabled is set

    Supported API: true
    void
    interrupt()
    If the request is not completed, interrupts its thread.
    boolean
    isBeingThrottled()
    Whether the request is currently being throttled

    Supported API: true
    boolean
    isCompleted()
    Whether request has been completed (with or without error)

    Supported API: true
    boolean
    isError()
    Whether the request generated an error status code

    Supported API: true
    boolean
    isOutputCompressed()
    Whether output is compressed by wt.servlet.CompressionFilter

    Supported API: true
    boolean
    isRequestedSessionIdValid()
    Whether the requested session ID is still valid

    Supported API: true
    boolean
    isResponseCommitted()
    Whether response (and its headers and response status code) has been committed yet or not

    Supported API: true

  • Method Details

    • getId

      String getId()
      Reference id of request

      Supported API: true

    • getThreadId

      long getThreadId()
      Id of the thread in which the request is running

      Supported API: true

    • getThreadName

      String getThreadName()
      Name of the thread in which the request is running

      Supported API: true

    • getStartTime

      Timestamp getStartTime()
      Time application code started process request

      Supported API: true

    • getRemoteAddr

      String getRemoteAddr()
      Internet Protocol (IP) address of the client that sent the request

      Supported API: true

    • getUserAgent

      String getUserAgent()
      User-agent of client that sent the request

      Supported API: true

    • getProtocol

      String getProtocol()
      Name and version of the protocol the request uses

      Supported API: true

    • getAuthType

      String getAuthType()
      Name of the authentication scheme used to protect the resource

      Supported API: true

    • getContentLength

      long getContentLength()
      Length of request body as specified in request headers

      Supported API: true

    • getContentType

      String getContentType()
      Content type of the request as specified in request headers

      Supported API: true

    • getRemoteUser

      String getRemoteUser()
      Login of the user making this request, if the user has been authenticated

      Supported API: true

    • getMethod

      String getMethod()
      Name of the HTTP method with which this request was made

      Supported API: true

    • getQueryString

      String getQueryString()
      Query string that is contained in the request URL after the path

      Supported API: true

    • getRequestURI

      String getRequestURI()
      Part of this request's URL from the protocol name up to the query string in the first line of the HTTP request

      Supported API: true

    • getContextPath

      String getContextPath()
      Portion of the request URI that indicates the web application context of the request

      Supported API: true

    • getContextRelativeRequestURI

      String getContextRelativeRequestURI()
      RequestURI relative to the web application context path

      Supported API: true

    • getServletPath

      String getServletPath()
      Portion of the request URI that calls the servlet.

      This path starts with a "/" character and includes either the servlet name or a path to the servlet, but does not include any extra path information or a query string. Same as the value of the CGI variable SCRIPT_NAME.

      This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.

      Supported API: true

    • getRequestedSessionId

      String getRequestedSessionId()
      Session ID specified by the client; may not be the same as the ID of the actual session in use

      Supported API: true

    • isRequestedSessionIdValid

      boolean isRequestedSessionIdValid()
      Whether the requested session ID is still valid

      Supported API: true

    • getSessionId

      String getSessionId()
      ID of session actually in use

      Supported API: true

    • getAverageActiveRequests

      double getAverageActiveRequests()
      Get average requests active during this request

      Supported API: true

    • getElapsedSeconds

      double getElapsedSeconds()
      Elapsed time of request

      Supported API: true

    • isBeingThrottled

      boolean isBeingThrottled()
      Whether the request is currently being throttled

      Supported API: true

    • getThrottledSeconds

      double getThrottledSeconds()
      Time for which request has been throttled

      Supported API: true

    • getElapsedProcessCpuSeconds

      double getElapsedProcessCpuSeconds()
      Elapsed CPU time of overall servlet engine process during request; only meaningful if ServletRequestMonitorMBean's ProcessCpuTimeMonitoringEnabled attribute is true

      Supported API: true

    • getElapsedCpuSeconds

      double getElapsedCpuSeconds()
      Elapsed CPU time of request thread during request

      Supported API: true

    • getElapsedUserSeconds

      double getElapsedUserSeconds()
      Elapsed CPU time executing in user mode for request thread during request

      Supported API: true

    • getWaitedCount

      long getWaitedCount()
      Number of times request thread was in either WAITING or TIMED_WAITING state

      Supported API: true

    • getWaitedSeconds

      double getWaitedSeconds()
      Time request thread spent in either WAITING or TIMED_WAITING state; -1 unless ThreadContentionMonitoringEnabled is set

      Supported API: true

    • getBlockedCount

      long getBlockedCount()
      Number of times request thread was in BLOCKED state

      Supported API: true

    • getBlockedSeconds

      double getBlockedSeconds()
      Time request thread spent in BLOCKED state; -1 unless ThreadContentionMonitoringEnabled is set

      Supported API: true

    • getBytesAllocated

      long getBytesAllocated()
      Estimated number of bytes allocated by the request thread during this request; -1 when this information is not available

      Supported API: true

    • getRMICalls

      long getRMICalls()
      RMI calls recorded as occurring from request thread during request

      Supported API: true

    • getRMIElapsedSeconds

      double getRMIElapsedSeconds()
      Elapsed time of RMI calls recorded as occurring from request thread during request

      Supported API: true

    • getPercentageOfElapsedTimeInRMI

      double getPercentageOfElapsedTimeInRMI()
      Percentage of elapsed request time spent in RMI calls

      Supported API: true

    • getIECalls

      long getIECalls()
      IE calls recorded as occurring from request thread during request

      Supported API: true

    • getIEElapsedSeconds

      double getIEElapsedSeconds()
      Elapsed time of IE calls recorded as occurring from request thread during request

      Supported API: true

    • getPercentageOfElapsedTimeInIE

      double getPercentageOfElapsedTimeInIE()
      Percentage of elapsed request time spent in IE calls

      Supported API: true

    • getSOAPCalls

      long getSOAPCalls()
      SOAP calls recorded as occurring from request thread during request

      Supported API: true

    • getJNDICalls

      long getJNDICalls()
      JNDI calls recorded as occurring from request thread during request

      Supported API: true

    • getSOAPElapsedSeconds

      double getSOAPElapsedSeconds()
      Elapsed time of SOAP calls recorded as occurring from request thread during request

      Supported API: true

    • getJNDIElapsedSeconds

      double getJNDIElapsedSeconds()
      Elapsed time of JNDI calls recorded as occurring from request thread during request

      Supported API: true

    • getPercentageOfElapsedTimeInSOAP

      double getPercentageOfElapsedTimeInSOAP()
      Percentage of elapsed request time spent in SOAP calls

      Supported API: true

    • getPercentageOfElapsedTimeInJNDI

      double getPercentageOfElapsedTimeInJNDI()
      Percentage of elapsed request time spent in JNDI calls

      Supported API: true

    • getPercentageOfTotalCpuTime

      double getPercentageOfTotalCpuTime()
      Request CPU time as a percent of overall during request time frame

      Supported API: true

    • getProcessPercentageOfTotalCpuTime

      double getProcessPercentageOfTotalCpuTime()
      Servlet engine process CPU time as a percent of overall during request time frame; only meaningful if ServletRequestMonitorMBean's ProcessCpuTimeMonitoringEnabled attribute is true

      Supported API: true

    • getPercentageOfProcessCpuTime

      double getPercentageOfProcessCpuTime()
      Request CPU time as a percent of servlet engine process during request time frame; only meaningful if ServletRequestMonitorMBean's ProcessCpuTimeMonitoringEnabled attribute is true

      Supported API: true

    • getBlockingCallTarget

      String getBlockingCallTarget()
      Description of the target of a call (to another server process, for example) that this request is currently waiting upon, when the call has been specifically instrumented to register this (which is most often not the case)

      Supported API: true

    • getBlockingCallId

      String getBlockingCallId()
      Id of a call (to another server process, for example) that this request is currently waiting upon, when the call has been specifically instrumented to register this (which is most often not the case)

      Supported API: true

    • getBlockingCallInfo

      CompositeData getBlockingCallInfo() throws OpenDataException
      Information on call (to another server process, for example) that this request is currently waiting upon, when the call has been specifically instrumented to register this (which is most often not the case)

      Supported API: true
      Throws:
      OpenDataException

    • isCompleted

      boolean isCompleted()
      Whether request has been completed (with or without error)

      Supported API: true

    • getRequestParameters

      String[] getRequestParameters()
      Servlet request parameters (contained in the query string and/or posted form data)

      Supported API: true

    • getRequestParameterData

      TabularData getRequestParameterData() throws OpenDataException
      Servlet request parameters (contained in the query string and/or posted form data)

      Supported API: true
      Throws:
      OpenDataException

    • getRequestHeaderNames

      String[] getRequestHeaderNames()
      HTTP request header names

      Supported API: true

    • getRequestHeaders

      String[] getRequestHeaders()
      HTTP request headers

      Supported API: true

    • getRequestHeaderData

      TabularData getRequestHeaderData() throws OpenDataException
      HTTP request headers

      Supported API: true
      Throws:
      OpenDataException

    • getCookies

      String[] getCookies()
      HTTP cookies

      Supported API: true

    • getCookieData

      CompositeData[] getCookieData() throws OpenDataException
      HTTP cookies

      Supported API: true
      Throws:
      OpenDataException

    • getStatusCode

      int getStatusCode()
      HTTP status code returned; -1 if not known

      Supported API: true

    • getStatusMessage

      String getStatusMessage()
      HTTP response status message

      Supported API: true

    • getContentBytesRead

      long getContentBytesRead()
      Number of bytes read from request content body via the request input stream; does not include reads by getParameter*() APIs

      Supported API: true

    • getContentCharsRead

      long getContentCharsRead()
      Approximate number of characters read from request content body via the request reader; does not include reads by getParameter*() APIs

      Supported API: true

    • getResponseContentLength

      long getResponseContentLength()
      Length of the content body in the response according to the HTTP Content-Length header or -1 if not set

      Supported API: true

    • getContentBytesOutput

      long getContentBytesOutput()
      Number of bytes actually output to content body via the response output stream

      Supported API: true

    • getContentCharsOutput

      long getContentCharsOutput()
      Number of characters actually output to content body via the response writer

      Supported API: true

    • isOutputCompressed

      boolean isOutputCompressed()
      Whether output is compressed by wt.servlet.CompressionFilter

      Supported API: true

    • getUncompressedBytesOutput

      long getUncompressedBytesOutput()
      Number of bytes output to content body via the response output stream prior to compression

      Supported API: true

    • getCompressionRatioAsPercent

      double getCompressionRatioAsPercent()
      Ratio of compressed to uncompressed bytes output as a percentage (100*ContentBytesOutput/UncompressedBytesOutput)

      Supported API: true

    • isResponseCommitted

      boolean isResponseCommitted()
      Whether response (and its headers and response status code) has been committed yet or not

      Supported API: true

    • getResponseContentType

      String getResponseContentType()
      Content type of the response being sent to the client according to Content-Type header, if set

      Supported API: true

    • isError

      boolean isError()
      Whether the request generated an error status code

      Supported API: true

    • getExceptionClass

      String getExceptionClass()
      Class name of exception thrown by request

      Supported API: true

    • getExceptionMessage

      String getExceptionMessage()
      Message of exception thrown by request

      Supported API: true

    • getExceptionStackTrace

      String[] getExceptionStackTrace()
      Stack trace of exception thrown by request

      Supported API: true

    • getStackTrace

      String[] getStackTrace()
      Detailed information on the thread running this request (returns null after request has completed)

      Supported API: true

    • dumpStackTrace

      @MBeanOperationImpact(0) String[] dumpStackTrace()
      Returns detailed information on the thread running this request (returns null after request has completed)

      Supported API: true

    • emailStackTrace

      @MBeanOperationImpact(0) void emailStackTrace(String addressesOrEmailList, String subject) throws IOException, SAXException
      E-mails detailed information on the thread running this request (only functions until request is completed)

      Supported API: true
      Parameters:
      addressesOrEmailList - Comma-delimited list of e-mail addresses or name of e-mail list to send e-mail to
      subject - Subject to give e-mail
      Throws:
      IOException
      SAXException

    • getRequestParameterValues

      @MBeanOperationImpact(0) String[] getRequestParameterValues(String paramName)
      Returns values for a specified servlet request parameter

      Supported API: true
      Parameters:
      paramName - Name of servlet request parameter to retrieve values of

    • getRequestHeaderValues

      @MBeanOperationImpact(0) String[] getRequestHeaderValues(String headerName)
      Returns values for a specified HTTP request header

      Supported API: true
      Parameters:
      headerName - Name of HTTP request header to retrieve values of

    • interrupt

      @MBeanOperationImpact(1) void interrupt()
      If the request is not completed, interrupts its thread. WARNING: This is a somewhat drastic operation which may have side-effects.

      Supported API: true