Event Stream Processor Adapter Toolkit

Use the Event Stream Processor adapter toolkit to quickly build custom external adapters using Java. Adapters built using the toolkit consist of various component modules configured together to deliver data to and publish data from Event Stream Processor. Module types include transporters (for interacting with external transports), formatters (for converting data from one format to another), and ESP connectors (for subscribing or publishing to ESP).

The toolkit includes numerous transporters, formatters, and ESP connectors that can be configured in various combinations by an administrator. You can also combine these out-of-the-box modules with custom modules created by a Java developer.

The adapter toolkit allows you to implement:

An input adapter to act as a datasource for the ESP Server.
An output adapter to act as a data destination and deliver data from streams in ESP.
A dual-direction adapter to act as both a datasource and data destination for Event Stream Processor.
Guaranteed delivery (GD) to minimize loss of data during transfer of input data.
Schema discovery to automatically discover schema for your custom input and output adapter.

Preconfigured Adapters Included with the Adapter Toolkit
Event Stream Processor includes various preconfigured and ready for use adapters that have been created using the adapter toolkit.
Create a Custom Adapter
Use the ESP adapter toolkit to create a custom adapter. You can do this by combining transporter and formatter modules that are provided with the adapter toolkit, by writing your own custom transporter and formatter modules, or by combining existing modules with custom ones.
Accessing Adapter Toolkit API Reference Information
API documentation about methods, functions, and other programming building blocks.
Transporter Modules
A transporter module is the interface that interacts with external data sources by obtaining data from a data source or outputting data to a data destination.
Formatter Modules
A formatter module converts between the data format of the transporter module and Event Stream Processor.
Batch Processing
Details about how to control the manner in which AdapterRow instances are sent and processed by Event Stream Processor.
Schema Discovery
Discover external schemas and create CCL schemas, streams, or windows based on the format of the data from the datasource that is connected to an adapter.
Guaranteed Delivery
Guaranteed delivery (GD) is a delivery mechanism that guarantees data is processed from a stream to an adapter.
EspConnector Modules
The EspConnector modules are responsible for connecting to Event Stream Processor. Connector module types include: EspSubscriber, EspMultiStreamSubscriber, EspPublisher, and EspMultiStreamPublisher.
Event Stream Processor Configuration
Use Event Stream Processor elements, which are defined in the adapater configuration file, to configure communication between Event Stream Processor and the adapter instance.
Configuring a New Adapter
Configure a new adapter by creating a configuration file for it. The configuration file defines the adapter component chain through which data is processed, and the connection to Event Stream Processor.
Starting an Adapter
You can start an adapter either in unmanaged or managed mode. In unmanaged mode, the adapter is started separately from the ESP project, and in managed mode, the adapter is started with the ESP project.
Stopping an Adapter
You can stop an adapter either in unmanaged or managed mode. In unmanaged mode, the adapter is stopped separately from the ESP project, and in managed mode, the adapter is stopped with the ESP project.
Adapter Toolkit Examples
The %ESP_HOME%/adapters/framework/examples directory contains various example modules for the adapter toolkit.
Adapter Toolkit: Sample cnxml File for Input Adapters
Adapter type: toolkit_input. Sample cnxml file for an input adapter created using the adapter toolkit. You can use this file as reference for creating your own cnxml file for your custom adapter.
Adapter Toolkit: Sample cnxml File for Output Adapters
Adapter type: toolkit_output. Sample cnxml file for an output adapter created using the adapter toolkit. You can use this file as reference for creating your own cnxml file for your custom adapter.
Debugging a Custom Adapter
Debug a custom Java adapter (that was built using the adapter toolkit) by starting it in debug mode and using an Integrated Development Environment (IDE) that supports remote debugging, such as Eclipse.