wt.servlet
Interface RequestMBean

public interface RequestMBean

Detailed information related to a single servlet engine request.

Supported API: true

Extendable: true

Method Summary

String[]	dumpStackTrace() Returns detailed information on the thread running this request (only functions until request is 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 servlet Supported API: true
double	getAverageActiveRequests() Get average requests active during this request 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
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
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 occuring from request thread during request Supported API: true
double	getIEElapsedSeconds() Elapsed time of IE calls recorded as occuring from request thread during request Supported API: true
long	getJNDICalls() JNDI calls recorded as occuring from request thread during request Supported API: true
double	getJNDIElapsedSeconds() Elapsed time of JNDI calls recorded as occuring 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 timeframe; only meaningful if ServletRequestMonitorMBean's ProcessCpuTimeMonitoringEnabled attribute is true Supported API: true
double	getPercentageOfTotalCpuTime() Request CPU time as a percent of overall during request timeframe Supported API: true
double	getProcessPercentageOfTotalCpuTime() Servlet engine process CPU time as a percent of overall during request timeframe; 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
String[]	getRequestHeaders() HTTP request headers Supported API: true
String[]	getRequestParameters() HTTP request parameters (contained in the query string and/or posted form data) 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
int	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 occuring from request thread during request Supported API: true
double	getRMIElapsedSeconds() Elapsed time of RMI calls recorded as occuring from request thread during request Supported API: true
String	getSessionId() ID of session actually in use Supported API: true
long	getSOAPCalls() SOAP calls recorded as occuring from request thread during request Supported API: true
double	getSOAPElapsedSeconds() Elapsed time of SOAP calls recorded as occuring from request thread during request 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	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	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	isRequestedSessionIdValid() Whether the requested session ID is still valid Supported API: true

Method Detail

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

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 servlet

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

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

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

getWaitedSeconds

double getWaitedSeconds()

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

Supported API: true

getBlockedSeconds

double getBlockedSeconds()

Time request thread spent in BLOCKED state; -1 unless ThreadContentionMonitoringEnabled is set

Supported API: true

getRMICalls

long getRMICalls()

RMI calls recorded as occuring from request thread during request

Supported API: true

getRMIElapsedSeconds

double getRMIElapsedSeconds()

Elapsed time of RMI calls recorded as occuring 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 occuring from request thread during request

Supported API: true

getIEElapsedSeconds

double getIEElapsedSeconds()

Elapsed time of IE calls recorded as occuring 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 occuring from request thread during request

Supported API: true

getJNDICalls

long getJNDICalls()

JNDI calls recorded as occuring from request thread during request

Supported API: true

getSOAPElapsedSeconds

double getSOAPElapsedSeconds()

Elapsed time of SOAP calls recorded as occuring from request thread during request

Supported API: true

getJNDIElapsedSeconds

double getJNDIElapsedSeconds()

Elapsed time of JNDI calls recorded as occuring 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 timeframe

Supported API: true

getProcessPercentageOfTotalCpuTime

double getProcessPercentageOfTotalCpuTime()

Servlet engine process CPU time as a percent of overall during request timeframe; 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 timeframe; 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

isCompleted

boolean isCompleted()

Whether request has been completed (with or without error)

Supported API: true

getRequestParameters

String[] getRequestParameters()

HTTP request parameters (contained in the query string and/or posted form data)

Supported API: true

getRequestHeaders

String[] getRequestHeaders()

HTTP request headers

Supported API: true

getStatusCode

int getStatusCode()

HTTP status code returned; -1 if not known

Supported API: true

getStatusMessage

String getStatusMessage()

HTTP response status message

Supported API: true

getResponseContentLength

int getResponseContentLength()

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

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

dumpStackTrace

String[] dumpStackTrace()

Returns detailed information on the thread running this request (only functions until request is completed)

Supported API: true

emailStackTrace

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

interrupt

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