com.norconex.jef4.status

Class FileJobStatusStore

java.lang.Object

com.norconex.jef4.status.FileJobStatusStore

All Implemented Interfaces:

com.norconex.commons.lang.config.IXMLConfigurable, IJobStatusStore

public class FileJobStatusStore
extends Object
implements IJobStatusStore

File-based status store. The created file name matches the job id, plus the ".job" extension. If no status directory is explicitly set, it defaults to: <user.home>/Norconex/jef/workdir

XML configuration usage:

  <statusStore class="com.norconex.jef4.status.FileJobStatusStore">
      <statusDir>(directory where to store status files)</statusDir>
  </statusStore>
 

Usage example:

The following example indicates status files should be stored in this directory: /tmp/jefstatuses

  <statusStore class="com.norconex.jef4.status.FileJobStatusStore">
      <statusDir>/tmp/jefstatuses</statusDir>
  </statusStore>
 

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
FileJobStatusStore()
FileJobStatusStore(String statusDir) Creates a file-based job status serializer storing files in the given job directory.

Method Summary

Modifier and Type	Method and Description
void	backup(String suiteName, String jobId, Date backupDate) Backups job progress.
boolean	equals(Object other)
String	getStatusDirectory()
int	hashCode()
void	loadFromXML(Reader in)
IJobStatus	read(String suiteName, String jobId) Reads a job progress.
void	remove(String suiteName, String jobId) Removes job progress.
void	saveToXML(Writer out)
void	setStatusDirectory(String statusDirectory)
String	toString()
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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FileJobStatusStore

public FileJobStatusStore()

FileJobStatusStore

public FileJobStatusStore(String statusDir)

Creates a file-based job status serializer storing files in the given job directory.

Parameters:

statusDir - the base directory where to serialize the job status

Method Detail

getStatusDirectory

public String getStatusDirectory()

setStatusDirectory

public void setStatusDirectory(String statusDirectory)

write

public final void write(String suiteName,
                        IJobStatus jobStatus)
                 throws IOException

Description copied from interface: IJobStatusStore

Writes a job progress.

Specified by:

write in interface IJobStatusStore

Parameters:

suiteName - name space given to the job progress

jobStatus - job progress

Throws:

IOException - problem serializing job progress

read

public final IJobStatus read(String suiteName,
                             String jobId)
                      throws IOException

Description copied from interface: IJobStatusStore

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

Specified by:

read in interface IJobStatusStore

Parameters:

suiteName - name space given to the job progress

jobId - job unique identifier

Returns:

job progress

Throws:

IOException - problem deserializing job progress

remove

public final void remove(String suiteName,
                         String jobId)
                  throws IOException

Description copied from interface: IJobStatusStore

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

Specified by:

remove in interface IJobStatusStore

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

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

Description copied from interface: IJobStatusStore

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

Specified by:

backup in interface IJobStatusStore

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

public long touch(String suiteName,
                  String jobId)
           throws IOException

Description copied from interface: IJobStatusStore

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

Specified by:

touch in interface IJobStatusStore

Parameters:

suiteName - suite name

jobId - job name

Returns:

new file timestamp as an EPOC long value

Throws:

IOException - problem touching the file

loadFromXML

public void loadFromXML(Reader in)
                 throws IOException

Specified by:

loadFromXML in interface com.norconex.commons.lang.config.IXMLConfigurable

Throws:

IOException

saveToXML

public void saveToXML(Writer out)
               throws IOException

Specified by:

saveToXML in interface com.norconex.commons.lang.config.IXMLConfigurable

Throws:

IOException

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object