IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.recorder.core.annotations
Class RecorderAnnotation

java.lang.Object
  extended by com.ibm.rational.test.lt.recorder.core.property.AbstractConfiguration
      extended by com.ibm.rational.test.lt.recorder.core.property.AbstractTypedConfiguration
          extended by com.ibm.rational.test.lt.recorder.core.annotations.RecorderAnnotation
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
RecordingSessionAmendmentAnnotation

public class RecorderAnnotation
extends AbstractTypedConfiguration

A recording annotation is an indication, within a recording, that can be taken into account by test generators. Recording annotations are recorded by a specific recorder, the Annotation Recorder, and are persisted in the recording as recorder packets, with a timing information.
Any recorder component (recorder, client) or any external component to the recording framework can emit an annotation. The annotation must be sent to the annotation recorder using the recorder framework messaging system.

See Also:
AnnotationMessage, IRecordingComponentContext.dispatchMessage(Message), IRecordingComponent.sendMessage(Message), Serialized Form

Field Summary
static String COMMENT_PROPERTY
          Name of the property holding the comment entered by the user.
static String END_TRANSACTION_TYPE
          Recording annotation type indicating that the user ended the innermost transaction.
static String IGNORE_TYPE
          Recording annotation type indicating that the user has instructed to ignore the recorded date since the last split point, or ignore, or since the beginning of the test.
static String INSERT_COMMENT_TYPE
          Recording annotation type indicating that the user inserted a comment.
static String NAME_PROPERTY
          Name of the property holding the name entered by the user.
static String RECORDER_ID_ATTRIBUTE
          Name of the integer property holding the unique id of the recorder whose recording state was changed.
static String RECORDING_STATE_TYPE
          Recording annotation type emitted when a recorder state toggles between the "recording" and the "paused" states.
static String RESUMED_ATTRIBUTE
          Name of the boolean property holding whether the state of the recorder was resumed (true) or paused (false).
static String SCREENSHOT_DATA_ATTRIBUTE
          Name of the string property holding either 1/ the file name that contains the screenshot or 2/ the byte array of the image.
static String SCREENSHOT_TYPE
          Screen snapshot type describing a screen snapshot that was taken during recording.
static String SESSION_AMENDMENT_TYPE
          Recording annotation type describing an amendment to a recording session configuration while the session is running.
static String SPLIT_TEST_TYPE
          Recording annotation type indicating that the user has instructed to split the test at this point.
static String START_TRANSACTION_TYPE
          Recording annotation type indicating that the user has instructed to start a new transaction at this point.
static String SYNCHRONIZATION_POINT_TYPE
          Recording annotation type describing a synchronization point declared during recording.
static String TIMESTAMP_PROPERTY
          Name of the string property holding the timestamp, expressed in the recording session time unit as a long integer, of the exact time the snapshot was taken.
 
Fields inherited from class com.ibm.rational.test.lt.recorder.core.property.AbstractTypedConfiguration
NAME, type
 
Fields inherited from class com.ibm.rational.test.lt.recorder.core.property.AbstractConfiguration
properties
 
Constructor Summary
RecorderAnnotation(String type)
           
 
Method Summary
 RecorderAnnotation clone()
           
protected  String getPreferedPrefix()
           
protected  String getProtocol()
           
 
Methods inherited from class com.ibm.rational.test.lt.recorder.core.property.AbstractTypedConfiguration
getElementName, getId, getNamespace, getType, setId, setType
 
Methods inherited from class com.ibm.rational.test.lt.recorder.core.property.AbstractConfiguration
addChildConfiguration, afterXmlDeserialization, assignUniqueIds, beforeXmlSerialization, 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, writeChildConfigurations
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

INSERT_COMMENT_TYPE

public static final String INSERT_COMMENT_TYPE
Recording annotation type indicating that the user inserted a comment. Supported properties:

See Also:
Constant Field Values

COMMENT_PROPERTY

public static final String COMMENT_PROPERTY
Name of the property holding the comment entered by the user. Applicable and mandatory for annotations of type RecorderAnnotation.INSERT_COMMENT_TYPE and RecorderAnnotation.SCREENSHOT_TYPE.

See Also:
Constant Field Values

START_TRANSACTION_TYPE

public static final String START_TRANSACTION_TYPE
Recording annotation type indicating that the user has instructed to start a new transaction at this point. Supported properties: This annotation type is managed by ITransactionAnnotationStateHandler (see RecorderCore.ANNOTATION_STATE_HANDLER_PREFIX).

See Also:
Constant Field Values

NAME_PROPERTY

public static final String NAME_PROPERTY
Name of the property holding the name entered by the user. Applicable and mandatory for annotations of types:

See Also:
Constant Field Values

END_TRANSACTION_TYPE

public static final String END_TRANSACTION_TYPE
Recording annotation type indicating that the user ended the innermost transaction. No applicable properties for this type. This annotation type is managed by ITransactionAnnotationStateHandler (see RecorderCore.ANNOTATION_STATE_HANDLER_PREFIX).

See Also:
Constant Field Values

SPLIT_TEST_TYPE

public static final String SPLIT_TEST_TYPE
Recording annotation type indicating that the user has instructed to split the test at this point. Supported properties:

See Also:
Constant Field Values

IGNORE_TYPE

public static final String IGNORE_TYPE
Recording annotation type indicating that the user has instructed to ignore the recorded date since the last split point, or ignore, or since the beginning of the test. No applicable properties for this type.

See Also:
Constant Field Values

RECORDING_STATE_TYPE

public static final String RECORDING_STATE_TYPE
Recording annotation type emitted when a recorder state toggles between the "recording" and the "paused" states. Supported properties:

See Also:
Constant Field Values

RESUMED_ATTRIBUTE

public static final String RESUMED_ATTRIBUTE
Name of the boolean property holding whether the state of the recorder was resumed (true) or paused (false). Applicable and mandatory for annotations of type "com.ibm.rational.test.lt.recorder.core.recordingState".

See Also:
Constant Field Values

RECORDER_ID_ATTRIBUTE

public static final String RECORDER_ID_ATTRIBUTE
Name of the integer property holding the unique id of the recorder whose recording state was changed. Applicable and mandatory for annotations of type "com.ibm.rational.test.lt.recorder.core.recordingState".

See Also:
Constant Field Values

SESSION_AMENDMENT_TYPE

public static final String SESSION_AMENDMENT_TYPE
Recording annotation type describing an amendment to a recording session configuration while the session is running. These annotations are emitted by the framework whenever a recorder monitor amends the session. Recorder annotations with this type must be instances of the sub-class RecordingSessionAmendmentAnnotation. Supported properties:

See Also:
Constant Field Values

SCREENSHOT_TYPE

public static final String SCREENSHOT_TYPE
Screen snapshot type describing a screen snapshot that was taken during recording. Supported properties:

See Also:
Constant Field Values

SYNCHRONIZATION_POINT_TYPE

public static final String SYNCHRONIZATION_POINT_TYPE
Recording annotation type describing a synchronization point declared during recording. Supported properties:

See Also:
Constant Field Values

SCREENSHOT_DATA_ATTRIBUTE

public static final String SCREENSHOT_DATA_ATTRIBUTE
Name of the string property holding either 1/ the file name that contains the screenshot or 2/ the byte array of the image. The file path must be absolute and compliant with system rules. Annotations with case 2/ are not persistable and are for direct communication during the recording session. Applicable and option for annotations of type "com.ibm.rational.test.lt.recorder.core.screenshot".

See Also:
Constant Field Values

TIMESTAMP_PROPERTY

public static final String TIMESTAMP_PROPERTY
Name of the string property holding the timestamp, expressed in the recording session time unit as a long integer, of the exact time the snapshot was taken. Applicable and option for annotations of type "com.ibm.rational.test.lt.recorder.core.screenshot".

See Also:
Constant Field Values
Constructor Detail

RecorderAnnotation

public RecorderAnnotation(String type)
Method Detail

clone

public RecorderAnnotation clone()
Specified by:
clone in class AbstractTypedConfiguration

getProtocol

protected String getProtocol()
Specified by:
getProtocol in class AbstractConfiguration

getPreferedPrefix

protected String getPreferedPrefix()
Specified by:
getPreferedPrefix in class AbstractConfiguration

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.