Replayer API

Use the Replayer API to facilitate upgrade from an 8.7, 9.0, 9.2, or 9.5 engine to a 11.4 engine.

If you are performing maintenance that does not require manipulating recorded interactions before replaying them, use the madconfig utility replayer target.

The Replayer API allows you to account for changes in the format of interactions between product releases as well as format changes you might have made to suit your implementation.

Use the Replayer API to create Java™ applications to decode, map, and execute the interactions of the interaction data file. Specifically, your application:

  1. Decodes (in other words, reads) the interaction from the interaction data file.
  2. Maps the interaction from the format used by the source operational server to the format used by the destination engine.
  3. Executes the interaction by sending the newly formatted interaction to the destination engine.

Of the three steps, the operational server provides code to perform decode and execute steps, as well as sample code for the mapping step. Use that code to create custom mappings to accommodate the interactions of your own configuration.

The operational server does provide several sample applications that cover most upgrade cases.

The Replayer API is made available through Interceptor.zip file, which is installed by default in this directory:
  • Microsoft Windows: [engine]\lib\sdk\
  • IBM® AIX®, Linux, or Solaris: [engine]/lib/sdk/

The compressed file includes:

  1. A lib directory containing JAR files. When you add the JAR files to your classpath, you must specify each JAR file by name. Classes are created if you include .../lib/* in the classpath.
  2. An example directory of sample Java programs for replaying 8.7, 9.0, 9.2, and 11.4 interactions along with sample mappings for 8.7 and 9.0. The examples differ only in how the mapping is performed.
  3. A doc directory contains Javadocs for the Replayer API.
  4. The replayer.bat and replayer.sh executable programs can be used to demonstrate the execution of the sample applications.
  5. A readme file with basic information about the Recorder API.
The Replayer API consists of a single Replayer class (com.initiatesystems.hub.interceptor.replayer) with various methods for:
  • decoding the interaction data file and replaying interactions, and
  • getting and setting the host and port of the engine, the name of the interaction data file, and the starting line for replaying the interactions.

For detail about the individual methods, see the Javadocs available within the doc directory of the Interceptor.zip file.

The decodeIxns method returns an iterator. To take advantage of the iterator, ensure that your application:
  1. Sets up a loop that makes a call to hasNext() of the returned iterator. Set up the loop to iterate as long as hasNext() returns true.
  2. Within the loop, obtain each interaction by calling next() on the returned iterator.
Related tasks:
Starting the Interceptor Replayer with the madconfig utility
Mapping Interceptor interactions to the new version

Last updated: 22 Apr 2016