Helper class for the Software AG Apama Event Correlator.
The Correlator Helper class has been designed for use as an extension
module to the PySys System Test Framework, offering the ability to
configure, start and interact with an Event Correlator. The usage pattern
of the class is to create an instance per Correlator, and to then make
method calls onto the instance to perform operations such as the
injection of monitorscript or java JMON applications, the sending of
events, deletion of named objects etc. For example:
Process related methods of the class declare a method signature which
includes named parameters for the most frequently used options to the
method. They also declare the **xargs parameter to allow passing in of
additional supported arguments to the process. The additional arguments
that are currently supported via **xargs are:
|
__init__(self,
parent,
port=None,
host=None)
Create an instance of the CorrelatorHelper class. |
source code
|
|
|
addToClassPath(self,
path)
Add the supplied path to the CLASSPATH environment variable for
starting this instance. |
source code
|
|
|
addToPath(self,
path)
Add the supplied path to the PATH (win32) or LD_LIBRARY_PATH (unix)
environment variable for starting this instance. |
source code
|
|
|
start(self,
logfile=None,
verbosity=None,
java=None,
Xclock=None,
environ=None,
**xargs)
Start the Correlator. |
source code
|
|
|
receive(self,
filename=None,
filedir=None,
channels=[],
suppressBatch=True,
zeroAtFirstBatch=None,
utf8=False,
**xargs)
Attach a receiver to the Correlator. |
source code
|
|
|
watch(self,
filename=None,
filedir=None,
raw=False,
interval=None,
**xargs)
Obtain runtime operational status from the Correlator. |
source code
|
|
|
|
|
injectJMON(self,
filename,
filedir=None,
**xargs)
Inject a JMON java application into the Correlator. |
source code
|
|
|
injectScenario(self,
filename,
filedir=None,
debug=False,
blocks=None,
functions=None,
**xargs)
Inject a Scenario into the Correlator. |
source code
|
|
|
send(self,
filenames=[],
filedir=None,
loop=None,
utf8=False,
doNoBatch=False,
**xargs)
Send events into the Correlator. |
source code
|
|
|
delete(self,
names=[],
filename=None,
filedir=None,
force=False,
kill=False,
all=False,
utf8=False,
**xargs)
Delete named objects from the Event Crrelator. |
source code
|
|
|
manage(self,
**xargs)
Execute management operations against the Correlator. |
source code
|
|
|
connect(self,
source,
channel=None,
**xargs)
Connect a Correlator to this instance as a source. |
source code
|
|
|
disconnect(self,
source,
channel=None,
**xargs)
Disconnect a correlator to this instance as a source correlator. |
source code
|
|
|
|
|
|
|
|
|
profilingOn(self)
Inform the Event Correlator to start collecting profiling statistics. |
source code
|
|
|
profilingOff(self)
Inform the Event Correlator to stop collecting profiling statistics. |
source code
|
|
|
profilingReset(self)
Inform the Event Correlator to reset it's collection of profiling
statistics. |
source code
|
|
|
profilingGet(self,
filename,
filedir=None)
Obtain the latest profiling statistics from the Event Correlator. |
source code
|
|
|
toStringAll(self,
filename,
filedir=None)
Obtain a stringified representation of the current application state
from the Event Correlator. |
source code
|
|
|
waitForCorrelatorUp(self,
timeout=20)
Block until the Correlator declares itself to be ready for
processing. |
source code
|
|
|
flush(self,
timeout=60,
count=1,
**xargs)
Make sure all events have been flushed through the correlator. |
source code
|
|
|
__inject(self,
filenames=[],
filedir=None,
utf8=False,
java=False,
**xargs)
Inject an application into the correlator. |
source code
|
|
|
__createScenarioManagerConfig(self,
blocks=None,
functions=None)
Create the Scenario Manager configuration file for the location of
all blocks and functions. |
source code
|
|