com.norconex.jef.progress
Interface IJobProgressSerializer

All Known Implementing Classes:
JobProgressPropertiesFileSerializer

public interface IJobProgressSerializer

Responsible for serializing a job progress.

Author:
Pascal Essiembre

Method Summary
 void backup(String namespace, String jobId, Date backupDate)
          Backups job progress.
 JobProgress deserialize(String namespace, String jobId, IJobContext jobContext)
          Deserializes a job progress.
 void remove(String namespace, String jobId)
          Removes job progress.
 void serialize(String namespace, IJobStatus jobProgress)
          Serializes a job progress.
 

Method Detail

serialize

void serialize(String namespace,
               IJobStatus jobProgress)
               throws IOException
Serializes a job progress.

Parameters:
namespace - name space given to the job progress
jobProgress - job progress
Throws:
IOException - problem serializing job progress

deserialize

JobProgress deserialize(String namespace,
                        String jobId,
                        IJobContext jobContext)
                        throws IOException
Deserializes a job progress. Implementors are required to always return a job progress (null is not allowed).

Parameters:
namespace - name space given to the job progress
jobId - job unique identifier
jobContext - job context for which to obtain job progress
Returns:
job progress
Throws:
IOException - problem deserializing job progress

remove

void remove(String namespace,
            String jobId)
            throws IOException
Removes job progress. A removed job progress can no longer be obtained using the deserialize(String, String, IJobContext) method.

Parameters:
namespace - 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 namespace,
            String jobId,
            Date backupDate)
            throws IOException
Backups job progress. A backed-up job progress can no longer be obtained using the deserialize(String, String, IJobContext) method.

Parameters:
namespace - 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


Copyright © 2007-2013 Norconex Inc.. All Rights Reserved.