Java EE 7 SDK

The JobOperator API Batch Sample Application

This sample demonstrates how to use the javax.batch.operations.JobOperator interface to submit batch jobs.

Description

This sample application demonstrates how to use the Batch Processing API (JSR 352) to submit batch jobs and how to obtain information about submitted jobs using the JobOperator interface.

The job xml contains one step called 'process'. This step uses three batch artifacts:

SimpleItemReader is an ItemReader implementation that reads input records. The batch runtime calls the ItemReader.readItem() method to read input records. ItemReader implementations can read input records from a variety of sources like databases, text files, other Java EE components, etc. The batch runtime hands each record read in an ItemReader to an ItemProcessor.
In this sample, SimpleItemReader reads PayrollInputRecord objects from a singleton bean.
SimpleItemProcessor is an ItemProcessor implementation that processes an input record and returns an output record. The batch runtime calls the ItemProcessor.processItem() method to process the records from the ItemReader.
In this sample, SimpleItemProcessor receives PayrollInputRecord objects from the batch runtime, computes the net pay, and returns a PayrollRecord to the batch runtime. The batch runtime then uses an ItemWriter to store the results.
SimpleItemWriter is an ItemWriter implementation that writes the output record to some data storage resource such as a database, a text file, or another Java EE component. The batch runtime calls the ItemWriter.writeItems() method to write the records processed by the ItemWriter.
In this sample, SimpleItemWriter stores the processed PayrollRecord objects in a singleton bean.

The sample uses the embedded JavaDB database service included with the Glassfish server.

The sample is built and deployed as a WAR file.

Key Features

This sample application demonstrates the following key features:

Defining a batch job using a job XML file.
Using the JobOperator.start() method to submit a batch job. This method returns the execution id for the job execution.
Using the JobOperator.getJobInstances() method to obtain a list of all the JobInstances for the payroll job.
Using the jobOperator.getJobExecutions(jobInstance) method to get a list of JobExecution objects.
Working with JobExecution objects:

Using the JobExecution.getJobName() method to get the job name.
Using the JobExecution.getBatchStatus() method to get the batch status of the job execution.
Using the JobExecution.getExitStatus() method to get the exit status of the job execution.
Using the JobExecution.getStartTime() method to obtain the time when the job execution started.
Using the JobExecution.getEndTime() method to obtain the time when the job execution completed.

Building, Deploying, and Running the Application

Perform the following steps to build, deploy, and run the application:

Set up your build environment and configure the application server with which the build system has to work by following the common build instructions.
samples_install_dir is the sample application base directory. Go to: samples_install_dir/javaee7/batch/joboperator-api.
Build the sample application by running the mvn package command from a command line terminal.
Deploy the sample application by running the asadmin deploy --force target/joboperator-api.war command from a command line terminal.
The front page of this sample is at http://localhost:8080/joboperator-api/PayrollJobSubmitterServlet
(The port number might vary.)
Use the mvn clean command from a command line terminal to clean up the target directory.
Undeploy the sample application by running the asadmin undeploy joboperator-api command from a command line terminal.

Troubleshooting

If you have problems when running the application, refer to the troubleshooting document.