org.jberet.job.model

Class JobBuilder

java.lang.Object

org.jberet.job.model.JobBuilder

public final class JobBuilder
extends Object

Builder class for building a single job. After the job is built, the same JobBuilder instance should not be reused to build another job.

Unlike XML JSL, jobs built programmatically with this builder and other related builder classes do not support JSL inheritance, nor artifacts written in scripting languages.

This class does not support multi-threaded access or modification. Usage example,

     Job job = new JobBuilder(jobName)
              .restartable(false)
              .property("jobk1", "J")
              .property("jobk2", "J")
              .listener("jobListener1", new String[]{"jobListenerk1", "#{jobParameters['jobListenerPropVal']}"},
                      new String[]{"jobListenerk2", "#{jobParameters['jobListenerPropVal']}"})

              .step(new StepBuilder(stepName)
                      .properties(new String[]{"stepk1", "S"}, new String[]{"stepk2", "S"})
                      .batchlet(batchlet1Name, new String[]{"batchletk1", "B"}, new String[]{"batchletk2", "B"})
                      .listener("stepListener1", stepListenerProps)
                      .stopOn("STOP").restartFrom(stepName).exitStatus()
                      .endOn("END").exitStatus("new status for end")
                      .failOn("FAIL").exitStatus()
                      .nextOn("*").to(step2Name)
                      .build())

              .step(new StepBuilder(step2Name)
                      .batchlet(batchlet1Name)
                      .build())

              .build();
 

Since:

1.2.0

See Also:

StepBuilder, FlowBuilder, SplitBuilder, DecisionBuilder

Constructor Summary

Constructors

Constructor and Description
JobBuilder(String id) Constructs a JobBuilder for building the job with the specified id.

Method Summary

Modifier and Type	Method and Description
Job	build() Builds the job.
JobBuilder	decision(Decision decision) Adds a decision to the job.
JobBuilder	flow(Flow flow) Adds a flow to the job.
JobBuilder	listener(String listenerRef, Properties props) Adds a job listener to the job, with listener properties.
JobBuilder	listener(String listenerRef, String[]... pairsOfKeyValue) Adds a job listener to the job.
T	properties(Properties props) Adds all properties in java.util.Properties to the current builder.
T	properties(String[]... pairsOfKeyValue) Adds 1 or multiple properties to the current builder.
T	property(String k, String v) Adds one single property to the current builder.
JobBuilder	restartable(boolean... b) Sets the restartable attribute value on the job.
JobBuilder	split(Split split) Adds a split to the job.
JobBuilder	step(Step step) Adds a step to the job.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JobBuilder

public JobBuilder(String id)

Constructs a JobBuilder for building the job with the specified id.

Parameters:

id - the job id, corresponding to the id attribute of jsl:Job element in XML

Method Detail

restartable

public JobBuilder restartable(boolean... b)

Sets the restartable attribute value on the job. This method may be invoked with 0 or 1 boolean parameter. restartable() is equivalent to restartable(true).

Parameters:

b - optional restartable value (true or false)

Returns:

this JobBuilder

listener

public JobBuilder listener(String listenerRef,
                           String[]... pairsOfKeyValue)

Adds a job listener to the job. The listener may be added with 0 or more listener properties. Each listener property is represented by a 2-element string array, whose 1st element is the property key, and 2nd element is the property value. For example,

 listener("listener1");
 listener1("listener2", new String[]{"key1", "value1"});
 listener1("listener3", new String[]{"key1", "value1"}, new String[]{"key2", "value2"});
 listener1("listener4", new String[]{"jobListenerk1", "#{jobParameters['jobListenerPropVal']}"}
 

Parameters:

listenerRef - job listener name

pairsOfKeyValue - optional listener properties in the form of a series of 2-element string arrays

Returns:

this JobBuilder

listener

public JobBuilder listener(String listenerRef,
                           Properties props)

Adds a job listener to the job, with listener properties.

Parameters:

listenerRef - job listener name

props - job listener properties, null means no properties

Returns:

this JobBuilder

step

public JobBuilder step(Step step)

Adds a step to the job. The step is typically built with StepBuilder.

Parameters:

step - a pre-built step

Returns:

this JobBuilder

decision

public JobBuilder decision(Decision decision)

Adds a decision to the job. The decision is typically built with DecisionBuilder.

Parameters:

decision - a pre-built decision

Returns:

this JobBuilder

flow

public JobBuilder flow(Flow flow)

Adds a flow to the job. The flow is typically built with FlowBuilder.

Parameters:

flow - a pre-built flow

Returns:

this JobBuilder

split

public JobBuilder split(Split split)

Adds a split to the job. The split is typically built with SplitBuilder.

Parameters:

split - a pre-built split

Returns:

this JobBuilder

build

public Job build()

Builds the job. This method also verifies the uniqueness of all id values within the job. After this method, this JobBuilder should not be used to build another job.

Returns:

a job built by this JobBuilder

property

public T property(String k,
                  String v)

Adds one single property to the current builder.

Parameters:

k - property key

v - property value

Returns:

current builder instance

properties

public T properties(Properties props)

Adds all properties in java.util.Properties to the current builder.

Parameters:

props - java.util.Properties

Returns:

current builder instance

properties

public T properties(String[]... pairsOfKeyValue)

Adds 1 or multiple properties to the current builder. The properties are represented as a series of 2-element string array, whose 1st element is property key, and 2nd element is property value. For example,

 properties(new String[]{"stepk1", "value1"}, new String[]{"stepk2", "value2"})
 

Parameters:

pairsOfKeyValue - a series of 2-element string array, whose 1st element is property key, and 2nd element is property value

Returns:

current builder instance