holodeck-b2b/file-backend

Holodeck B2B extension that implements a file based back-end integration

Holodeck B2B

Holodeck B2B is a standalone B2B messaging solution. This project includes support for the OASIS specifications for ebMS3 and the AS4 profile. Java based, it will run on most platforms.

It is designed with extensibility in mind providing an interface layer (API) which you can find in the Interfaces module, and lots of documentation inside the code.

---

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/Holodeck-B2B
Issue tracker https://github.com/holodeck-b2b/Holodeck-B2B/issues

Installation

Prerequisites

Java 8 or higher is required to run Holodeck B2B.

Getting started guide

To help you set up your first instance of Holodeck B2B, you will find a step-by-step guide to setting up Holodeck B2B on the project website.

Contributing

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, including comments
• commit incrementally with readable and detailed commit messages
• run integration tests to check everything works on runtime
• Update the changelog with a short description of the changes including a reference to the issues fixed
• submit a pull request against the 'next' 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.

Submitting bugs

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).

Versioning

Version numbering follows the Semantic versioning approach.

License

The Holodeck B2B core is licensed under the General Public License V3 (GPLv3) which is included in the license.txt in the root of the project. This means you are not allowed to integrate Holodeck B2B in a closed source product. You can however use Holodeck B2B together with your closed source product as long as you only use the provided interfaces (API's) to communicate with the Holodeck B2B core. For this purpose, the interfaces module is licensed under the Lesser General Public License V3 (LGPLv3).

To implement the cryptographic algorithms Holodeck B2B uses the Bouncy Castle library provided by The Legion of the Bouncy Castle Inc., see the bc_license.txt file.

Support

Commercial Holodeck B2B support is provided by Chasquis. Visit Chasquis-consulting.com for more information.

file-backend's Issues

It would be nice if inbound mmd files showed the pmode even if it was found by matching.

Currently, if a inbound message has an agreement then the MMD has:

<AgreementRef>http://agreements.holodeckb2b.org/examples/agreement0&lt;/AgreementRef>

Where the outbound MMD had

<AgreementRef pmode="ex-pm-push"/>

Delivery operation does not use HB2B home as base for relative path parameter

When the deliveryDir parameter of the delivery operation is a relative path it is not evaluated against the Holodeck B2B home directory but the directory where Holodeck B2B is installed.

Make default removal of submitted payloads configurable

After implementing #2 submitted payloads files are removed by default. If these files should be kept, for example for archiving or sending to another partner, the back-end needs to indicate this in the MMD. This behaviour therefore causes backwards incompatibility and requires a change in the back-end application. It would therefore be better if the default removal of submitted payloads is configurable so it can be disabled in cases where payload files should be kept.

Requested delivery format ignored

Even when specifying the delivery format as "mmd" or "single_xml" the "ebms" format is used.

Change default removal of payloads after submission

In the file based back end integrator the current default is that after submission, files are not removed unless the back end system instructs Holodeck B2B to do so.
This can cause disk space to run out if the back end system does not do this (or not properly).
Sent payloads must then be removed manually or using a script.
Solution: Switch to default file removal after submission.

Duplicate occurrence of eb3:PayloadInfo elements in single XML delivery

When using the single_xml format the XML document contains duplicate occurrences of the eb3:PayloadInfo elements. The second occurrence contains the modified eb3:PartInfo elements with the additional org:holodeckb2b:ref part property. There should however be just one occurrence of these elements that includes this additional property.

Use a temporary extension when writing meta-data files

Currently the meta-data file uses the xml extension when it is being written to disk. This may cause the receiving back-end application to start reading it before the delivery operation has finished. It would therefore be better to use a temporary extension when writing the file to disk and rename it as last step.

Namespace declararion missing in single XML delivery

When a User Message unit is delivered in the single_xml format there is no default namespace declaration on the root element.

Outdated hb2b version in pom.xml

The HB2B version in the pom.xml should be updated to 5.3.1:

<holodeckb2b.version>5.1.0</holodeckb2b.version>