net.sf.appstatus.batch.jdbc

Class JdbcBatchProgressMonitor

java.lang.Object

net.sf.appstatus.core.batch.AbstractBatchProgressMonitor

net.sf.appstatus.batch.jdbc.JdbcBatchProgressMonitor

All Implemented Interfaces:

IBatchProgressMonitor, IBatchProgressMonitorExt

public class JdbcBatchProgressMonitor
extends AbstractBatchProgressMonitor
implements IBatchProgressMonitorExt

Log job progress agent.

Author:

Nicolas Richeton

Field Summary

Fields inherited from class net.sf.appstatus.core.batch.AbstractBatchProgressMonitor

currentChildren, currentItem, done, endTime, executionId, itemCount, parent, rejectedItems, startTime, successItems, taskName, totalWork, worked

Fields inherited from interface net.sf.appstatus.core.batch.IBatchProgressMonitor

UNKNOW

Constructor Summary

Constructors

Constructor and Description
JdbcBatchProgressMonitor(String executionId, IBatch batch, BatchDao bachDao) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	beginTask(String name, String description, int totalWork) Begin a task execution.
void	done() Set the task is done.
void	fail(String reason) Report global failure.
void	fail(String reason, Throwable t) Report global failure.
Batch	getBatch()
protected JdbcBatchProgressMonitor	getMainMonitor() Get the top parent.
protected JdbcBatchManager	getManager()
void	message(String message) Send a message during the task execution.
protected IBatchProgressMonitor	newInstance(int work)
protected void	onBatchEnd()
void	reject(String[] itemIds, String reason) Reject a set of items during the task processing.
void	reject(String[] itemIds, String reason, Throwable e) Reject a set of items during the task processing.
void	reject(String itemId, String reason) Reject one item during the task processing.
void	reject(String itemId, String reason, Throwable e) * Reject one item during the task processing.
void	setCurrentItem(Object item) Set the current item which is being processed.
protected void	setManager(JdbcBatchManager manager)
void	worked(int work) Notify the processing of items.

Methods inherited from class net.sf.appstatus.core.batch.AbstractBatchProgressMonitor

createSubTask, endBatch, endTask, getCurrentItem, getEndDate, getItemCount, getLastMessage, getLastUpdate, getLogger, getParentWork, getProgress, getRejectedItems, getStartDate, getTaskDescription, getTaskGroup, getTaskName, getTotalWork, getWritingDelay, isCancelRequested, isDone, isSuccess, setLogger, setTotalWork, setWritingDelay, touch

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.appstatus.core.batch.IBatchProgressMonitorExt

getItemCount, getLastMessage, getProgress, getTotalWork

Methods inherited from interface net.sf.appstatus.core.batch.IBatchProgressMonitor

createSubTask, getLastUpdate, isCancelRequested, setLogger

Constructor Detail

JdbcBatchProgressMonitor

public JdbcBatchProgressMonitor(String executionId,
                        IBatch batch,
                        BatchDao bachDao)

Default constructor.

Parameters:

executionId - job execution id

Method Detail

done

public void done()

Description copied from class: AbstractBatchProgressMonitor

Set the task is done.

Specified by:

done in interface IBatchProgressMonitor

Overrides:

done in class AbstractBatchProgressMonitor

fail

public void fail(String reason)

Description copied from interface: IBatchProgressMonitor

Report global failure.

Use this when the batch has issued a major error and cannot continue.

Specified by:

fail in interface IBatchProgressMonitor

Overrides:

fail in class AbstractBatchProgressMonitor

fail

public void fail(String reason,
        Throwable t)

Description copied from interface: IBatchProgressMonitor

Report global failure.

Use this when the batch has issued a major error and cannot continue.

Specified by:

fail in interface IBatchProgressMonitor

Overrides:

fail in class AbstractBatchProgressMonitor

t - Exception which caused the failure.

reject

public void reject(String itemId,
          String reason)

Description copied from class: AbstractBatchProgressMonitor

Reject one item during the task processing.

Use this when :

• Item processing has failed (exception, invalid data, connection issue ..) and a human action is probably required to before retry.
• The batch is able to go on and process other items (item processing is independent).

Specified by:

reject in interface IBatchProgressMonitor

Overrides:

reject in class AbstractBatchProgressMonitor

Parameters:

itemId - rejected item id

reason - the reason

See Also:

IBatchProgressMonitor#reject(String, String, Throwable) can be used to provide the exception which has caused the failure.

reject

public void reject(String[] itemIds,
          String reason)

Description copied from class: AbstractBatchProgressMonitor

Reject a set of items during the task processing.

Specified by:

reject in interface IBatchProgressMonitor

Overrides:

reject in class AbstractBatchProgressMonitor

Parameters:

itemIds - Array of item ids rejected

reason - the reason

See Also:

IBatchProgressMonitor.reject(String, String)

reject

public void reject(String[] itemIds,
          String reason,
          Throwable e)

Description copied from class: AbstractBatchProgressMonitor

Reject a set of items during the task processing.

Specified by:

reject in interface IBatchProgressMonitor

Overrides:

reject in class AbstractBatchProgressMonitor

e - Exception

See Also:

IBatchProgressMonitor.reject(String, String)

getBatch

public Batch getBatch()

Overrides:

getBatch in class AbstractBatchProgressMonitor

beginTask

public void beginTask(String name,
             String description,
             int totalWork)

Description copied from class: AbstractBatchProgressMonitor

Begin a task execution.

Specified by:

beginTask in interface IBatchProgressMonitor

Overrides:

beginTask in class AbstractBatchProgressMonitor

Parameters:

name - task name

description - task description

totalWork - task amount of work to be done

getMainMonitor

protected JdbcBatchProgressMonitor getMainMonitor()

Description copied from class: AbstractBatchProgressMonitor

Get the top parent.

Overrides:

getMainMonitor in class AbstractBatchProgressMonitor

Returns:

message

public void message(String message)

Description copied from class: AbstractBatchProgressMonitor

Send a message during the task execution.

Specified by:

message in interface IBatchProgressMonitor

Overrides:

message in class AbstractBatchProgressMonitor

Parameters:

message - message

newInstance

protected IBatchProgressMonitor newInstance(int work)

Specified by:

newInstance in class AbstractBatchProgressMonitor

reject

public void reject(String itemId,
          String reason,
          Throwable e)

Description copied from class: AbstractBatchProgressMonitor

* Reject one item during the task processing.

Specified by:

reject in interface IBatchProgressMonitor

Overrides:

reject in class AbstractBatchProgressMonitor

e - Exception

See Also:

IBatchProgressMonitor.reject(String, String)

setCurrentItem

public void setCurrentItem(Object item)

Description copied from class: AbstractBatchProgressMonitor

Set the current item which is being processed.

Specified by:

setCurrentItem in interface IBatchProgressMonitor

Overrides:

setCurrentItem in class AbstractBatchProgressMonitor

Parameters:

item - current processed item

onBatchEnd

protected void onBatchEnd()

Overrides:

onBatchEnd in class AbstractBatchProgressMonitor

worked

public void worked(int work)

Notify the processing of items.

Specified by:

worked in interface IBatchProgressMonitor

Overrides:

worked in class AbstractBatchProgressMonitor

Parameters:

work - items processed

setManager

protected void setManager(JdbcBatchManager manager)

getManager

protected JdbcBatchManager getManager()