net.sf.appstatus.core.batch

Interface IBatchProgressMonitor

All Known Subinterfaces:

IBatchProgressMonitorExt

All Known Implementing Classes:

AbstractBatchProgressMonitor, InProcessBatchProgressMonitor, JdbcBatchProgressMonitor

public interface IBatchProgressMonitor

Monitor dedicated to monitor a job execution.

Usage :

IBatchProgressMonitor monitor, getBatchProgressMonitor("name", "group", "uuid");

// get item list
monitor.beginTask( "taskName", "taskDescr", 2 );
monitor.setCurrentItem( "1" ) ;

// Do some work on item 1;

monitor.worked(1);
monitor.setCurrentItem( "2" ) ;

// Do some work on item 2;

monitor.worked(1);
monitor.done();

Author:

Guillaume Mary, Nicolas Richeton

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNKNOW Unknown amount of work.

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.
void	fail(String reason) Report global failure.
void	fail(String reason, Throwable t) Report global failure.
Date	getLastUpdate()
int	getTotalWork() Retrieve the total amount of work for this task.
boolean	isCancelRequested() Returns true if cancel has been requested for the current job, usually from a control UI.
void	message(String message) Send a message during the task execution.
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 logger) Set the logger to use for the current batch.
void	worked(int work) Notify the processing of items.

Field Detail

UNKNOW

static final int UNKNOW

Unknown amount of work.

See Also:

Constant Field Values

Method Detail

beginTask

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

Begin a task execution.

Parameters:

name - task name

description - task description

totalWork - task amount of work to be done

createSubTask

IBatchProgressMonitor createSubTask(int work)

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

Parameters:

work - work units of the task done by the subtask

Returns:

sub task progress monitor

done

void done()

Set the task is done.

fail

void fail(String reason)

Report global failure.

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

Parameters:

reason -

fail

void fail(String reason,
        Throwable t)

Report global failure.

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

Parameters:

reason -

t - Exception which caused the failure.

getLastUpdate

Date getLastUpdate()

getTotalWork

int getTotalWork()

Retrieve the total amount of work for this task.

Returns:

the total amount of work

isCancelRequested

boolean isCancelRequested()

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

Returns:

message

void message(String message)

Send a message during the task execution.

Parameters:

message - message

reject

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).

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

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

* Reject one item during the task processing.

Parameters:

itemId -

reason -

e - Exception

See Also:

reject(String, String)

reject

void reject(String[] itemIds,
          String reason)

Reject a set of items during the task processing.

Parameters:

itemIds - Array of item ids rejected

reason - the reason

See Also:

reject(String, String)

reject

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

Reject a set of items during the task processing.

Parameters:

itemIds -

reason -

e - Exception

See Also:

reject(String, String)

setCurrentItem

void setCurrentItem(Object item)

Set the current item which is being processed.

Parameters:

item - current processed item

setLogger

void setLogger(org.slf4j.Logger logger)

Set the logger to use for the current batch.

Parameters:

logger -

worked

void worked(int work)

Notify the processing of items.

Parameters:

work - items processed