Package com.webmethods.rtl.util.perf

Interface IPerfService

public interface IPerfService

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_DATA_LAYOUT
static final String	LEGACY_EXTRA_DATA_LAYOUT

Method Summary

Modifier and Type	Method	Description
Long	actionEnd(Object object, Serializable actionData)	End an action, recording the usual information
Object	actionInit(String category, String actionName)	Returns a token when an action is initialized
Object	actionInit(String category, String actionName, String customLayout, IPerfActionCallback callback)	Returns a token when an action is initialized If there is a custom callback, there needs to be a custom layout to render the data as well
void	actionStart(Object object)	Begin an action
IPerfSchema	findSchemaByID(int schemaID)	find a schema by ID
IPerfAnalysis	getAnalysis(IPerfData data, int style)	get analysis object for this service
IPerfData	getData()	retrieves a copy of the current perfdata set
long	getEntryCount()	total # of entries since last start/reset
IPerfSerializer	getSerializer()	get a serializer for this service
void	reset()	resets the perf service's data
void	start()	initialize the service
void	stop()	stop the service

Field Details

DEFAULT_DATA_LAYOUT

static final String DEFAULT_DATA_LAYOUT

See Also:

• Constant Field Values

LEGACY_EXTRA_DATA_LAYOUT

static final String LEGACY_EXTRA_DATA_LAYOUT

See Also:

• Constant Field Values

Method Details

start

void start()
    throws PortalException

initialize the service

Throws:

PortalException

stop

void stop()

stop the service

reset

void reset()
    throws PortalException

resets the perf service's data

Throws:

PortalException

getData

IPerfData getData()

retrieves a copy of the current perfdata set

getAnalysis

IPerfAnalysis getAnalysis(IPerfData data,
 int style)

get analysis object for this service

Returns:

getSerializer

IPerfSerializer getSerializer()

get a serializer for this service

Returns:

actionInit

Object actionInit(String category,
 String actionName)

Returns a token when an action is initialized

actionInit

Object actionInit(String category,
 String actionName,
 String customLayout,
 IPerfActionCallback callback)

Returns a token when an action is initialized If there is a custom callback, there needs to be a custom layout to render the data as well

actionStart

void actionStart(Object object)

Begin an action

actionEnd

Long actionEnd(Object object,
 Serializable actionData)

End an action, recording the usual information

Returns:

the execution time for the action

getEntryCount

long getEntryCount()

total # of entries since last start/reset

Returns:

findSchemaByID

IPerfSchema findSchemaByID(int schemaID)

find a schema by ID