Recorder engine

It is possible to attach a recorder engine to the framework. This engine will record all invocations and notifications in the framework.

Configuration

The eventLogger element in the framework properties allows to use a recorder engine which will record all invocations and notifications in the framework.

The attributes of the element are:

• The url attribute declares the jar file of the library which will be used to perform the record
• The scenario attribute declares the file to use to serialize the record
• The autoStart attribute is an optional attribute specifying if the record must begin as soon as the framework starts

Example

The following example uses the perfo Logger engine:

      <files>
         <file url="applications.xml" />
         <file url="services.xml" />
         <file url="types.xml" />
         <eventLogger url="perfoLogger.jar" scenario="logged.xml"/>
      </files>

Interface API

The API for the engine is in the EventEngine interface.

The methods to implement for initializing and stopping the engine are:

• The EventEngine.init(Framework, URL) method is called at the initialization of the framework
• The EventEngine.setStartTimeStamp(long) is called at the start of the framework to set the time stamp of the start
• The EventEngine.start() is called at the start of the framework
• The EventEngine.isActive() return true if the engine is active
• The EventEngine.stop() is called to stop the engine
• The EventEngine.end() is called at the shutdown of the framework

The methods to implement for the services notification are:

• The EventEngine.invoke(NamespaceKey, int, ModuleKey) is called for each invocation
• The EventEngine.sendToNetwork(NamespaceKey) is called each time a service is send through the network
• The EventEngine.notified(NamespaceKey, int, ModuleKey, ModuleKey) is called for each notification
• The EventEngine.receivedFromNetwork(NamespaceKey) is called each time a service is received through the network

Implementing the API

To implement the Engine, you must create a class which implemetns the API, and declare the path of this class in your matnifest with the Engine manifest property name. For example:

      Engine: org.da.protoframework.perfologger.RecorderEngine