IBM Rational Performance Tester SDK

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

All Superinterfaces:
IRecordingComponent

public interface IRecorder
extends IRecordingComponent

A recorder is a concrete recording component that can be executed in order to capture traffic that will be initiated by a IClient. A recorder can be started, stopped, paused and resumed. Its nature and behavior are parameterized by its recorder configuration. A recorder belongs to a recording session, and has a state. It can be observed by listeners.


Method Summary
 void addListener(IRecorderListener listener)
           
 RecorderConfiguration getRecorderConfiguration()
           
 RecorderState getState()
          Returns the current state of the recorder.
 boolean isPauseSupported()
          Returns whether IRecorder.pause() and IRecorder.resume() operations are supported by this recorder.
 void pause()
           
 void removeListener(IRecorderListener listener)
           
 void resume()
           
 void start()
           
 void stop()
           
 
Methods inherited from interface com.ibm.rational.test.lt.recorder.core.session.IRecordingComponent
getName, getProperty, getSession, getType, sendMessage, setProperty
 

Method Detail

start

void start()

stop

void stop()

pause

void pause()

resume

void resume()

getRecorderConfiguration

RecorderConfiguration getRecorderConfiguration()

addListener

void addListener(IRecorderListener listener)

removeListener

void removeListener(IRecorderListener listener)

getState

RecorderState getState()
Returns the current state of the recorder. Note that when state is tested for a decision based on its value, the call to this method, the test, and the decision should be grouped together in a synchronized block on this component.
For instance:
 synchronized(recorder) {
   if (recorder.getState() == RecorderState.RECORDING) {
     recorder.pause(); // This method may throw an IllegalStateException
                       // if invoked while the recorder is in STOPPING state
   }
 }
 

Returns:
the current state of the recorder

isPauseSupported

boolean isPauseSupported()
Returns whether IRecorder.pause() and IRecorder.resume() operations are supported by this recorder. These are optional operations and any invocation to these methods, if not supported, will have no effect.

Returns:
whether IRecorder.pause() and IRecorder.resume() operations are supported by this recorder.

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.