The ScenarioService API consists of three interfaces, IScenarioService, IScenarioDefinition, and IScenarioInstance; the ScenarioServiceFactory class; and the ScenarioServiceConfig class. These are included in the package com.apama.services.scenario.

The IScenarioService interface is used to establish communication with the event correlator and to provide access to the scenario definitions in the correlator.

The IScenarioDefinition interface is used to represent a scenario running in the correlator (not an instance). The interface provides methods to obtain meta-information, such as parameter names, types, and constraints, about the scenarios in the correlator. The interface has methods for adding and removing listeners. It also has methods for accessing all instances of a scenario as well as for creating new instances of it.

The IScenarioInstance interface is used to represent a single instance of a scenario. The interface has methods to access the values of the instance’s parameters as well as to delete the instance. The interface also has methods to add and remove listeners.

The ScenarioServiceFactory class provides three methods for creating new instances of classes that implement the IScenarioService interface.

The ScenarioServiceConfig class is a helper class for building a properties map when using the ScenarioServiceFactory to create a new ScenarioService

The complete reference guide for the ScenarioService API is available in HTML format in the Apama installation’s doc\javadoc directory.

A selection of sample applications that use the ScenarioService API is available in the Apama installation’s samples\engine_client\javaScenarioService directory.