https://github.com/siddhi-io/siddhi-map-json
Extension which is used to convert JSON message to/from Siddhi events
https://github.com/siddhi-io/siddhi-map-json
extension json json-parser mapper siddhi
Last synced: about 1 year ago
JSON representation
Extension which is used to convert JSON message to/from Siddhi events
- Host: GitHub
- URL: https://github.com/siddhi-io/siddhi-map-json
- Owner: siddhi-io
- License: apache-2.0
- Created: 2017-05-17T07:58:55.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-03-07T04:33:23.000Z (over 1 year ago)
- Last Synced: 2025-03-28T03:00:56.957Z (about 1 year ago)
- Topics: extension, json, json-parser, mapper, siddhi
- Language: Java
- Homepage: https://siddhi-io.github.io/siddhi-map-json/
- Size: 1.83 MB
- Stars: 13
- Watchers: 27
- Forks: 43
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Siddhi Map JSON
===================
[](https://wso2.org/jenkins/job/siddhi/job/siddhi-map-json/)
[](https://github.com/siddhi-io/siddhi-map-json/releases)
[](https://github.com/siddhi-io/siddhi-map-json/releases)
[](https://github.com/siddhi-io/siddhi-map-json/issues)
[](https://github.com/siddhi-io/siddhi-map-json/commits/master)
[](https://opensource.org/licenses/Apache-2.0)
The **siddhi-map-json extension** is an extension to Siddhi that converts JSON messages to/from Siddhi events.
For information on Siddhi and it's features refer Siddhi Documentation.
## Download
* Versions 5.x and above with group id `io.siddhi.extension.*` from here.
* Versions 4.x and lower with group id `org.wso2.extension.siddhi.*` from here.
## Latest API Docs
Latest API Docs is 5.2.5.
## Features
* json *(Sink Mapper)*
This extension is an Event to JSON output mapper.
Transports that publish messages can utilize this extension to convert Siddhi events to JSON messages.
You can either send a pre-defined JSON format or a custom JSON message.
* json *(Source Mapper)*
This extension is a JSON-to-Event input mapper. Transports that accept JSON messages can utilize this extension to convert an incoming JSON message into a Siddhi event. Users can either send a pre-defined JSON format, where event conversion happens without any configurations, or use the JSON path to map from a custom JSON message.
In default mapping, the JSON string of the event can be enclosed by the element "event", though optional.
## Dependencies
There are no other dependencies needed for this extension.
## Installation
For installing this extension on various siddhi execution environments refer Siddhi documentation section on adding extensions.
## Support and Contribution
* We encourage users to ask questions and get support via StackOverflow, make sure to add the `siddhi` tag to the issue for better response.
* If you find any issues related to the extension please report them on the issue tracker.
* For production support and other contribution related information refer Siddhi Community documentation.