This project provides a Holodeck B2B delivery method that will only write the payloads of a User Message to file. This can be useful when the business documents contain all relevant meta-data that the back-end application needs for processing the document. Because there is no ebMS meta-data written to file there is also no possibility to indicate the possible relation between multiple payloads in a User Message and it is the business application's responsibility to determine the possible relations solely based on the contents of the payloads.
For more information on using Holodeck B2B visit the website at http://holodeck-b2b.org
Lead developer: Sander Fieten
Code hosted at https://github.com/holodeck-b2b/payloadonly-delivery
Issue tracker https://github.com/holodeck-b2b/payloadonly-delivery/issues
This delivery method can be used in Holodeck B2B version 3.0.0 or later. It runs on JRE version 7.
Like any delivery method this one is configured in the P-Mode. As it to be used for the delivery of User Messages it should be configured as the default delivery method in, i.e. in element //Leg/DefaultDelivery. The class name of the to set in DeliveryMethod is org.holodeckb2b.deliverymethod.file.PayloadOnly.
There is one required parameter deliveryDirectory which indicates the path of the directory where the payload files should be written to. This directory must already exists and of course should be accessible and writable by Holodeck B2B.
NOTES:
- Because this delivery method only delivers the business data to the back-end appliction it can only be used for the delivery of User Message message units. If used in a P-Mode that also needs to notify signal message units (Receipts or Errors) to the back-end specific delivery methods should be specified for the signals!
- The back-end application should acquire a write lock on the files before processing them as Holodeck B2B may still be writing data to them.
- As payloads are delivered individually the deliverer cannot ensure that the total delivery is atomic. The {@link IMessageDeliveryEvent} may be used to get notifications about the completeness of the delivery.
- It is recommended to use the duplicate elimination function of the AS4 Reception Awareness feature.
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
- run integration tests to check everything works on runtime
- 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.
Like the Holodeck B2B Core this delivery method is licensed under the General Public License V3 (GPLv3) which is included in the LICENSE file in the root of the project.
Commercial Holodeck B2B support is provided by Chasquis Consulting. Visit Chasquis-Consulting.com for more information.