com.ibm.rational.test.lt.recorder.core.extensibility

Interface IRecorderMonitorContext

public interface IRecorderMonitorContext

Context for a IRecorderMonitor. The context provides access to the recording framework features. Among others, it allows a monitor to amend the current session by adding a new set of recorders and clients.

Method Summary

Methods

Modifier and Type	Method and Description
void	amendSession(String description, RecordingSessionConfiguration configuration) Merges a new recording session configuration into to the current session.
long	currentTime() Returns a value that corresponds to the current time.
void	dispatchMessage(Message message) Dispatches a message to other recording components.
IRecorderLog	getLog()
short[]	getRecorderIds(String recorderType) Returns the IDs of the recorders with the specified type from the recording session that the monitored recorder belongs to.
Object	getRecorderProperty(short recorderId, String name) Returns a runtime property of the recorder with the specified ID.
ITimeReference	getTimeReference() Returns the time reference that allows to convert back and forth time expressed in the recording session clock and times expressed in milliseconds.

Method Detail

getLog

IRecorderLog getLog()

amendSession

void amendSession(String description,
                RecordingSessionConfiguration configuration)

Merges a new recording session configuration into to the current session.

Parameters:

A - (user-facing) description of the amendment.

configuration - A recording session configuration that specifies the details of the recorders and clients to be instantiated and launched in the current session.

dispatchMessage

void dispatchMessage(Message message)

Dispatches a message to other recording components. The message is distributed to the destination(s) specified in message.

Parameters:

message - A message.

getRecorderIds

short[] getRecorderIds(String recorderType)

Returns the IDs of the recorders with the specified type from the recording session that the monitored recorder belongs to.

Returns:

getRecorderProperty

Object getRecorderProperty(short recorderId,
                         String name)
                           throws UnsupportedPropertyException

Returns a runtime property of the recorder with the specified ID.

Parameters:

recorderId - The Id of the recorder. This id can be obtained using IRecorderMonitorContext.getRecorderIds(String).

name - The name of the runtime property.

Returns:

The runtime value of the property.

Throws:

UnsupportedPropertyException - If the property is not defined by the recorder, or of if it is not available in the current state of the recorder.

currentTime

long currentTime()

Returns a value that corresponds to the current time. All recorders and clients share the same clock, and the values obtained using this method can be compared to establish an ordering between events.

Returns:

the current time.

getTimeReference

ITimeReference getTimeReference()

Returns the time reference that allows to convert back and forth time expressed in the recording session clock and times expressed in milliseconds.

Returns:

the time reference.