An extension for Holodeck B2B that implements the Submit, Notify and Deliver operations using a REST API. The message meta-data are included in the HTTP headers and the payload of User Messages as entity body. For simplicity and as it is a very common use-case this implementation only supports User Messages with a single payload.
For more information on using Holodeck B2B visit http://holodeck-b2b.org
Lead developer: Sander Fieten
Code hosted at https://github.com/holodeck-b2b/rest-backend
Issue tracker https://github.com/holodeck-b2b/rest-backend/issues
This extension requires that you have already deployed Holodeck B2B version 6.0.0 or later and the "rest-no-error-content" Axis2 module.
First step is to build the extension or download the latest release. You should now have the rest-backend-«version».jar and hb2b-rest-backend.aar files available. Copy the jar file to the lib directory of the Holodeck B2B instance and copy the aar file to the repository/services directory to enable the REST interface in the Holodeck B2B instance. Please note that you cannot activate the extension in a running Holodeck B2B instance and will need to restart the server to activate the REST extension.
No additional configuration is needed for the Submit operation. The Delivery and Notify operations are configured in the
P-Modes by setting the delivery method. To use this REST back-end integration set the applicable DeliveryMethod element to org.holodeckb2b.backend.rest.NotifyAndDeliverOperation and configure its parameters:
- URL : the URL where the REST service is hosted by the back-end application. As explained above "/deliver" will be added to this URL when delivering User Messages and for "/notify/receipt" and "/notify/error" for notification of Receipt respectively Error Signals.
- TIMEOUT : the time (in milliseconds) the delivery method should wait for the back-end system to accept the delivery and notification. This parameter is optional and when not specified a default timeout of 10 seconds will be used.
- SIGNAL_WITH_CONVID : indicates whether the ConversationId of the User Message referenced by the notified Signal Message should be included in the notification to the back-end system. This is an optional parameter and when not specified the ConversationId will not be included.
For a full description how the operations are implemented see the API Specification page.
We are using the simplified Github workflow to accept modifications which means you should:
- create an issue related to the problem you want to fix or the function you want to add (good for traceability and cross-reference)
- fork the repository
- create a branch (optionally with the reference to the issue in the name)
- write your code
- commit incrementally with readable and detailed commit messages
- submit a pull-request against the master branch of this repository
If your contribution is more than a patch, please contact us beforehand to discuss which branch you can best submit the pull request to.
You can report issues directly on the project Issue Tracker.
Please document the steps to reproduce your problem in as much detail as you can (if needed and possible include screenshots).
Version numbering follows the Semantic versioning approach.
This module is licensed under the General Public License V3 (GPLv3) which is included in the LICENSE in the root of the project.
NOTE that this license only applies to the source code contained in this project and does not apply to the implementation of the REST API by the backend system.
Commercial Holodeck B2B support is provided by Chasquis. Visit Chasquis-Consulting.com for more information.