README.md

JBeret is an implementation of JSR 352 (Batch Applications for the Java Platform). It is also included in WildFly, the new and improved JBoss Application Server to provide portable batch processing support in Java EE environment.

####Build JBeret To build and run default set of tests:

mvn install

Some tests require additional steps and thus are not included in the default run. For instance, MongoDB-related tests need to start MongoDB first. To build and run all tests:

# start MongoDB database
mongod

# build JBeret, activate allTests maven profile to run all tests
mvn install -DallTests

Some tests involves very large data set (e.g., over 1 million rows of CSV or Excel data), and may cause memory errors in some machines:

OutOfMemoryError: unable to create new native thread

Increase ulimit to avoid such errors. For example,

ulimit -u 2048

####Sub-modules:

• jberet-core: core batch runtime engine
• jberet-se: impl classes specific to Java SE runtime environment
• jberet-support: a collection of reusable batch readers and writers (e.g., CSV, fixed length, Excel, Json, XML, Mongo, JDBC, JMS, HornetQ, etc) for batch applications, and JNDI support
• jberet-distribution: produces a zip distribution for Java SE
• jberet-jpa-repository: batch job repository implemented with JPA (incomplete)
• test-apps: test applications
• tck-porting-impl: support running JSR 352 TCK with JBeret in Java SE

####3rd-party & Community Extensions:

• jberet-eap6
• jberetweb, job repository viewer
• jBatch Suite, Visual Modeling

####Project Resources:

• JBeret Issues & Bugs
• JBeret Documentation
• JBeret-dev Mailing List
• WildFly Forum
• JBeret Forum
• JSR 352 Expert Group Discussion
• JBoss Batch API project
• Download JBeret jars and distro zip from JBoss.org nexus
• Additional JBeret project info on ohloh Open HUB

####Batch sample & test applications:

• https://github.com/chengfang/wildfly-samples/tree/master/jberet, web apps that demonstrate the following:
  • JsonItemReader, JsonItemWriter
  • CsvItemReader, CsvItemWriter
  • XmlItemReader, XmlItemWriter
  • MongoItemReader, MongoItemWriter
  • JNDI lookup of Jackson JsonFactory, MappingJsonFactory & XmlFactory in WildFly for batch reader and writer
  • JNDI lookup of MongoClient in WildFly
  • job xml files showing the use of various reader/writer configuration properties
  • jberet-support module can be installed in WildFly and referenced by multiple apps via either MANIFEST.MF or jboss-deployment-structure.xml
• https://github.com/jberet/jsr352/tree/master/jberet-support/src/test
  • comprehensive tests for implemented batch readers and writers
• https://github.com/jberet/jsr352/tree/master/test-apps
  • test apps running in Java SE environment to verify core batch requirements
  • test apps running in Java SE environment to verify additional JBeret features (inheritance, scripting support, etc)

####How to reference org.jberet artifacts in maven pom.xml jboss-public-repository-group JBoss Public Repository Group http://repository.jboss.org/nexus/content/groups/public/ ... org.jboss.spec.javax.batch jboss-batch-api_1.0_spec 1.0.0.Final org.jberet jberet-core 1.0.2.Final org.jberet jberet-support 1.0.2.Final

####Batch application dependencies #####Minimal application dependencies: org.jboss.spec.javax.batch jboss-batch-api_1.0_spec javax.inject javax.inject javax.enterprise cdi-api org.jboss.spec.javax.transaction jboss-transaction-api_1.2_spec org.jberet jberet-core org.jboss.marshalling jboss-marshalling org.jboss.logging jboss-logging org.jboss.weld weld-core com.google.guava guava

A note on webapp or Java EE application packaging: Java EE API jars (batch-api, cdi-api, javax.inject, transaction-api) are already available in the appserver, and should not be included in WAR, JAR, or EAR files. Their maven dependency scope should be set to provided.

#####The following is also required for Java SE batch applications (h2 can be omitted when using in-memory batch job repository): org.jberet jberet-se org.jboss.weld.se weld-se com.h2database h2

#####Optional application dependencies: com.h2database h2

    <!-- For Weld 2.2.2.Final or later, Jandex is required for annotation processing -->
    <dependency>
        <groupId>org.jboss</groupId>
        <artifactId>jandex</artifactId>
    </dependency>
    
    <!-- replace Java built-in StAX provider with aalto-xml or woodstox
         (woodstox dependencies not shown here)
    -->
    <dependency>
        <groupId>com.fasterxml</groupId>
        <artifactId>aalto-xml</artifactId>
    </dependency>
    <dependency>
        <groupId>org.codehaus.woodstox</groupId>
        <artifactId>stax2-api</artifactId>
    </dependency>
    
    <!-- jberet-support includes common reusable batch ItemReader & ItemWriter classes for
         various data types such as CSV, XML, JSON, Fixed length, Excel, MongoDB, JDBC, JMS, HornetQ, etc.
         The application should further provide appropriate transitive dependencies from 
         jberet-support, depending on its usage.
    -->
    <dependency>
        <groupId>org.jberet</groupId>
        <artifactId>jberet-support</artifactId>
    </dependency>