IBM Rational Performance Tester SDK

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


public interface IClientDecoratorContext

A client decorator context provides a IClientDecorator with the necessary getters and setters so the client decorator can operate.

See Also:
IClientDecorator.init(IClientDecoratorContext)

Method Summary
 ClientConfiguration getClientConfiguration()
          Returns the configuration of the client that the client decorator is decorating.
 Object getClientProperty(String name)
          Returns a named runtime property of the client that client decorator is decorating.
 IRecorderLog getLog()
          Returns an instance of a logger that can be used by the decorator to log messages, including errors and exceptions.
 RecorderConfiguration getRecorderConfiguration()
          Returns the configuration of the recorder that the client decorator works for.
 Object getRecorderProperty(String name)
          Returns a named runtime property of the recorder that the client decorator works for.
 void setClientProperty(String name, Object value)
          Sets the value of a named runtime property of the client that client decorator is decorating.
 

Method Detail

getRecorderProperty

Object getRecorderProperty(String name)
                           throws UnsupportedPropertyException
Returns a named runtime property of the recorder that the client decorator works for.

Parameters:
name - A property name
Returns:
The property value
Throws:
UnsupportedPropertyException - If the recorder does not support the specified property. Note that a recorder may support a property only in a specific time-frame (for instance, only when the recorder is running).

getClientProperty

Object getClientProperty(String name)
                         throws UnsupportedPropertyException
Returns a named runtime property of the client that client decorator is decorating.

Parameters:
name - A property name
Returns:
The property value
Throws:
UnsupportedPropertyException - If the client does not support the specified property. Note that a client may support a property only in a specific time-frame (for instance, only when the client has not started yet).

setClientProperty

void setClientProperty(String name,
                       Object value)
                       throws UnsupportedPropertyException
Sets the value of a named runtime property of the client that client decorator is decorating.

Parameters:
name - A property name
value - The property value
Throws:
UnsupportedPropertyException - If the client does not support setting the specified property. Note that a client may support setting a property only in a specific time-frame (for instance, only when the client has not started yet).

getClientConfiguration

ClientConfiguration getClientConfiguration()
Returns the configuration of the client that the client decorator is decorating.


getRecorderConfiguration

RecorderConfiguration getRecorderConfiguration()
Returns the configuration of the recorder that the client decorator works for.


getLog

IRecorderLog getLog()
Returns an instance of a logger that can be used by the decorator to log messages, including errors and exceptions.

Returns:
an instance of a logger that can be used by the delegate to log messages, including errors and exceptions.

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.