com.norconex.jef4.status

Interface IJobStatusStore

All Superinterfaces:

com.norconex.commons.lang.config.IXMLConfigurable

All Known Implementing Classes:

FileJobStatusStore

public interface IJobStatusStore
extends com.norconex.commons.lang.config.IXMLConfigurable

Responsible for serializing and deserializing a job status.

When saving as XML, the tag name must be called "statusStore".

Author:

Pascal Essiembre

Method Summary

Modifier and Type	Method and Description
void	backup(String suiteName, String jobId, Date backupDate) Backups job progress.
IJobStatus	read(String suiteName, String jobId) Reads a job progress.
void	remove(String suiteName, String jobId) Removes job progress.
long	touch(String suiteName, String jobId) Marks the status with the current date so it shows as being active.
void	write(String suiteName, IJobStatus jobStatus) Writes a job progress.

Methods inherited from interface com.norconex.commons.lang.config.IXMLConfigurable

loadFromXML, saveToXML

Method Detail

write

void write(String suiteName,
           IJobStatus jobStatus)
    throws IOException

Writes a job progress.

Parameters:

suiteName - name space given to the job progress

jobStatus - job progress

Throws:

IOException - problem serializing job progress

read

IJobStatus read(String suiteName,
                String jobId)
         throws IOException

Reads a job progress. Implementors are required to always return a job progress (null is not allowed).

Parameters:

suiteName - name space given to the job progress

jobId - job unique identifier

Returns:

job progress

Throws:

IOException - problem deserializing job progress

remove

void remove(String suiteName,
            String jobId)
     throws IOException

Removes job progress. A removed job progress can no longer be obtained using the read(String, String) method.

Parameters:

suiteName - name space given to the job progress

jobId - unique identifier of job we want to remove status

Throws:

IOException - problem removing job progress

backup

void backup(String suiteName,
            String jobId,
            Date backupDate)
     throws IOException

Backups job progress. A backed-up job progress can no longer be obtained using the read(String, String) method.

Parameters:

suiteName - name space given to the job progress

jobId - unique identifier of job progress we want to backup

backupDate - date used to timestamp to backup

Throws:

IOException - problem backing-up job progress

touch

long touch(String suiteName,
           String jobId)
    throws IOException

Marks the status with the current date so it shows as being active.

Parameters:

suiteName - suite name

jobId - job name

Returns:

new file timestamp as an EPOC long value

Throws:

IOException - problem touching the file