org.easybatch.core.job

Class JobBuilder

java.lang.Object

org.easybatch.core.job.JobBuilder

public final class JobBuilder
extends Object

Job instance builder. This is the main entry point to configure a job.

Author:

Mahmoud Ben Hassine (mahmoud@benhassine.fr)

Constructor Summary

Constructors

Constructor and Description
JobBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
static JobBuilder	aNewJob() Create a new JobBuilder.
Job	build() Build an Easy Batch job instance.
JobReport	call() Build and call the job.
JobBuilder	dispatcher(RecordDispatcher recordDispatcher) Register a record dispatcher.
JobBuilder	filter(RecordFilter recordFilter) Register a record filter.
JobBuilder	jmxMode(boolean jmx) Activate JMX monitoring.
JobBuilder	jobListener(JobListener jobListener) Register a job listener.
JobBuilder	limit(long number) Set the limit number of records to process.
JobBuilder	mapper(RecordMapper recordMapper) Register a record mapper.
JobBuilder	marshaller(RecordMarshaller recordMarshaller) Register a record marshaller.
JobBuilder	named(String name) Set the job name.
JobBuilder	pipelineListener(PipelineListener pipelineListener) Register a pipeline listener.
JobBuilder	processor(RecordProcessor recordProcessor) Register a record processor.
JobBuilder	reader(RecordReader recordReader) Register a record reader.
JobBuilder	reader(RecordReader recordReader, boolean keepAlive) Register a record reader.
JobBuilder	readerListener(RecordReaderListener recordReaderListener) Register a record reader listener.
JobBuilder	silentMode(boolean silentMode) Parameter to mute all loggers.
JobBuilder	skip(long number) Set the number of records to skip.
JobBuilder	strictMode(boolean strictMode) Enable strict mode : if true, then the execution will be aborted on first processing error.
JobBuilder	timeout(long timeout) Set the timeout after which the job should be aborted.
JobBuilder	timeout(long timeout, TimeUnit unit) Set the timeout after which the job should be aborted.
JobBuilder	validator(RecordValidator recordValidator) Register a record validator.
JobBuilder	writer(RecordWriter recordWriter) Register a record writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobBuilder

public JobBuilder()

Method Detail

aNewJob

public static JobBuilder aNewJob()

Create a new JobBuilder.

Returns:

a new job builder.

named

public JobBuilder named(String name)

Set the job name.

Parameters:

name - the job name

Returns:

the job builder

skip

public JobBuilder skip(long number)

Set the number of records to skip.

Parameters:

number - the number of records to skip

Returns:

the job builder

limit

public JobBuilder limit(long number)

Set the limit number of records to process.

Parameters:

number - the limit number of records to process

Returns:

the job builder

timeout

public JobBuilder timeout(long timeout)

Set the timeout after which the job should be aborted.

Parameters:

timeout - the timeout value in milliseconds

Returns:

the job builder

timeout

public JobBuilder timeout(long timeout,
                 TimeUnit unit)

Set the timeout after which the job should be aborted.

Parameters:

timeout - the timeout value

unit - the time unit

Returns:

the job builder

reader

public JobBuilder reader(RecordReader recordReader)

Register a record reader.

Parameters:

recordReader - the record reader to register

Returns:

the job builder

reader

public JobBuilder reader(RecordReader recordReader,
                boolean keepAlive)

Register a record reader.

Parameters:

recordReader - the record reader to register

keepAlive - true if the reader should NOT be closed

Returns:

the job builder

filter

public JobBuilder filter(RecordFilter recordFilter)

Register a record filter.

Parameters:

recordFilter - the record filter to register

Returns:

the job builder

mapper

public JobBuilder mapper(RecordMapper recordMapper)

Register a record mapper.

Parameters:

recordMapper - the record mapper to register

Returns:

the job builder

validator

public JobBuilder validator(RecordValidator recordValidator)

Register a record validator.

Parameters:

recordValidator - the record validator to register

Returns:

the job builder

processor

public JobBuilder processor(RecordProcessor recordProcessor)

Register a record processor.

Parameters:

recordProcessor - the record processor to register

Returns:

the job builder

marshaller

public JobBuilder marshaller(RecordMarshaller recordMarshaller)

Register a record marshaller.

Parameters:

recordMarshaller - the record marshaller to register

Returns:

the job builder

writer

public JobBuilder writer(RecordWriter recordWriter)

Register a record writer.

Parameters:

recordWriter - the record writer to register

Returns:

the job builder

dispatcher

public JobBuilder dispatcher(RecordDispatcher recordDispatcher)

Register a record dispatcher.

Parameters:

recordDispatcher - the record dispatcher to register

Returns:

the job builder

strictMode

public JobBuilder strictMode(boolean strictMode)

Enable strict mode : if true, then the execution will be aborted on first processing error.

Parameters:

strictMode - true if strict mode should be enabled

Returns:

the job builder

silentMode

public JobBuilder silentMode(boolean silentMode)

Parameter to mute all loggers.

Parameters:

silentMode - true to enable silent mode

Returns:

the job builder

jmxMode

public JobBuilder jmxMode(boolean jmx)

Activate JMX monitoring.

Parameters:

jmx - true to enable jmx monitoring

Returns:

the job builder

jobListener

public JobBuilder jobListener(JobListener jobListener)

Register a job listener. See JobListener for available callback methods.

Parameters:

jobListener - The job listener to add.

Returns:

the job builder

readerListener

public JobBuilder readerListener(RecordReaderListener recordReaderListener)

Register a record reader listener. See RecordReaderListener for available callback methods.

Parameters:

recordReaderListener - The record reader listener to add.

Returns:

the job builder

pipelineListener

public JobBuilder pipelineListener(PipelineListener pipelineListener)

Register a pipeline listener. See PipelineListener for available callback methods.

Parameters:

pipelineListener - The pipeline listener to add.

Returns:

the job builder

build

public Job build()

Build an Easy Batch job instance.

Returns:

an Easy Batch job instance

call

public JobReport call()

Build and call the job.

Returns:

job execution report