|
IBM Rational Performance Tester SDK | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.rational.test.lt.recorder.core.property.AbstractConfiguration
com.ibm.rational.test.lt.recorder.core.config.RecordingSessionConfiguration
public class RecordingSessionConfiguration
A recording session configuration object, used for holding options related to a
recording session.
A configuration is usually produced by a UI component such as a wizard
and consumed by a recording session. It contains generic or protocol-specific options
that influence the behavior of the recording session, based on the choices made by the
user in the UI component.
A recording session configuration has child configurations, one per recorder that should be run
during the recording session.
A configuration contains options, which consist of a name and a value. Basic types
are supported for the values: boolean, integer, string, strings list, enum, and maps.
A configuration can be persisted as an XML document, and it can be reconstructed from
the XML using RecordingConfigurationFactory
.
Field Summary | |
---|---|
static String |
AUTO_STOP
A boolean specifying whether the session should automatically stop when all clients are terminated. |
static String |
CONFIGURATION_FILE_NAME
A string specifying the name of the file that the configuration was loaded from, if applicable. |
static String |
ENCRYPTION_PASSPHRASE
A string specifying the pass phrase used to encrypt the recording session content. |
static String |
LOG_DEBUG_MESSAGES
A boolean specifying that debug messages issued by recording components should be logged to eclipse error log as information messages. |
static String |
OBFUSCATE
A boolean specifying that the recording session file should be obfuscated, to prevent plain strings from being visible by a simple inspection of the file. |
static String |
REC_SESSION_PATH
A string specifying the generated recmodel path, relative to the workspace. |
static String |
UPGRADED
A boolean specifying that the session configuration is the result of an upgrade process from a recmodel to a recsession (i.e. from 8.1.x or previous to 8.2). |
Fields inherited from class com.ibm.rational.test.lt.recorder.core.property.AbstractConfiguration |
---|
properties |
Constructor Summary | |
---|---|
RecordingSessionConfiguration()
|
Method Summary | |
---|---|
protected void |
addChildConfiguration(AbstractConfiguration config,
String operandName)
|
protected void |
afterXmlDeserialization()
|
protected void |
beforeXmlSerialization()
|
RecordingSessionConfiguration |
clone()
|
ClientConfiguration |
getClientConfiguration(String type)
Returns the client configuration defined in the session that has the specified type. |
List<ClientConfiguration> |
getClientConfigurations()
|
List<ClientConfiguration> |
getClientConfigurations(String type)
Returns the client configurations defined in the session configuration with the specified type. |
protected String |
getElementName()
|
protected String |
getNamespace()
|
protected String |
getPreferedPrefix()
|
protected String |
getProtocol()
|
RecorderClientBindingConfiguration |
getRecorderClientBinding(RecorderConfiguration recorderConfiguration,
ClientConfiguration clientConfiguration)
Returns the recorder-client binding between a specific recorder configuration and a specific client configuration. |
List<RecorderClientBindingConfiguration> |
getRecorderClientBindings()
|
List<RecorderClientBindingConfiguration> |
getRecorderClientBindings(ClientConfiguration clientConfiguration)
Returns the recorders bindings that are associated to the specified client configuration. |
List<RecorderClientBindingConfiguration> |
getRecorderClientBindings(RecorderConfiguration recorderConfiguration)
Returns the client bindings that are associated to the specified recorder configuration. |
RecorderConfiguration |
getRecorderConfiguration(String type)
Returns the recorder configuration defined in the session that has the specified type. |
List<RecorderConfiguration> |
getRecorderConfigurations()
|
List<RecorderConfiguration> |
getRecorderConfigurations(String type)
Returns the recorder configurations defined in the session configuration with the specified type. |
protected void |
writeChildConfigurations(javax.xml.stream.XMLStreamWriter writer)
|
Methods inherited from class com.ibm.rational.test.lt.recorder.core.property.AbstractConfiguration |
---|
assignUniqueIds, cloneProperties, get, getBoolean, getData, getEnum, getInteger, getList, getMap, getObfuscatedList, getObfuscatedString, getPreferedIdPrefixForChild, getString, getString, isOperand, loadAttributes, remove, saveDataToAttachment, serialize, setBoolean, setData, setData, setEnum, setInteger, setList, setMap, setObfuscatedList, setObfuscatedString, setString, toString, write, write, write, writeAttributes, writeChildConfiguration, writeChildConfigurations |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String REC_SESSION_PATH
public static final String CONFIGURATION_FILE_NAME
public static final String AUTO_STOP
true
.
public static final String UPGRADED
false
.
public static final String LOG_DEBUG_MESSAGES
false
.
public static final String ENCRYPTION_PASSPHRASE
RecordingSessionConfiguration.OBFUSCATE
.
public static final String OBFUSCATE
RecordingSessionConfiguration.ENCRYPTION_PASSPHRASE
.
Constructor Detail |
---|
public RecordingSessionConfiguration()
Method Detail |
---|
public List<RecorderConfiguration> getRecorderConfigurations()
public List<ClientConfiguration> getClientConfigurations()
public List<RecorderClientBindingConfiguration> getRecorderClientBindings()
public List<RecorderConfiguration> getRecorderConfigurations(String type)
type
- A recorder type.
public RecorderConfiguration getRecorderConfiguration(String type)
type
- A recorder type.
null
if
none were found.public List<RecorderClientBindingConfiguration> getRecorderClientBindings(ClientConfiguration clientConfiguration)
clientConfiguration
- A client configuration that belongs to this session.
public RecorderClientBindingConfiguration getRecorderClientBinding(RecorderConfiguration recorderConfiguration, ClientConfiguration clientConfiguration)
recorderConfiguration
- A recorder configuration that belongs to this session.clientConfiguration
- A client configuration that belongs to this session.
null
if it does not
exist.public List<ClientConfiguration> getClientConfigurations(String type)
type
- A client type.
public ClientConfiguration getClientConfiguration(String type)
type
- A client type.
null
if
none were found.public List<RecorderClientBindingConfiguration> getRecorderClientBindings(RecorderConfiguration recorderConfiguration)
recorderConfiguration
- A recorder configuration that belongs to this session.
protected String getElementName()
getElementName
in class AbstractConfiguration
protected String getNamespace()
getNamespace
in class AbstractConfiguration
protected String getProtocol()
getProtocol
in class AbstractConfiguration
protected String getPreferedPrefix()
getPreferedPrefix
in class AbstractConfiguration
protected void beforeXmlSerialization()
beforeXmlSerialization
in class AbstractConfiguration
protected void writeChildConfigurations(javax.xml.stream.XMLStreamWriter writer) throws javax.xml.stream.XMLStreamException
writeChildConfigurations
in class AbstractConfiguration
javax.xml.stream.XMLStreamException
protected void addChildConfiguration(AbstractConfiguration config, String operandName) throws InvalidConfigurationException
addChildConfiguration
in class AbstractConfiguration
InvalidConfigurationException
protected void afterXmlDeserialization()
afterXmlDeserialization
in class AbstractConfiguration
public RecordingSessionConfiguration clone()
clone
in class AbstractConfiguration
|
IBM Rational Performance Tester SDK | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |