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 out-of-the-box, which 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.

• Preconfigured Adapters Included with the Adapter Toolkit
  Event Stream Processor includes various preconfigured and ready for use external 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
  Detailed information on methods, functions, and other programming building blocks is provided in the API level documentation.
• Transporter Modules
  A transporter module is the interface module 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 on controlling how AdapterRow instances are sent and processed by Event Stream Processor.
• Schema Discovery
  You can use the schema discovery feature to discover external schemas and create CCL schemas based on the format of the data from the datasource 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 the modules responsible for connecting to Event Stream Processor. There are four EspConnector module types: EspSubscriber, EspMultiStreamSubscriber, EspPublisher, and EspMultiStreamPublisher.
• Event Stream Processor Parameters
  Event Stream Processor parameters configure communication between Event Stream Processor and the adapter instance. Define these parameters in the adapter configuration file.
• Configuring a New Adapter
  Configure a new adapter by creating a configuration file for that adapter. The configuration file defines the adapter component chain through which data is processed, as well as the connection to Event Stream Processor.
• Starting an Adapter
  You can start an adapter either in standalone or managed mode. In standalone 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 standalone or managed mode. In standalone 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.