SAP BI Java SDK

com.sap.ip.bi.sdk.util
Class BISatCheck

java.lang.Object
  |
  +--com.sap.ip.bi.sdk.util.BISatCheck
All Implemented Interfaces:
com.sap.util.monitor.jarm.sat.ISatCheck

public class BISatCheck
extends Object
implements com.sap.util.monitor.jarm.sat.ISatCheck

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:

Since:
3.50

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

BISatCheck

public BISatCheck(String userName)
Constructs a new BISatCheck object with the given user name.
Parameters:
userName - user name; could be null if no name is provided to JARM

BISatCheck

public BISatCheck(String userName,
                  long duration,
                  int outData)
Constructs a new BISatCheck object with the given user name, duration of request, and amount of data.
Parameters:
userName - user name; 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 data is collected
Method Detail

isTraceOn

public boolean isTraceOn(String userName,
                         String reqName)
Checks whether trace data should be written to a trace file during the request by JARM. This data is collected by JARM by default but not written to a trace file unless this method returns 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.

Specified by:
isTraceOn in interface com.sap.util.monitor.jarm.sat.ISatCheck
Parameters:
userName - user name; could be 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 if data should be written to the trace file

isTraceOn

public 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. Trace data also includes duration of request and amount of data collected. This data is collected by JARM by default but not written to a trace file unless this method returns 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.

Specified by:
isTraceOn in interface com.sap.util.monitor.jarm.sat.ISatCheck
Parameters:
userName - user name; could be 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 data is collected
Returns:
true if data should be written to the trace file

setup

public static void setup(File propFile)
                  throws IOException
File containing Properties for JARM-SAT trace switch.
Parameters:
propFile - file containing properties for JARM-SAT trace switch
Throws:
IOException - if the file could not be opened
Since:
3.50 SP2

SAP BI Java SDK

Copyright © 2004-2006 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.
These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.