com.sap.util.monitor.jarm
Interface IJarmDataRecipient

public interface IJarmDataRecipient

An implementation of this interface has to be provided to JARM via ConfMonitor.registerDataRecipient to allow JARM to check whether trace data has to be collected (isTraceOn()) and to deliver this data via notifyAtRequestEnd().

 trace data is delivered only if following conditions are true:
 - trace data is collected right from the beginning of the request;
   this is done if there is at least one data recipient whose check function
   isTraceOn(user, request) delivers true at request start
 - if the condition above is true every data recipient whose check function
   isTraceOn(user, request, duration, outData) delivers true at request end
   is provided with trace data
 

Field Summary

static int

RECIPIENTTYPELOGGER Recipient type for Jarm Data; all possible recipient types have to be listed here

Method Summary

int	getRecipientType() return recipient type of recipient implementation
boolean	isTraceOn(java.lang.String userName, java.lang.String reqName) method is called at the beginning of a request to check whether trace data should be collected during the request by JARM; this could be data which is collected by JARM anyway but also additional information; therefore this call is made at the beginning of the request; whether the data is delivered or not is finally decided at the end of the request via isTraceOn(user, request, duration, outData)
boolean	isTraceOn(java.lang.String userName, java.lang.String reqName, long duration, int outData) method is called at the end of a request to check whether data should be delivered via notifyAtRequestEnd()
void	notifyAtRequestEnd(RequestOverviewExt reqOverview) method called during endRequest() to get the collected request data; is only called if trace is on

Field Detail

RECIPIENTTYPELOGGER

public static final int RECIPIENTTYPELOGGER

Recipient type for Jarm Data; all possible recipient types have to be listed here

Method Detail

getRecipientType

public int getRecipientType()

return recipient type of recipient implementation

notifyAtRequestEnd

public void notifyAtRequestEnd(RequestOverviewExt reqOverview)

method called during endRequest() to get the collected request data; is only called if trace is on

isTraceOn

public boolean isTraceOn(java.lang.String userName,
                         java.lang.String reqName)

method is called at the beginning of a request to check whether trace data should be collected during the request by JARM; this could be data which is collected by JARM anyway but also additional information; therefore this call is made at the beginning of the request; whether the data is delivered or not is finally decided at the end of the request via isTraceOn(user, request, duration, outData)

Parameters:

userName - user name; could by 'null' if no name is provided to JARM

reqName - logical name of the request; could be 'null' if no name is provided to JARM

Returns:

true <-> data should be collected

isTraceOn

public boolean isTraceOn(java.lang.String userName,
                         java.lang.String reqName,
                         long duration,
                         int outData)

method is called at the end of a request to check whether data should be delivered via notifyAtRequestEnd()

Parameters:

userName - user name; could by 'null' if no name is provided to JARM

reqName - logical name of the request; could be 'null' if no name is provided to JARM

duration - duration of request in milliseconds

outData - amount of data transfered by the request in bytes; ConfMonitor.UNDEFDATA if no information is available

Returns:

true <-> data should be delivered via notifyAtRequestEnd()