Skip to content

mo-fu/Proton

 
 

Repository files navigation

IBM Proactive Technology Online

IBM Proactive Technology Online is an open source complex event processing engine developed at IBM Research - Haifa. It provides language primitives for defining, submitting, and executing event processing networks. The goal of the system is to respond to raw events and identify meaningful events within contexts. The system comes with a set of built-in operators (such as sequence, all, etc.) for determining CEP patterns. It also has extendable APIs for adding additional custom operators. The system comes with existing source/sink adapters, allowing it to extract raw events from files or pull them from RESTful services. It also provides extendable APIs for adding more adapter types.

The repository includes

The Proton standalone version:
  • The Proton J2SE version, is which is just a simple Java app running the Proton engine. This can be found under ProtonJ2SE project.

  • The Proton web version provides a RESTful interface for sending events, as well as the admin app for managing Proton apps; Those are the ProtonOnWebServer and ProtonOnWebServerAdmin projects, respectively. This version of the engine is adapted to run on a web server. It allows users to push RESTful events to the engine in addition to pulling RESTful events options provided by the REST adapter. This version also provides REST APIs for managing the engine’s instance lifecycle, and to manage the definition repository.

  • The Proton web UI, provides an authoring environment for Proton applications; Those are the AuthoringTool and AuthoringToolWebServer projects.

  • The Proton on STORM version, which allows to run the engine in a distributed manner on multiple machines using the STORM infrastructure.

For working with source code

The projects are maven projects. They can be built using the "clean install" targets by running the mvn command on the parent pom (located in the "Proton”) directory. This command will build all the Proton projects.

In addition, by executing the "mvn deploy" command of the same parent pom after performing clean install, the target jars will be installed into a local repository named "mvn-repo" (/Proton/maven-repo).

For working with artifacts

The https://github.com/ishkin/Proton/tree/master/mvn-repo/com/ibm/hrl/proton contains all the built artifacts. Those can be used as dependencies in maven builds. In case you would like to work with simple artifacts, you can find those under : https://github.com/ishkin/Proton/tree/master/artifacts

For standalone engines, the ProtonJ2SE artifact (located in https://github.com/ishkin/Proton/tree/master/artifacts/ProtonJ2SE.zip ) is a .zip distribution, with ProtonJ2SE executable jar, launch script, sample, and docs directory.

For instructions on how to configure and install IBM Proactive Technology Online on Tomcat (web version), see the following guide: https://forge.fi-ware.org/plugins/mediawiki/wiki/fiware/index.php/CEP_GE_-_IBM_Proactive_Technology_Online_Installation_and_Administration_Guide

This project is part of FIWARE. More information about this project is provided in the FIWARE catalogue.

  • In the catalogue you can find several ways to use the Proactive Technology Online Generic Enabler instance (creating instance, using existing instances, downloads the code).

  • If you like to install the Proactive Technology Online, follow the installation guide. This guide includes running instructions and sanity checks procedures.

  • For more advanced tests, you can follow the unit tests.

  • General information on this technology can be found in the CEP open specification page.

  • A high level description of the technology and an api overview can be found as part of the FIWARE developers’ tour guide.

  • A complete set of the REST api can be found here.

  • More documentation is provided under the documentation folder, as described below.

  • Education material can be found at the FIWARE academy

Documentation

Can be found under the /documentation folder, and includes the Proton’s User Guide (explaining the language building blocks and use of the authoring tool use) and Programmer’s Guide (explaining possible extension points to the Proton’s programming model)

Licence License

IBM Proactive Technology Online is licenced licensed under the Apache Licence License Version 2.0. for For more information see the LICENCE.md

About

IBM Proactive Technology Online

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 61.4%
  • HTML 27.2%
  • Java 6.0%
  • CSS 4.0%
  • PHP 1.1%
  • XSLT 0.2%
  • Other 0.1%