IBM Rational Performance Tester SDK

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

All Known Subinterfaces:
IClientDelegate, IRecorderDelegate
All Known Implementing Classes:
AbstractExecutableClientDelegate, BaseClientDelegate, BaseRecorderDelegate, ProcessBuilderClientDelegate

public interface IRecordingComponentDelegate

A delegate is the component implemented by extending plugins that performs the actual operations for initializing and managing the lifecycle of a recording component (a recording component being either a recorder or a client). It works together with a IRecordingComponentContext. The context issues commands to the delegate, and the delegate issues events to the context.


Method Summary
 Object getProperty(String name)
          Gets a runtime property of the delegate.
 void messageReceived(Message message)
          This method is invoked by the context when a message is sent to this delegate.
 void setProperty(String name, Object value)
          Sets the value of a runtime property of the delegate.
 

Method Detail

messageReceived

void messageReceived(Message message)
This method is invoked by the context when a message is sent to this delegate. If the delegate doesn't know how to understand or handle the message, it should silently ignore it.

Parameters:
message - A message.

getProperty

Object getProperty(String name)
                   throws UnsupportedPropertyException
Gets a runtime property of the delegate. The meaning of the property and its value is specific to the delegate and part of the interface between the delegate and other recording components. In particular, the time when the value can be read is let to the delegate implementation (for instance, a property may be read only after the component has started).

Parameters:
name - The property name
Returns:
The property value
Throws:
UnsupportedPropertyException - If the delegate 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 delegate. The meaning of the property and its value is specific to the delegate and part of the interface between the delegate and other recording components. In particular, the time when the value can be set is defined by the delegate implementation (for instance, a property may be set only before the component is started).

Parameters:
name - The property name
Throws:
UnsupportedPropertyException - If the delegate 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.