IBM Rational Performance Tester SDK

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

All Superinterfaces:
IRecordingComponentDelegate
All Known Implementing Classes:
BaseRecorderDelegate

public interface IRecorderDelegate
extends IRecordingComponentDelegate

A delegate responsible of managing the lifecyle of a specific type of recorder. A recorder delegate is responsible of honoring recorder commands and sending recorder events to the framework. This interface is meant to be implemented by extensions which provide their own recorder implementation.


Method Summary
 void initialize(IRecorderContext context)
          Initializes this instance so it ready to process commands and send events.
 void pause()
          Asks the recorder delegate to pause the recorder.
 void resume()
          Asks the recorder delegate to resume the recorder.
 void start(boolean recordingEnabled)
          Asks the recorder delegate to start the recorder.
 void stop()
          Asks the recorder delegate to stop the recorder.
 
Methods inherited from interface com.ibm.rational.test.lt.recorder.core.extensibility.IRecordingComponentDelegate
getProperty, messageReceived, setProperty
 

Method Detail

initialize

void initialize(IRecorderContext context)
                throws DelegateInitializeException
Initializes this instance so it ready to process commands and send events. The initialization should be fast (i.e. no long-running initializations or large resource allocations) and the method should not return until the initialization is complete. Long-running or large resource allocations should be performed when the START command is received.

Parameters:
context - The recorder context, that provides the recorder configuration that this instance should conform to, and a mechanism for the delegate to send events to other involved components.
Throws:
DelegateInitializeException - If the delegate cannot be initialized or will not be able to run properly.

start

void start(boolean recordingEnabled)
Asks the recorder delegate to start the recorder. No other command can occur before this command. This command can be issued only once. This method should return without waiting for the start process to be completed. The delegate is required to notify its context when the start is complete by invoking IRecorderContext.recorderResumed() or IRecorderContext.recorderPaused().

Parameters:
recordingEnabled - Whether the recorder should start with recording enabled or disabled (i.e. in "running" or "paused" mode).

stop

void stop()
Asks the recorder delegate to stop the recorder. This command can occur only once, and only after IRecorderDelegate.start(boolean) has been invoked. This method should return without waiting for the stop process to be completed. The delegate is required to notify its context when the stop is complete by invoking IRecorderContext#recorderStopped().


pause

void pause()
Asks the recorder delegate to pause the recorder. This command may occur several times, but only after IRecorderDelegate.start(boolean) has been invoked. This method should return without waiting for the pause process to be completed. The delegate is required to notify its context when the pause is complete by invoking IRecorderContext.recorderPaused().


resume

void resume()
Asks the recorder delegate to resume the recorder. This command may occur several times, but only after IRecorderDelegate.start(boolean) has been invoked. This method should return without waiting for the resume process to be completed. The delegate is required to notify its context when the resume is complete by invoking IRecorderContext.recorderResumed().


IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.