com.sap.util.monitor.jarm
Class ConfMonitor

java.lang.Object
  |
  +--com.sap.util.monitor.jarm.ConfMonitor

All Implemented Interfaces:

IConfMonitor

public class ConfMonitor

extends java.lang.Object

implements IConfMonitor

Class contains constants and configuration parameters used for monitoring. Additionally there are methods to set and get the parameters.

Field Summary

static int	initMaxCompRet max. number of components which could be returned for a component overview
static int	initMaxUserRet max. number of user which could be returned for a user overview
static int	initNrTops number of entries in hit lists
static com.sap.util.monitor.jarm.RmiMonitor	rmiObject

Fields inherited from interface com.sap.util.monitor.jarm.IConfMonitor

COMPLEVEL, COMPLEVELBASIC, COMPLEVELDETAIL, COMPLEVELMEDIUM, COMPPROPERTIESGETSWITCH, COMPPROPERTIESSETSWITCH, COMPTRACELEVEL, CONSUMERCLASS, CONSUMERPREFIX, CONSUMERRESTART, CONSUMERSWITCH, KEYINSTRCHECK, KEYMAXREQCOMPHIGH, KEYMAXREQCOMPLOW, KEYMONITOR, KEYPARTNEREXCL, KEYVERSION, LOGFILEDIR, LOGLEVEL, MONITORPREFIX, NAMENOTSET, NOCOMPACTIVE, NUMBERNOTSET, REQCOMPNOTCLOSED, REQCOMPTOOMANYHIGH, REQCOMPTOOMANYLOW, REQOK, REQOVERVIEWALL, REQOVERVIEWHEADER, REQOVERVIEWNONE, RESETALL, RESETCOMPONENTS, RESETREQUESTS, RESETUSERS, RMIPORT, RMIPREFIX, RMISTARTREGISTRY, RMISWITCH, TOPACCGROSSTIME, TOPCALLNUM, TOPGROSSCPUTIME, TOPGROSSTIME, TOPNETCPUTIME, TOPNETTIME, TOPOUTDATA, TRACESWITCH, UNDEFDATA, UNDEFNAME, UNDEFTIME, VALUEALL, VALUENONE, VALUEOFF, VALUEON

Constructor Summary

ConfMonitor()

Method Summary

static boolean	deRegisterDataRecipient(IJarmDataRecipient dataRecip) deregister data recipient
static int	getComponentLevel() Indicates the component monitor level; this level is used if monitoring is on and tracing is off; if both are switched on the most detailed level defined for monitoring and tracing is used could also be done by getProperties()
static int	getComponentTraceLevel() Indicates the component trace level; this level is used if tracing is on and monitoring is off; if both are switched on the most detailed level defined for monitoring and tracing is used could also be done by getProperties()
static boolean	getMonitorSwitch() Indicates whether monitoring is switched on or off could also be done by getProperties()
static java.util.Properties	getProperties() Delivers the parameters currently valid for monitoring;
static boolean	isCpuMeasured() Indicates whether CPU measurement is done
static boolean	registerDataRecipient(IJarmDataRecipient dataRecip) register data recipient
static void	setCompDescription(java.lang.String compName, java.lang.String compDescr) Set description for single component (text string); if the description is already set for this component it could not be overwritten
static void	setCompProps(java.lang.String compName, ICompProperties propImpl) Set implementation for component specific properties; if the properties are already set for this component it could not be overwritten; without an implementation component specific properties are not handled
static void	setJ2eeProperties(java.util.Properties props) Set monitoring parameters; After using this method one time no other methods to set properties are processed
static void	setMonitorOff() Switches monitoring off; is valid for requests which start after this call could also be done by setProperties()
static void	setMonitorOn() Switches monitoring on; is valid for requests which start after this call could also be done by setProperties()
static void	setProperties(java.util.Properties props) Set monitoring parameters;

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

initNrTops

public static int initNrTops

number of entries in hit lists

initMaxCompRet

public static int initMaxCompRet

max. number of components which could be returned for a component overview

initMaxUserRet

public static int initMaxUserRet

max. number of user which could be returned for a user overview

rmiObject

public static com.sap.util.monitor.jarm.RmiMonitor rmiObject

Constructor Detail

ConfMonitor

public ConfMonitor()

Method Detail

setMonitorOn

public static void setMonitorOn()

Switches monitoring on;
is valid for requests which start after this call
could also be done by setProperties()

setMonitorOff

public static void setMonitorOff()

Switches monitoring off;
is valid for requests which start after this call
could also be done by setProperties()

getMonitorSwitch

public static boolean getMonitorSwitch()

Indicates whether monitoring is switched on or off
could also be done by getProperties()

Returns:

true <-> monitoring is switched on

getComponentLevel

public static int getComponentLevel()

Indicates the component monitor level; this level is used if monitoring is on and tracing is off; if both are switched on the most detailed level defined for monitoring and tracing is used
could also be done by getProperties()

Returns:

0 (= IConfMonitor.COMPLEVELBASIC)
1 (= IConfMonitor.COMPLEVELMEDIUM)
2 (= IConfMonitor.COMPLEVELDETAIL)

getComponentTraceLevel

public static int getComponentTraceLevel()

Indicates the component trace level; this level is used if tracing is on and monitoring is off; if both are switched on the most detailed level defined for monitoring and tracing is used
could also be done by getProperties()

Returns:

0 (= IConfMonitor.COMPLEVELBASIC)
1 (= IConfMonitor.COMPLEVELMEDIUM)
2 (= IConfMonitor.COMPLEVELDETAIL)

getProperties

public static java.util.Properties getProperties()

Delivers the parameters currently valid for monitoring;

Returns:

the properties object

setJ2eeProperties

public static void setJ2eeProperties(java.util.Properties props)
                              throws MonitorException

Set monitoring parameters;
After using this method one time no other methods to set properties are processed

Parameters:

props - properties object containing the key-value pairs for the parameters; only parameters contained in the properties object will be changed;
to be handled parameter names have to start with "jarm/"

Throws:

MonitorException - thrown if there are wrong parameters used

setProperties

public static void setProperties(java.util.Properties props)
                          throws MonitorException

Set monitoring parameters;

Parameters:

props - properties object containing the key-value pairs for the parameters; only parameters contained in the properties object will be changed;
to be handled parameter names have to start with "jarm/"

Throws:

MonitorException - thrown if there are wrong parameters used

setCompDescription

public static void setCompDescription(java.lang.String compName,
                                      java.lang.String compDescr)

Set description for single component (text string); if the description is already set for this component it could not be overwritten

Parameters:

compName - name of the component

compDescr - description

setCompProps

public static void setCompProps(java.lang.String compName,
                                ICompProperties propImpl)

Set implementation for component specific properties; if the properties are already set for this component it could not be overwritten; without an implementation component specific properties are not handled

Parameters:

compName - name of the component

propImpl - implementation of component specific properties

isCpuMeasured

public static boolean isCpuMeasured()

Indicates whether CPU measurement is done

Returns:

true <-> CPU measurement is done

registerDataRecipient

public static boolean registerDataRecipient(IJarmDataRecipient dataRecip)

register data recipient

Parameters:

dataRecip - recipient for JARM trace data

Returns:

true -> recipient registered successfully
false -> recipient was not registered because same recipient object was already registered

deRegisterDataRecipient

public static boolean deRegisterDataRecipient(IJarmDataRecipient dataRecip)

deregister data recipient

Parameters:

dataRecip - recipient for JARM trace data

Returns:

true -> recipient unregistered successfully
false -> recipient was not registered before