Summary: Configuration
org.mule.module.esper

esper-module

config

Namespacehttp://www.mulesoft.org/schema/mule/esper
Schema Locationhttp://www.mulesoft.org/schema/mule/esper/current/mule-esper.xsd  (View Schema)
Schema Version1.0
Minimum Mule Version3.3

Module Overview

A Mule Module for Esper, a GPL licensed complex event processing engine.

Summary

Configuration
<esper:config>
Configure an instance of this module
Message Sources
<esper:listen>
Listens for events matching the specified query statement.
Message Processors
<esper:filter>
Filters messages that match the supplied EPL query.
<esper:send>
Sends events to an Esper event stream.

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:esper="http://www.mulesoft.org/schema/mule/esper"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/esper
               http://www.mulesoft.org/schema/mule/esper/current/mule-esper.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necessary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
TypeNameDefault ValueDescriptionJava TypeMIME TypeEncoding
xs:string name Optional. Give a name to this configuration so it can be later referenced.
xs:string configuration The location of the Esper config file.

Message Processors

<esper:filter>

Filters messages that match the supplied EPL query. The EPL query must return a Boolean value.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
eventPayload Optional. The event to be injected into the event stream. This is useful if your filter statement relies on the event being injected into the stream beforehand. Object */*
statement The EPL statement String */* UTF-8
key The key of the result to evaluate from the query String */* UTF-8
afterChain The SourceCallback SourceCallback */*

<esper:send>

Sends events to an Esper event stream.

Events can be Java objects, Maps or an XML Node. All event types must be registered in the Esper configuration.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
eventPayload The event to be injected into the event stream. Object */*
eventName Optional. The name of the event in the case of a Map payload. String */* UTF-8

Message Sources

<esper:listen>

Listens for events matching the specified query statement.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
statement The Esper statement to select events from a stream. String */* UTF-8
callback The callback to be called when a message is received SourceCallback */*

Transformers