wt.method
Interface MethodContextMBean


public interface MethodContextMBean

Detailed information related to a method server request context.

Supported API: true

Extendable: true


Method Summary
 String[] dumpStackTrace()
          Returns detailed information on the thread running this context (only functions until context is completed)

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

Supported API: true
 String getAccessLogDetail()
          Extra detail on method context beyond target class and method (e.g.
 String[] getArgs()
          Arguments provided to TargetMethod

Supported API: true
 String[] getArgTypes()
          Types of arguments associated with TargetMethod

Supported API: true
 double getAverageActiveContexts()
          Average contexts active during lifespan of this context

Supported API: true
 double getBlockedSeconds()
          Approximate time context thread was in blocked state; 0 unless thread contention monitoring is enabled

Supported API: true
 String getClientHost()
          Host from which RMI request came in the case of a RMI request

Supported API: true
 double getElapsedExecutionSeconds()
          Time spent executing in method context

Supported API: true
 double getElapsedJDBCSeconds()
          Total time spent (in seconds) to process JBC calls.
 double getElapsedJNDISeconds()
          Total time spent (in seconds) to process JNDI calls.
 double getElapsedMarshalSeconds()
          Time spent marshaling results (RMI case only)

Supported API: true
 double getElapsedTotalCpuSeconds()
          Overall CPU time spent in context

Supported API: true
 double getElapsedTotalSeconds()
          Total time spent in context

Supported API: true
 double getElapsedTotalUserSeconds()
          User CPU time spent in context

Supported API: true
 double getElapsedUnmarshalSeconds()
          Time spent (in seconds) unmarshaling arguments (RMI case only)

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

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

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

Supported API: true
 String getExecutionPhase()
          Phase of execution method context is currently in

Supported API: true
 String getId()
          Id of method context

Supported API: true
 String getIeContextId()
          Id of the most recently associated IeContext, if one exists; -1 otherwise

Supported API: true
 String[] getIeContextIds()
          Array of associated IeContext Ids, if they exists

Supported API: true
 double getJDBCConnectionWaitTimeSeconds()
          Time spent (in seconds) waiting to acquire a JDBC connection.
 String[] getJDBCDatabaseSessionIds()
          List of JDBC database session IDs used.
 long getJDBCQueryCalls()
          Total number of JDBC query calls.
 long getJNDICalls()
          Number of JNDI calls invoked.
 CompositeData getObjectCounterData()
          Data about WTObject allocation associated with this context; no data will be collected unless MethodContextMonitorMBean's ObjectCounterEnabled attribute is true

Supported API: true
 double getPercentageOfElapsedTimeInJDBC()
          Percentage of total time spent processing JDBC calls.
 double getPercentageOfElapsedTimeInJDBCConnWait()
          Percentage of total time spent waiting to acquire a JDBC connection.
 double getPercentageOfElapsedTimeInJNDI()
          Percentage of total time spent processing JNDI calls.
 double getPercentageOfProcessCpuTime()
          Request CPU time as a percent of method server process during lifespan of this context; only meaningful if MethodContextMonitorMBean's ProcessCpuTimeMonitoringEnabled attribute is true

Supported API: true
 double getPercentageOfTotalCpuTime()
          Context CPU time as a percent of overall during lifespan of this context

Supported API: true
 double getProcessPercentageOfTotalCpuTime()
          Method server process CPU time as a percent of overall during lifespan of this context; only meaningful if MethodContextMonitorMBean's ProcessCpuTimeMonitoringEnabled attribute is true

Supported API: true
 int getRedirects()
          Number of times context has been redirected

Supported API: true
 String getRemoteAddr()
          IP address of remote client, if known

Supported API: true
 String getResultClass()
          Classname of result

Supported API: true
 String getServletRequestId()
          Id of associated servlet request, if known

Supported API: true
 String getSessionId()
          Id of SessionContext associated with method context

Supported API: true
 Timestamp getStartTime()
          Time method context started

Supported API: true
 String getSynopsis()
          Combination of target class and method, where available, and AccessLogDetail

Supported API: true
 String getTargetClass()
          Target class of method context

Supported API: true
 String getTargetMethod()
          Target method of method context

Supported API: true
 long getThreadId()
          Id of thread last associated with method context

Supported API: true
 String getThreadName()
          Name of thread last associated with method context

Supported API: true
 String getUserName()
          Name of user method context is operating on behalf of

Supported API: true
 double getWaitedSeconds()
          Approximate time context thread was in waiting or timed waiting state; 0 unless thread contention monitoring is enabled

Supported API: true
 long getWTObjectsConstructed()
          Count of WTObjects created by this context; no data will be collected unless MethodContextMonitorMBean's ObjectCounterEnabled attribute is true and if there is no data this attribute's value will be -1

Supported API: true
 long getWTObjectsFinalized()
          Count of WTObjects created by this context which have been finalized; no data will be collected unless MethodContextMonitorMBean's ObjectCounterEnabled attribute is true and if there is no data this attribute's value will be -1

Supported API: true
 void interrupt()
          If the method context is not completed, interrupts its thread

Supported API: true
 boolean isCompleted()
          Whether method context has completed

Supported API: true
 boolean isError()
          Whether an exception (other than an AuthenticationException) occured in this context

Supported API: true
 boolean isRedirected()
          Whether method context has been (or is being) redirected

Supported API: true
 boolean isRMICall()
          Whether method context is directly due to an RMI call

Supported API: true
 

Method Detail

getId

String getId()
Id of method context

Supported API: true


getThreadId

long getThreadId()
Id of thread last associated with method context

Supported API: true


getThreadName

String getThreadName()
Name of thread last associated with method context

Supported API: true


getSessionId

String getSessionId()
Id of SessionContext associated with method context

Supported API: true


getUserName

String getUserName()
Name of user method context is operating on behalf of

Supported API: true


getTargetClass

String getTargetClass()
Target class of method context

Supported API: true


getTargetMethod

String getTargetMethod()
Target method of method context

Supported API: true


getResultClass

String getResultClass()
Classname of result

Supported API: true


getSynopsis

String getSynopsis()
Combination of target class and method, where available, and AccessLogDetail

Supported API: true


getAccessLogDetail

String getAccessLogDetail()
Extra detail on method context beyond target class and method (e.g. path info, command delegate, or the like)

Supported API: true


getRedirects

int getRedirects()
Number of times context has been redirected

Supported API: true


isRMICall

boolean isRMICall()
Whether method context is directly due to an RMI call

Supported API: true


getArgTypes

String[] getArgTypes()
Types of arguments associated with TargetMethod

Supported API: true


getArgs

String[] getArgs()
Arguments provided to TargetMethod

Supported API: true


getIeContextId

String getIeContextId()
Id of the most recently associated IeContext, if one exists; -1 otherwise

Supported API: true


getIeContextIds

String[] getIeContextIds()
Array of associated IeContext Ids, if they exists

Supported API: true


getServletRequestId

String getServletRequestId()
Id of associated servlet request, if known

Supported API: true


getRemoteAddr

String getRemoteAddr()
IP address of remote client, if known

Supported API: true


getClientHost

String getClientHost()
Host from which RMI request came in the case of a RMI request

Supported API: true


getStartTime

Timestamp getStartTime()
Time method context started

Supported API: true


isCompleted

boolean isCompleted()
Whether method context has completed

Supported API: true


isRedirected

boolean isRedirected()
Whether method context has been (or is being) redirected

Supported API: true


getExecutionPhase

String getExecutionPhase()
Phase of execution method context is currently in

Supported API: true


getElapsedUnmarshalSeconds

double getElapsedUnmarshalSeconds()
Time spent (in seconds) unmarshaling arguments (RMI case only)

Supported API: true


getElapsedExecutionSeconds

double getElapsedExecutionSeconds()
Time spent executing in method context

Supported API: true


getElapsedMarshalSeconds

double getElapsedMarshalSeconds()
Time spent marshaling results (RMI case only)

Supported API: true


getElapsedTotalSeconds

double getElapsedTotalSeconds()
Total time spent in context

Supported API: true


getElapsedTotalCpuSeconds

double getElapsedTotalCpuSeconds()
Overall CPU time spent in context

Supported API: true


getElapsedTotalUserSeconds

double getElapsedTotalUserSeconds()
User CPU time spent in context

Supported API: true


getBlockedSeconds

double getBlockedSeconds()
Approximate time context thread was in blocked state; 0 unless thread contention monitoring is enabled

Supported API: true


getWaitedSeconds

double getWaitedSeconds()
Approximate time context thread was in waiting or timed waiting state; 0 unless thread contention monitoring is enabled

Supported API: true


getPercentageOfTotalCpuTime

double getPercentageOfTotalCpuTime()
Context CPU time as a percent of overall during lifespan of this context

Supported API: true


getProcessPercentageOfTotalCpuTime

double getProcessPercentageOfTotalCpuTime()
Method server process CPU time as a percent of overall during lifespan of this context; only meaningful if MethodContextMonitorMBean's ProcessCpuTimeMonitoringEnabled attribute is true

Supported API: true


getPercentageOfProcessCpuTime

double getPercentageOfProcessCpuTime()
Request CPU time as a percent of method server process during lifespan of this context; only meaningful if MethodContextMonitorMBean's ProcessCpuTimeMonitoringEnabled attribute is true

Supported API: true


getAverageActiveContexts

double getAverageActiveContexts()
Average contexts active during lifespan of this context

Supported API: true


getJNDICalls

long getJNDICalls()
Number of JNDI calls invoked.

Supported API: true


getElapsedJNDISeconds

double getElapsedJNDISeconds()
Total time spent (in seconds) to process JNDI calls.

Supported API: true


getPercentageOfElapsedTimeInJNDI

double getPercentageOfElapsedTimeInJNDI()
Percentage of total time spent processing JNDI calls.

Supported API: true


getJDBCQueryCalls

long getJDBCQueryCalls()
Total number of JDBC query calls.

Supported API: true


getElapsedJDBCSeconds

double getElapsedJDBCSeconds()
Total time spent (in seconds) to process JBC calls.

Supported API: true


getPercentageOfElapsedTimeInJDBC

double getPercentageOfElapsedTimeInJDBC()
Percentage of total time spent processing JDBC calls.

Supported API: true


getJDBCConnectionWaitTimeSeconds

double getJDBCConnectionWaitTimeSeconds()
Time spent (in seconds) waiting to acquire a JDBC connection.

Supported API: true


getPercentageOfElapsedTimeInJDBCConnWait

double getPercentageOfElapsedTimeInJDBCConnWait()
Percentage of total time spent waiting to acquire a JDBC connection.

Supported API: true


getJDBCDatabaseSessionIds

String[] getJDBCDatabaseSessionIds()
List of JDBC database session IDs used.

Supported API: true


isError

boolean isError()
Whether an exception (other than an AuthenticationException) occured in this context

Supported API: true


getExceptionClass

String getExceptionClass()
Class name of exception thrown by context

Supported API: true


getExceptionMessage

String getExceptionMessage()
Message of exception thrown by context

Supported API: true


getExceptionStackTrace

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

Supported API: true


getWTObjectsConstructed

long getWTObjectsConstructed()
Count of WTObjects created by this context; no data will be collected unless MethodContextMonitorMBean's ObjectCounterEnabled attribute is true and if there is no data this attribute's value will be -1

Supported API: true


getWTObjectsFinalized

long getWTObjectsFinalized()
Count of WTObjects created by this context which have been finalized; no data will be collected unless MethodContextMonitorMBean's ObjectCounterEnabled attribute is true and if there is no data this attribute's value will be -1

Supported API: true


getObjectCounterData

CompositeData getObjectCounterData()
                                   throws OpenDataException
Data about WTObject allocation associated with this context; no data will be collected unless MethodContextMonitorMBean's ObjectCounterEnabled attribute is true

Supported API: true

Throws:
OpenDataException

dumpStackTrace

String[] dumpStackTrace()
Returns detailed information on the thread running this context (only functions until context is completed)

Supported API: true


emailStackTrace

void emailStackTrace(String addressesOrEmailList,
                     String subject)
                     throws IOException,
                            SAXException
E-mails detailed information on the thread running this context (only functions until context 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 method context is not completed, interrupts its thread

Supported API: true