jBPM as a remote service

The jBPM platform provides many remote APIs services. It provides developers with an improved level of flexibility in designing solutions that require jBPM integration. This remote APIs opens up a number of possibilities with a flexible, open architecture, in order to satisfy and to quickly react to changing application requirements.

JBPM work with the following remote service APIs –

jBPM remote service

The REST API

This API is used to manage tasks, process, create process instances, and other actions which require the use of a simple HTTP client library. It provides functionalities in the following areas –

RuntimeEngine – It provides the user with process instance creation, process instance querying, and workitem operations.

History – It provides with auditing data.

Task – It provides task operation and task query methods.

Deployment – It provides deployments management operations.

Authentication

jBPM provides authentication For the REST API. Upon invocation, the REST service operations check for the basic authentication user ID of your current HTTP session. If we are not authorized it will give an error, otherwise set user ID and password for authentication. This will return the following response-

 <deployment-unit> <groupId>com.sample</groupId> <artifactId>helloworld</artifactId> <version>1.0</version> <kbaseName/> <ksessionName/> <strategy>SINGLETON</strategy> <status>DEPLOYED</status> </deployment-unit> 

The remote Java API

If we don’t want to manually create HTTP requests to access jBPM remotely, then we can use Java API. The Java API is a high-level API. It uses REST or JMS API to interact with the remote engine services to provide the user with service API classes such as TaskService, KieSession and so on. The entry point of Java API is the classRuntimeEngine, and we can access it by using the class RemoteRuntimeEngineFactory as given below.

 // the deploymentId identifies the KIE module         public static String deploymentId = “com.abc.sasa:1.0”;         RemoteRestRuntimeEngineBuilder restEngineBuilder = RemoteRuntimeEngineFactory.newRestBuilder()         .addDeploymentId(deploymentId)         .addUrl(instanceurl).addUserName(user)         .addPassword(password);         RemoteRestRuntimeEngineFactory engineFactory = restEngineBuilder         .buildFactory();      // get the engine         RemoteRuntimeEngine engine = engineFactory.newRuntimeEngine();      // get the services         TaskService taskService = engine.getTaskService();         KieSession ksession = engine.getKieSession();         ProcessInstance processInstance = ksession.startProcess(processID); 

Now, we have to access KieSession, TaskService and AuditService remote interfaces. These interfaces help to perform remote calls using pure Java code and manage HTTP connections with the remote jbpm server. The remote API must have the following maven dependency.

 <dependency>     <groupId>org.kie.remote</groupId>     <artifactId>kie-remote-client</artifactId>     <version>7.7.0.Final</version> </dependency> 

The SOAP API

SOAP stands for Simple Object Access Protocol. It is a messaging protocol which allows a program to run on different operating system to exchange information using HTTP protocol. It allows us client-server communication. In this API, Clients can initiate requests to servers then servers process that requests and return responses to the user.

Dependency-

The Maven Dependency for SOAP API are as follows-

 <dependency>     <groupId>org.kie.remote.ws</groupId>     <artifactId>kie-remote-ws-common</artifactId>     <version>7.7.0.Final</version> </dependency> 

Command Web Service

In this section, we will now describe how to call into jBPM by using its SOAP API. Our jbpm-remote-server test project, the SOAPTest jUnit test class, creates a web service client and then starts a new process instance.

JBoss BPM Suite provides a SOAP interface in the form of CommandWebService. A Java client is rovided as a generated CommandWebService class. Classes generated by the kie-remote-client module function as a client-side interface for SOAP. The CommandWebServiceClient class referenced in the test code below is generated by the Web Service Description Language (WSDL) in the kie-remote-clientJAR.

 import org.kie.remote.client.api.RemoteRuntimeEngineFactory; import org.kie.remote.client.jaxb.JaxbCommandsRequest; import org.kie.remote.client.jaxb.JaxbCommandsResponse; import org.kie.remote.jaxb.gen.StartProcessCommand; import org.kie.remote.services.ws.command.generated.CommandWebService; import org.kie.services.client.serialization.jaxb.impl.JaxbCommandResponse;  public JaxbProcessInstanceResponse startProcessInstance(String user, String password, String processId,  String deploymentId, String applicationUrl) throws Exception {    CommandWebService client = RemoteRuntimeEngineFactory     .newCommandWebServiceClientBuilder()     .addDeploymentId(deploymentId)     .addUserName(user)     .addPassword(password)     .addServerUrl(applicationUrl)     .buildBasicAuthClient();    // Get a response from the WebService:   StartProcessCommand cmd = new StartProcessCommand();   cmd.setProcessId(processId);   JaxbCommandsRequest req = new JaxbCommandsRequest(deploymentId, cmd);   final JaxbCommandsResponse response = client.execute(req);    JaxbCommandResponse<?> cmdResp = response.getResponses().get(0);    return (JaxbProcessInstanceResponse) cmdResp; } 

Next Topic#

jBPM Remote Services