|
SAP BI Java SDK | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.sap.ip.bi.sdk.util.BISatCheck
An implementation of ISatCheck
(JARM-SAT adapter) used by SAP's
JARM (Java Application Responsetime Measurement) Log Adapter via
SatCheckHandler.registerSatCheck
to allow the Log Adapter to
check whether trace data has to be collected
(isTraceOn(String,String)
or
isTraceOn(String,String,long,int)
).
Trace data is delivered only if both of the following conditions are true:
isTraceOn(user, request)
delivers true at request startisTraceOn(user, request, duration, outData)
delivers true at
request end is provided with trace data; data is delivered only once to
data recipients of the same type.
Constructor Summary | |
BISatCheck(String userName)
Constructs a new BISatCheck object with the given user name. |
|
BISatCheck(String userName,
long duration,
int outData)
Constructs a new BISatCheck object with the given user name,
duration of request, and amount of data. |
Method Summary | |
boolean |
isTraceOn(String userName,
String reqName)
Checks whether trace data should be written to a trace file during the request by JARM. |
boolean |
isTraceOn(String userName,
String reqName,
long duration,
int outData)
Checks whether trace data should be written to a trace file during the request by JARM. |
static void |
setup(File propFile)
File containing Properties for JARM-SAT trace switch. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public BISatCheck(String userName)
BISatCheck
object with the given user name.userName
- user name; could be null
if no name is
provided to JARMpublic BISatCheck(String userName, long duration, int outData)
BISatCheck
object with the given user name,
duration of request, and amount of data.userName
- user name; could be null
if no name is
provided to JARMduration
- duration of request in millisecondsoutData
- amount of data transfered by the request in bytes;
ConfMonitor.UNDEFDATA
if no data is collectedMethod Detail |
public boolean isTraceOn(String userName, String reqName)
true
.
The call to collect the data is made at the beginning of the request; the decision to write to the trace file is finally decided at the end of the request.
isTraceOn
in interface com.sap.util.monitor.jarm.sat.ISatCheck
userName
- user name; could be null
if no name is
provided to JARMreqName
- logical name of the request; could be null
if no name is provided to JARMtrue
if data should be written to the trace filepublic boolean isTraceOn(String userName, String reqName, long duration, int outData)
true
.
The call to collect the data is made at the beginning of the request; the decision to write to the trace file is finally decided at the end of the request.
isTraceOn
in interface com.sap.util.monitor.jarm.sat.ISatCheck
userName
- user name; could be null
if no name is
provided to JARMreqName
- logical name of the request; could be null
if no name is provided to JARMduration
- duration of request in millisecondsoutData
- amount of data transfered by the request in bytes;
ConfMonitor.UNDEFDATA
if no data is collectedtrue
if data should be written to the trace filepublic static void setup(File propFile) throws IOException
Properties
for JARM-SAT trace switch.propFile
- file containing properties for JARM-SAT trace switchIOException
- if the file could not be opened
|
SAP BI Java SDK | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |