ca.eandb.jdcp.job

Class AbstractParallelizableJob

java.lang.Object

ca.eandb.jdcp.job.AbstractParallelizableJob

All Implemented Interfaces:

ParallelizableJob, Serializable

Direct Known Subclasses:

DiagnosticJob, DummyParallelizableJob, ExceptionTestJob

public abstract class AbstractParallelizableJob
extends Object
implements ParallelizableJob

An abstract ParallelizableJob that provides a default implementation for the Job interface.

Author:

Brad Kimmel

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractParallelizableJob()

Method Summary

Modifier and Type	Method and Description
protected void	archiveState(ca.eandb.util.io.Archive ar) Saves or restores the state of this job from an archive.
protected FileOutputStream	createFileOutputStream(String name) Creates a FileOutputStream for a file in this job's working directory.
protected RandomAccessFile	createRandomAccessFile(String name) Creates a new RandomAccessFile in this job's working directory.
void	finish() Performs any final actions required for this ParallelizableJob.
void	initialize() Sets up this ParallelizableJob on the machine hosting the job (not necessarily the same machine as the one processing the tasks for this job).
void	restoreState(ObjectInput input) Notifies the job that it is about to be resumed after having been suspended.
void	saveState(ObjectOutput output) Notifies the job that it is about to be suspended (for example, if the server application is about to be shut down).
void	setHostService(HostService host) Sets the HostService object that provides secure access to the file system on the machine hosting this ParallelizableJob.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.eandb.jdcp.job.ParallelizableJob

getNextTask, isComplete, submitTaskResults, worker

Constructor Detail

AbstractParallelizableJob

public AbstractParallelizableJob()

Method Detail

setHostService

public final void setHostService(HostService host)

Description copied from interface: ParallelizableJob

Sets the HostService object that provides secure access to the file system on the machine hosting this ParallelizableJob.

Specified by:

setHostService in interface ParallelizableJob

Parameters:

host - The HostService to use.

initialize

public void initialize()
                throws Exception

Description copied from interface: ParallelizableJob

Sets up this ParallelizableJob on the machine hosting the job (not necessarily the same machine as the one processing the tasks for this job).

Specified by:

initialize in interface ParallelizableJob

Throws:

Exception - If an error occurs performing the operation.

finish

public void finish()
            throws Exception

Description copied from interface: ParallelizableJob

Performs any final actions required for this ParallelizableJob.

Specified by:

finish in interface ParallelizableJob

Throws:

Exception - If an error occurs performing the operation.

restoreState

public void restoreState(ObjectInput input)
                  throws Exception

Description copied from interface: ParallelizableJob

Notifies the job that it is about to be resumed after having been suspended. The job should reinstate any transient data (e.g., open files).

Specified by:

restoreState in interface ParallelizableJob

Parameters:

input - The ObjectInput to restore state from.

Throws:

Exception - If an error occurs performing the operation.

saveState

public void saveState(ObjectOutput output)
               throws Exception

Description copied from interface: ParallelizableJob

Notifies the job that it is about to be suspended (for example, if the server application is about to be shut down).

Specified by:

saveState in interface ParallelizableJob

Parameters:

output - The ObjectOutput to save state to.

Throws:

Exception - If an error occurs performing the operation.

archiveState

protected void archiveState(ca.eandb.util.io.Archive ar)
                     throws Exception

Saves or restores the state of this job from an archive.

Parameters:

ar - The Archive to read from or write to.

Throws:

Exception - If the operation fails.

createFileOutputStream

protected FileOutputStream createFileOutputStream(String name)

Creates a FileOutputStream for a file in this job's working directory.

Parameters:

name - The relative path to the file.

Returns:

The new FileOutputStream.

See Also:

HostService.createFileOutputStream(java.lang.String)

createRandomAccessFile

protected RandomAccessFile createRandomAccessFile(String name)

Creates a new RandomAccessFile in this job's working directory.

Parameters:

name - The relative path to the new file.

Returns:

The new RandomAccessFile.

See Also:

HostService.createRandomAccessFile(java.lang.String)