What are the public and internal APIs for BPM Suite and BRMS 6?

Solution Verified - Updated

Environment

  • Red Hat JBoss BPM Suite (BPMS)
    • 6.x
  • Red Hat JBoss BRMS (BRMS)
    • 6.x

Issue

We would like to know which BRMS/BPMS APIs can we use in our application.

Resolution

PUBLIC:
The kie-api is the recommended way to interact with the project. It is fully supported and we try to keep it backwards compatible across versions (or provide migration support for mayor version updates).
Red Hat also fully support out-of-box implementation of worktitems shipped with the product.

BRMS and BPM Suite until 6.0.3 had supported knowledge-api as legacy backward to BRMS 5.3.1 but deprecated. It is no longer supported since 6.1 release. We strongly recommend the use of kie-api instead of knowledge-api.

Note: Because the nature of deployment has significantly changed in 6.0, it was not possible to provide an adapter bridge for the KnowledgeAgent.

INTERNAL / IMPLEMENTATION:
Any class out of kie-api / knowledge-api (excluding shipped workitems) are considered internals. Red Hat offers commercially reasonable effort for such APIs given that we can not guarantee backward compatibility and it is possible that there will be changes to this API across versions. Such APIs should only be accessed if the developer is aware of the implementation details and risk / consequences of using them directly. Cases where extend or customization is made of a class shipped with the product are not support without approval from Red Hat.

Here is a list of modules which are exceptionally supported for specific use cases:

  • jbpm-test (BPMS)
    • for jbpm testing purposes
  • kie-services-client (Until BPMS 6.0)
    • for jbpm remote client
  • kie-remote-client (Since BPMS 6.1)
    • for jbpm remote client
  • kie-server-client (Since BRMS/BPMS 6.2)
    • for kie-server remote client
SBR
Product(s)
Category
Tags

This solution is part of Red Hat’s fast-track publication program, providing a huge library of solutions that Red Hat engineers have created while supporting our customers. To give you the knowledge you need the instant it becomes available, these articles may be presented in a raw and unedited form.