IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.recorder.core.session
Interface IRecordingComponent

All Known Subinterfaces:
IClient, IRecorder

public interface IRecordingComponent

An abstract recording component. This interface provides the common behavior and properties for clients and recorders. A component belongs to a session, has a type and a name. One can interact with a recording component by sending messages to it, and getting or setting a property. The nature of messages and properties that are supported by the recording component is specific to the recording component type.


Method Summary
 String getName()
          Returns the component name.
 Object getProperty(String name)
          Gets a runtime property of the component.
 IRecordingSession getSession()
          Returns the recording session that this component belongs to.
 String getType()
          Returns the component type (i.e. the client type for a client, or the recorder type for a recorder).
 void sendMessage(Message message)
          Issues a message to the recording component.
 void setProperty(String name, Object value)
          Sets the value of a runtime property of the component.
 

Method Detail

getType

String getType()
Returns the component type (i.e. the client type for a client, or the recorder type for a recorder).

Returns:
the component type (i.e. the client type for a client, or the recorder type for a recorder).

getName

String getName()
Returns the component name. This name is translated and can be exposed to the user.

Returns:
the component name. This name is translated and can be exposed to the user.

getSession

IRecordingSession getSession()
Returns the recording session that this component belongs to.

Returns:
the recording session that this component belongs to.

sendMessage

void sendMessage(Message message)
Issues a message to the recording component.

Parameters:
message - A message. Destination and filter properties are checked, and the message will be delivered only if the recording component matches these attribute values. However the message will not be delivered to any other component that matches these values. To deliver a message to all components that match the destination/filter, use IRecordingSession.sendMessage(Message).

getProperty

Object getProperty(String name)
                   throws UnsupportedPropertyException
Gets a runtime property of the component. The meaning of the property and its value is specific to the component and part of the interface between the component and external entities. In particular, the time when the value can be read is let to the component specification (for instance, a property may be read only while the component is active).

Parameters:
name - The property name
Returns:
The property value
Throws:
UnsupportedPropertyException - If the component does not support the property (either because it does not define such a property, or because the property is read at an inappropriate time).

setProperty

void setProperty(String name,
                 Object value)
                 throws UnsupportedPropertyException
Sets the value of a runtime property of the component. The meaning of the property and its value is specific to the component and part of the interface between the component and external entities. In particular, the time when the value can be set is defined by the component specification (for instance, a property may be set while the component is active).

Parameters:
name - The property name
Throws:
UnsupportedPropertyException - If the component does not support the property (either because it does not define such a property, or because the property is set at an inappropriate time).

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.