com.pega.pegarules.pub.pal
Interface PAL

public interface PAL

A set of performance statistics for a particular Thread. Some statistics are always returned, and some statistics are optional--they are returned only if specifically requested.

Version:

$Revision: 31 $ $Date: 2009-06-24 09:38:04 -0400 (Wed, 24 Jun 2009) $

Author:

Jamie Gentry

Field Summary

static java.lang.String	COPYRIGHT
static java.lang.String	VERSION

Method Summary

void	clearStats() Resets all the statistics to zero.
int	getInteraction() Return the current interaction number.
ClipboardPage	getStats() Returns the standard statistics for the current Thread, as a clipboard page.
ClipboardPage	getStats(java.util.Set aOptionalStats) Returns the standard statistics for the current Thread, as a clipboard page, as well as some of the optional statistics.
ClipboardPage	getStats(java.lang.String aConnectionID, java.lang.String aThreadName) Returns the statistics for a different Thread, as a clipboard page
void	incrementAlertCount() Increments the value of the "number of alerts generated" statistic.
void	incrementConnectCount() Increments the value of the "number of external connections" statistic.
void	incrementFlowCount() increment the value of "flow count" - the count of "BPM" invocations (advancing a work object)
void	startJavaStepTimer(boolean aNewStep) Starts timing for a Java step of an Activity
void	startOrStopTimer(java.lang.String timer, boolean on) Searches for the timer named by string and either starts or stops it depending on the ON value.
void	startTimingConnect() Starts recording the time spent in an external connection.
void	stopJavaStepTimer() Stops timing for a Java step of an Activity
void	stopTimingConnect() Stops recording the time spent in an external connection.

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

See Also:

Constant Field Values

Method Detail

getStats

ClipboardPage getStats()

Returns the standard statistics for the current Thread, as a clipboard page. None of the optional statistics are returned.

Returns:

the statistics

getStats

ClipboardPage getStats(java.util.Set aOptionalStats)

Returns the standard statistics for the current Thread, as a clipboard page, as well as some of the optional statistics.

Parameters:

aOptionalStats - the names of the optional statistics that are desired. The Code-Pega-PAL property names of these statistics must be supplied as Strings.

Returns:

the statistics

getStats

ClipboardPage getStats(java.lang.String aConnectionID,
                       java.lang.String aThreadName)

Returns the statistics for a different Thread, as a clipboard page

Parameters:

aConnectionID - the connection ID for the Requestor containing the desired Thread

aThreadName - the name of the desired Thread

Returns:

the statistics

clearStats

void clearStats()

Resets all the statistics to zero.

incrementConnectCount

void incrementConnectCount()

Increments the value of the "number of external connections" statistic.

incrementAlertCount

void incrementAlertCount()

Increments the value of the "number of alerts generated" statistic.

startTimingConnect

void startTimingConnect()

Starts recording the time spent in an external connection. This method should be invoked before calling an external service.

stopTimingConnect

void stopTimingConnect()

Stops recording the time spent in an external connection. This method should be invoked after calling an external service.

startJavaStepTimer

void startJavaStepTimer(boolean aNewStep)

Starts timing for a Java step of an Activity

Parameters:

aNewStep - true if this is a new Java step and the count should be incremented

startOrStopTimer

void startOrStopTimer(java.lang.String timer,
                      boolean on)

Searches for the timer named by string and either starts or stops it depending on the ON value. True starts the timer, false stops it. The timer string must be a substring of the string that identifies the PAL Statistic, non-unique substrings will result in unexpected behavior

Parameters:

timer -

on -

stopJavaStepTimer

void stopJavaStepTimer()

Stops timing for a Java step of an Activity

getInteraction

int getInteraction()

Return the current interaction number.

Returns:

current interaction

incrementFlowCount

void incrementFlowCount()

increment the value of "flow count" - the count of "BPM" invocations (advancing a work object)