IBM Rational Performance Tester SDK

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

All Known Implementing Classes:
BaseClientDecorator

public interface IClientDecorator

A client decorator is a mechanism that allows a recorder to "decorate" a client, i.e. to wrap the lifecycle of a client with additional routines, generally aimed at setting up the client so its traffic can be recorded by the recorder.


Method Summary
 IStatus decorate()
          Decorates the client, i.e. prepares the client before it is launched so the recorder can record the client's traffic.
 void init(IClientDecoratorContext context)
          Initializes the decorator.
 IStatus undecorate()
          Undecorates the client after the client has terminated, i.e. undo what IClientDecorator.decorate() has performed.
 

Method Detail

init

void init(IClientDecoratorContext context)
Initializes the decorator. There is exactly one decorator per RecorderClientBindingConfiguration as defined in the recording configuration, provided that a clientDecorator extension is defined in the registry for the couple {RecorderType,ClientType}.

Parameters:
context - The client decorator context. A typical implementation of this method should store the context instance so be used in the decoration and undecoration process.

decorate

IStatus decorate()
Decorates the client, i.e. prepares the client before it is launched so the recorder can record the client's traffic. This method is invoked while the recorder is already active. The decorator has an access to the recorder and client configurations and runtime properties. It can also modify the client runtime properties. All of this can be done using the context that it was provided with in the IClientDecorator.init(IClientDecoratorContext) method.


undecorate

IStatus undecorate()
Undecorates the client after the client has terminated, i.e. undo what IClientDecorator.decorate() has performed. This method is invoked while the recorder is still active. The decorator has an access to the recorder and client configurations and runtime properties. All of this can be done using the context that it was provided with in the IClientDecorator.init(IClientDecoratorContext) method.


IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.