public class RecorderCore extends Object
| Modifier and Type | Field and Description |
|---|---|
static String |
AND_GROUP_TESTER_ID
The id of the And Group Tester.
|
static String |
ANNOTATION_RECORDER_TYPE
The type id for the annotation recorder.
|
static String |
ANNOTATION_SERVER_ENABLED
Boolean option to enable the optional annotation server feature of the annotation
recorder.
|
static String |
ANNOTATION_SERVER_PORT
Integer property of the annotation recorder representing the port value where
annotations must be sent.
|
static String |
ANNOTATION_STATE_HANDLER_PREFIX
Prefix for the property of the annotation recorder that represents the state
handler for a specific annotation type.
|
static String |
APPLICATION_CLIENT_TYPE
The type id for the application client.
|
static String |
CONNECTION_PACKET_TESTER_ID
The id of the Connection Packet Tester.
|
static String |
CONNECTION_PACKET_TESTER_REMOTE_PROPERTY
This list property defines the list of
ipv4:port, or [ipv6]:port where ip
may be either a valid IP address, or the * character to match any address. |
static String |
CONNECTION_PACKET_TYPE
The type id for connection packets.
|
static RecorderCore |
INSTANCE
The unique instance of this singleton class.
|
static String |
NOT_GROUP_TESTER_ID
The id of the Not Group Tester.
|
static String |
OR_GROUP_TESTER_ID
The id of the Or Group Tester.
|
static String |
PACKET_TYPE_TESTER_ID
The id of the Packet Type Tester.
|
static String |
PACKET_TYPES_PROPERTY
The name of the property that defines the packet types that should be filtered.
|
static String |
RECCONFIG_EXTENSION
File extension (without dot) for recording configurations.
|
static String |
RECCONFIG_RESOURCE_TYPE
The type of recording configurations as test resources.
|
static String |
RECDATA_EXTENSION
File extension (without dot) for slave data recorded sessions.
|
static String |
RECORDER_ANNOTATION_PACKET_TYPE
The type id for recorder annotation packets.
|
static String |
RECSESSION_EXTENSION
File extension (without dot) for recorded sessions.
|
static String |
RECSESSION_RESOURCE_TYPE
The type of recording sessions as test resources.
|
static String |
UNSUPPORTED_PACKET_TYPE
Type of place holder packets that are returned when reading a recording session content
that contains packets type defined in a missing extension.
|
static String |
UNSUPPORTED_VERSION_PACKET_TYPE
Type of place holder packets that are returned when reading a recording session content
that contains packets whose version is unsupported (i.e. a newer version than the one supported
by the installed extension).
|
| Modifier and Type | Method and Description |
|---|---|
void |
addListener(IRecorderCoreListener listener)
Registers a listener for recording framework events.
|
IRecordingSession |
createRecordingSession(RecordingSessionConfiguration config)
Creates a new recording session, using the provided session configuration.
|
IRecordingSessionProducer |
createRecordingSessionProducer(IFile file,
long initialTimestamp,
long clockFrequency)
Instantiates a new recording session producer.
|
IRecordingSessionProducer |
createRecordingSessionProducer(IFile file,
long initialTimestamp,
long clockFrequency,
com.ibm.rational.test.lt.recorder.core.encrypt.IEncryptionParameter encryption)
Instantiates a new recording session producer.
|
static String |
formatToString(byte[] value,
int len) |
static String |
formatToString(byte[] value,
int len,
boolean newLineMarkers,
boolean uppercaseHexaDigits) |
List<IRecordingSession> |
getActiveSessions()
Returns the active recording sessions (i.e. sessions that have been started and not yet
terminated).
|
IStatus |
getClientTypeStatus(String clientId) |
com.ibm.rational.test.lt.recorder.core.internal.extensibility.RecorderExtensionRegistry |
getExtensionRegistry()
For internal use of the recording framework only.
|
IPacketExtensionRegistry |
getPacketExtensionRegistry()
Returns the packet extension registry, which enables to inspect properties of declared
packet types.
|
static String |
getRecorderCoreLibrary32Path()
Returns the absolute path to RecorderCore.dll (32 bits) for inclusion by external native
client/recorder implementations which need to produce recorder timestamps.
|
static String |
getRecorderCoreLibrary64Path()
Returns the absolute path to RecorderCore64.dll (64 bits) for inclusion by external native
client/recorder implementations which need to produce recorder timestamps.
|
IStatus |
getRecorderTypeStatus(String recorderId) |
boolean |
isActiveSession(IFile persistedSessionFile)
Returns whether the specified recording session file contains an active session.
|
boolean |
isRecmodel(InputStream is) |
IRecordingSession |
loadRecordingSession(IFile persistedSessionFile)
Loads a persisted session or returns the active session that is currently persisting
its activity to the specified file.
|
void |
removeListener(IRecorderCoreListener listener)
Unregisters a listener for recording framework events.
|
public static final String CONNECTION_PACKET_TYPE
public static final String APPLICATION_CLIENT_TYPE
public static final String ANNOTATION_SERVER_PORT
public static final String ANNOTATION_STATE_HANDLER_PREFIX
UnsupportedPropertyException will be thrown. This runtime
property is supported only while the annotation recorder is
active. The type of this property
is an instance of IAnnotationStateHandler. Some state handlers may provide a
more specific interface. In this case, the returned value of DelegaterComponent.getProperty(String)
must be cast to this interface.public static final String RECORDER_ANNOTATION_PACKET_TYPE
public static final String ANNOTATION_RECORDER_TYPE
public static final String ANNOTATION_SERVER_ENABLED
RecorderCore.ANNOTATION_SERVER_PORT.public static final String UNSUPPORTED_PACKET_TYPE
public static final String UNSUPPORTED_VERSION_PACKET_TYPE
public static final String RECSESSION_EXTENSION
public static final String RECDATA_EXTENSION
public static final String RECCONFIG_EXTENSION
public static final String CONNECTION_PACKET_TESTER_ID
connection packet and if its source or destination properties
match some criteria, such as a host name, an ip range, or a port.public static final String CONNECTION_PACKET_TESTER_REMOTE_PROPERTY
ipv4:port, or [ipv6]:port where ip
may be either a valid IP address, or the * character to match any address.public static final String AND_GROUP_TESTER_ID
true if and only if all testers evaluate true.LogicalTesterGroupConfiguration.public static final String OR_GROUP_TESTER_ID
false if and only if all testers evaluate false.LogicalTesterGroupConfiguration.public static final String NOT_GROUP_TESTER_ID
LogicalTesterGroupConfiguration.
The count of child configurations of this configuration must be exactly one.public static final String PACKET_TYPE_TESTER_ID
public static final String PACKET_TYPES_PROPERTY
public static final String RECSESSION_RESOURCE_TYPE
public static final String RECCONFIG_RESOURCE_TYPE
public static RecorderCore INSTANCE
public IRecordingSession createRecordingSession(RecordingSessionConfiguration config) throws CoreException
config - A session configuration, completed with all options and containing
all the required recorder and client configurations.CoreExceptionpublic IRecordingSession loadRecordingSession(IFile persistedSessionFile) throws CoreException
persistedSessionFile - A recording session (.recsession) file.CoreException - If the session could be retrieved from the file.public boolean isActiveSession(IFile persistedSessionFile)
persistedSessionFile - A recording session file.public List<IRecordingSession> getActiveSessions()
public IRecordingSessionProducer createRecordingSessionProducer(IFile file, long initialTimestamp, long clockFrequency) throws CoreException
file - The file to produce. Must have a .recsession extension. Any file with same name,
or with same name but .recdata extension will be overwritten.initialTimestamp - The initial timestamp of the recording session. This timestamp must be expressed
in the same unit as the recorder packet timestamps.clockFrequency - The clock frequency, i.e. the number of unique timestamps
within one second.CoreExceptionpublic IRecordingSessionProducer createRecordingSessionProducer(IFile file, long initialTimestamp, long clockFrequency, com.ibm.rational.test.lt.recorder.core.encrypt.IEncryptionParameter encryption) throws CoreException
file - The file to produce. Must have a .recsession extension. Any file with same name,
or with same name but .recdata extension will be overwritten.initialTimestamp - The initial timestamp of the recording session. This timestamp must be expressed
in the same unit as the recorder packet timestamps.clockFrequency - The clock frequency, i.e. the number of unique timestamps
within one second.encryption - Specifies the details of the encryption used to persist the recording session.CoreExceptionpublic void addListener(IRecorderCoreListener listener)
listener - public void removeListener(IRecorderCoreListener listener)
listener - public boolean isRecmodel(InputStream is) throws IOException
IOExceptionpublic com.ibm.rational.test.lt.recorder.core.internal.extensibility.RecorderExtensionRegistry getExtensionRegistry()
public IPacketExtensionRegistry getPacketExtensionRegistry()
public static String getRecorderCoreLibrary32Path()
public static String getRecorderCoreLibrary64Path()
public static String formatToString(byte[] value, int len)
public static String formatToString(byte[] value, int len, boolean newLineMarkers, boolean uppercaseHexaDigits)
© Copyright IBM Corp. 2013. All rights reserved.