Kohei Nozaki's blog 

Using Apache BatchEE's server API with JBeret

Posted on Wednesday Mar 04, 2015 at 06:11PM in JBatch

Apache BatchEE is a fork of the JSR352 reference implementation with many additional features. it has useful REST APIs built on JAX-RS so we can manipulate (start, stop, restart, and so on) batches through REST API. fortunately, it is well modularized so we can use its REST API implementation with other JSR352 implementation such as JBeret.

curl -H 'Content-Type: application/json' \
     -d '{"entries": [ {"key": "myKey1", "value": "myValue1"}, {"key": "myKey2", "value": "myValue2"} ]}' \

Then you’ll see following output in WildFly console:

17:57:18,608 INFO  [stdout] (Batch Thread - 9) Hello world!
17:57:18,609 INFO  [stdout] (Batch Thread - 9) Job Parameters: {myKey2=myValue2, myKey1=myValue1}

It’s much better than create a servlet which kicks the batch.

And I haven’t tested yet, it also have useful client API for that REST API. we can use JobOperator transparently thanks to its proxy. for details of REST API and BatchEE, see following URLs:


I added a test case which uses client API of BatchEE, but it doesn’t work with released version. you need to apply a patch by hand. for details refer https://issues.apache.org/jira/browse/BATCHEE-59

Also I created an example of a test class which uses Arquillian. this won’t work with 0.2-incubating but will work with future versions.

public class MyJobArquillianIT {
    private URL url;
    private JobOperator jobOperator;

    @Deployment(testable = false)
    public static Archive<?> war() {
        final File[] files = Maven.configureResolver()
        return ShrinkWrap.create(WebArchive.class)

    public void before() {
        jobOperator = BatchEEJAXRSClientFactory.newClient(url.toExternalForm() + "jbatch");

    public void test() {
        Properties jobParameters = new Properties();
        jobParameters.setProperty("someKey", "someValue");
        final JobExecution jobExecution = waitForFinish(jobOperator.start("myjob", jobParameters));
        Assert.assertEquals(BatchStatus.COMPLETED, jobExecution.getBatchStatus());

    private static final Collection<BatchStatus> BATCH_END_STATUSES
            = EnumSet.of(BatchStatus.COMPLETED, BatchStatus.FAILED, BatchStatus.STOPPED, BatchStatus.ABANDONED);

    private JobExecution waitForFinish(long executionId) {
        JobExecution jobExecution;
        while (!BATCH_END_STATUSES.contains((jobExecution = jobOperator.getJobExecution(executionId)).getBatchStatus())) {
            try {
            } catch (InterruptedException e) {
                throw new RuntimeException(e);
        return jobExecution;

Web frontend

Its web-frontend GUI (batchee-servlet-embedded) works even against JBeret runtime as follows. you can view executions, jobs and its definition, and can start jobs with custom parameters.

42afff86 2c07 4c4f 8a93 9b90f4910b43

It also exposes simple-rest API which is more useful when issue the command by hand or some cases (e.g. cron job). in case of this example, you can start a job as follows:

$ curl 'http://localhost:8080/batcheetest/jbatch-gui/rest/start/myjob?param1=x&param2=y'

You can read its help as follows:

$ curl 'http://localhost:8080/batcheetest/jbatch-gui/rest/'
Unknown command:
The returned response if of MIME type text/plain and contains the following information
  {jobExecutionId} (or -1 if no executionId was detected)\n
  OK (or FAILURE)\n
  followed by command specific information

Known commands are:

* start/ - start a new batch job
  Sample: http://localhost:8080/myapp/jbatch/rest/start/myjobname?param1=x&param2=y
  BatchEE will start the job and immediately return

* status/ - query the current status
  Sample: http://localhost:8080/myapp/jbatch/rest/status/23
  will return the state of executionId 23

* stop/ - stop the job with the given executionId
  Sample: http://localhost:8080/myapp/jbatch/rest/stop/23
  will stop the job with executionId 23

* restart/ - restart the job with the given executionId
  Sample: http://localhost:8080/myapp/jbatch/rest/restart/23
  will restart the job with executionId 23

No one has commented yet.

Leave a Comment

HTML Syntax: NOT allowed