net.sf.appstatus.core.batch

Class AbstractBatchProgressMonitor

java.lang.Object

net.sf.appstatus.core.batch.AbstractBatchProgressMonitor

All Implemented Interfaces:

IBatchProgressMonitor, IBatchProgressMonitorExt

Direct Known Subclasses:

InProcessBatchProgressMonitor, JdbcBatchProgressMonitor

public abstract class AbstractBatchProgressMonitor
extends Object
implements IBatchProgressMonitorExt

Log job progress agent.

Author:

Guillaume Mary, Nicolas Richeton

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AbstractBatchProgressMonitor>	currentChildren
protected Object	currentItem Current item being processed
protected boolean	done
protected Long	endTime
protected String	executionId
protected long	itemCount
protected AbstractBatchProgressMonitor	parent
protected List<String>	rejectedItems
protected long	startTime
protected List<String>	successItems
protected String	taskName Name of the task, set with beginTask Init to null : cannot be set multiple times. beginTask will fail if taskName is not null.
protected int	totalWork
protected int	worked

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

UNKNOW

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractBatchProgressMonitor(String executionId, IBatch batch) Constructor used for main monitor.
protected	AbstractBatchProgressMonitor(String executionId, IBatchProgressMonitor parent, int parentWork, IBatch batch) Protected constructor used to create a sub task.

Method Summary

Methods

Modifier and Type	Method and Description
void	beginTask(String name, String description, int totalWork) Begin a task execution.
IBatchProgressMonitor	createSubTask(int work) Create a sub task of this task with the amount of work the subtask execution will done.
void	done() Set the task is done.
protected void	endBatch(boolean success)
protected void	endTask(boolean success)
void	fail(String reason) Report global failure.
void	fail(String reason, Throwable t) Report global failure.
IBatch	getBatch()
Object	getCurrentItem()
protected Date	getEndDate() Returns end date is the task is finished, or an estimate if task is still running.
long	getItemCount()
String	getLastMessage()
Date	getLastUpdate()
protected org.slf4j.Logger	getLogger()
protected AbstractBatchProgressMonitor	getMainMonitor() Get the top parent.
protected int	getParentWork()
float	getProgress() Get current progress.
List<String>	getRejectedItems() Get the list of rejected items.
protected Date	getStartDate()
String	getTaskDescription()
String	getTaskGroup()
String	getTaskName()
int	getTotalWork() Retrieve the total amount of work for this task.
long	getWritingDelay()
boolean	isCancelRequested() Returns true if cancel has been requested for the current job, usually from a control UI.
boolean	isDone()
boolean	isSuccess()
void	message(String message) Send a message during the task execution.
protected abstract 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.
void	setLogger(org.slf4j.Logger loggerParam) Set the logger to use for the current batch.
void	setTotalWork(int totalWork)
void	setWritingDelay(long writingDelay) Set the writing delay.
protected void	touch() Updated 'lastUpdate' value.
void	worked(int work) Notify the processing of items.

Methods inherited from class java.lang.Object

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

Field Detail

currentChildren

protected List<AbstractBatchProgressMonitor> currentChildren

currentItem

protected Object currentItem

Current item being processed

done

protected boolean done

endTime

protected Long endTime

executionId

protected final String executionId

itemCount

protected long itemCount

parent

protected AbstractBatchProgressMonitor parent

rejectedItems

protected final List<String> rejectedItems

startTime

protected long startTime

successItems

protected final List<String> successItems

taskName

protected String taskName

Name of the task, set with beginTask

Init to null : cannot be set multiple times. beginTask will fail if taskName is not null.

totalWork

protected int totalWork

worked

protected int worked

Constructor Detail

AbstractBatchProgressMonitor

public AbstractBatchProgressMonitor(String executionId,
                            IBatch batch)

Constructor used for main monitor.

Parameters:

executionId - job execution id

AbstractBatchProgressMonitor

protected AbstractBatchProgressMonitor(String executionId,
                            IBatchProgressMonitor parent,
                            int parentWork,
                            IBatch batch)

Protected constructor used to create a sub task.

Parameters:

executionId - execution id

parent - parent monitor

parentWork - parent amount of work

Method Detail

beginTask

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

Begin a task execution.

Specified by:

beginTask in interface IBatchProgressMonitor

Parameters:

name - task name

description - task description

totalWork - task amount of work to be done

createSubTask

public IBatchProgressMonitor createSubTask(int work)

Create a sub task of this task with the amount of work the subtask execution will done.

Specified by:

createSubTask in interface IBatchProgressMonitor

Parameters:

work - work units of the task done by the subtask

Returns:

sub task progress monitor

done

public void done()

Set the task is done.

Specified by:

done in interface IBatchProgressMonitor

endBatch

protected void endBatch(boolean success)

endTask

protected void endTask(boolean success)

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

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

t - Exception which caused the failure.

getBatch

public IBatch getBatch()

getCurrentItem

public Object getCurrentItem()

getEndDate

protected Date getEndDate()

Returns end date is the task is finished, or an estimate if task is still running.

Returns:

getItemCount

public long getItemCount()

Specified by:

getItemCount in interface IBatchProgressMonitorExt

getLastMessage

public String getLastMessage()

Specified by:

getLastMessage in interface IBatchProgressMonitorExt

getLastUpdate

public Date getLastUpdate()

Specified by:

getLastUpdate in interface IBatchProgressMonitor

getLogger

protected org.slf4j.Logger getLogger()

getMainMonitor

protected AbstractBatchProgressMonitor getMainMonitor()

Get the top parent.

Returns:

getParentWork

protected int getParentWork()

getProgress

public float getProgress()

Description copied from interface: IBatchProgressMonitorExt

Get current progress.

Specified by:

getProgress in interface IBatchProgressMonitorExt

Returns:

can be UNKOWN ( or a float value between 0 (no progress) and the number of steps of the main monitor (finished)

getRejectedItems

public List<String> getRejectedItems()

Get the list of rejected items.

Returns:

empty list or list of rejected items.

getStartDate

protected Date getStartDate()

getTaskDescription

public String getTaskDescription()

getTaskGroup

public String getTaskGroup()

getTaskName

public String getTaskName()

getTotalWork

public int getTotalWork()

Retrieve the total amount of work for this task.

Specified by:

getTotalWork in interface IBatchProgressMonitor

Specified by:

getTotalWork in interface IBatchProgressMonitorExt

Returns:

the total amount of work

getWritingDelay

public long getWritingDelay()

isCancelRequested

public boolean isCancelRequested()

Description copied from interface: IBatchProgressMonitor

Returns true if cancel has been requested for the current job, usually from a control UI.

Specified by:

isCancelRequested in interface IBatchProgressMonitor

Returns:

isDone

public boolean isDone()

isSuccess

public boolean isSuccess()

message

public void message(String message)

Send a message during the task execution.

Specified by:

message in interface IBatchProgressMonitor

Parameters:

message - message

newInstance

protected abstract IBatchProgressMonitor newInstance(int work)

onBatchEnd

protected void onBatchEnd()

reject

public void reject(String itemId,
          String reason)

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

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 itemId,
          String reason,
          Throwable e)

* Reject one item during the task processing.

Specified by:

reject in interface IBatchProgressMonitor

e - Exception

See Also:

IBatchProgressMonitor.reject(String, String)

reject

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

Reject a set of items during the task processing.

Specified by:

reject in interface IBatchProgressMonitor

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)

Reject a set of items during the task processing.

Specified by:

reject in interface IBatchProgressMonitor

e - Exception

See Also:

IBatchProgressMonitor.reject(String, String)

setCurrentItem

public void setCurrentItem(Object item)

Set the current item which is being processed.

Specified by:

setCurrentItem in interface IBatchProgressMonitor

Parameters:

item - current processed item

setLogger

public void setLogger(org.slf4j.Logger loggerParam)

Description copied from interface: IBatchProgressMonitor

Set the logger to use for the current batch.

Specified by:

setLogger in interface IBatchProgressMonitor

setTotalWork

public void setTotalWork(int totalWork)

setWritingDelay

public void setWritingDelay(long writingDelay)

Set the writing delay.

Parameters:

writingDelay - writing delay

touch

protected void touch()

Updated 'lastUpdate' value.

worked

public void worked(int work)

Notify the processing of items.

Specified by:

worked in interface IBatchProgressMonitor

Parameters:

work - items processed