Package org.jppf.job.persistence.impl

Class DefaultFilePersistence

java.lang.Object

org.jppf.persistence.AbstractFilePersistence<PersistenceInfo,JobPersistenceException>

org.jppf.job.persistence.impl.DefaultFilePersistence

All Implemented Interfaces:

JobPersistence

public class DefaultFilePersistence
extends AbstractFilePersistence<PersistenceInfo,JobPersistenceException>
implements JobPersistence

A file-based persistent store for jobs. The store's structure is made of a root directory, under which there is one directory per job, named after the job's uuid. Each job directory contains:

• a file named header.data for the job header
• a file named data_provider.data for the job's data_provider
• a file named task-i.data for each task i of the job
• a file named result-i.data for each task result i received from a node

Since:

6.0

Author:

Laurent Cohen

Nested Class Summary

Nested classes/interfaces inherited from class org.jppf.persistence.AbstractFilePersistence

AbstractFilePersistence.DirectoryFilter

Field Summary

Fields inherited from class org.jppf.persistence.AbstractFilePersistence

DEFAULT_EXTENSION, rootPath, TEMP_EXTENSION

Constructor Summary

Constructors

Constructor	Description
DefaultFilePersistence()	Initialize this persistence with the root path DEFAULT_ROOT under the current user directory.
DefaultFilePersistence(String... paths)	Initialize this persistence with the specified path as root directory.

Method Summary

Modifier and Type	Method	Description
protected JobPersistenceException	convertException(Exception e)	Create the appropriate type of exception.
void	deleteJob(String jobUuid)	Delete the persisted job with the psecified UUID.
List<String>	getPersistedJobUuids()	Get the UUIDs of all persisted job.
int[]	getTaskPositions(String jobUuid)	Get the positions of all the tasks in the specified job.
int[]	getTaskResultPositions(String jobUuid)	Get the positions of all the task results in the specified job.
boolean	isJobPersisted(String jobUuid)	Determine whether a job is persisted, that is, present in the persistence store.
List<InputStream>	load(Collection<PersistenceInfo> infos)	Load the specified job elements.
void	store(Collection<PersistenceInfo> infos)	In this implementation, job elements are first stored in a temporary file, then moved to a "normal" file once the atomic store operation is complete.

Methods inherited from class org.jppf.persistence.AbstractFilePersistence

checkDirectory, deleteIfEmpty, getSubDir, isSameFile, pathname, toString

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultFilePersistence

public DefaultFilePersistence()

Initialize this persistence with the root path DEFAULT_ROOT under the current user directory.

DefaultFilePersistence

public DefaultFilePersistence(String... paths)

Initialize this persistence with the specified path as root directory.

Parameters:

paths - the root directory for this persistence.

Method Details

store

public void store(Collection<PersistenceInfo> infos)
           throws JobPersistenceException

In this implementation, job elements are first stored in a temporary file, then moved to a "normal" file once the atomic store operation is complete. This addresses the situation where the store operation is interrupted (because the driver dies or any other reason) and would leave an incomplete or corrupted file.

Specified by:

store in interface JobPersistence

Parameters:

infos - collection of information objects on the job elements to store.

Throws:

JobPersistenceException - if any erorr occurs during the persistence operation.

load

public List<InputStream> load(Collection<PersistenceInfo> infos)
                       throws JobPersistenceException

Description copied from interface: JobPersistence

Load the specified job elements. All elements are assumed to be part of the same job.

Specified by:

load in interface JobPersistence

Parameters:

infos - information on the persisted job elements to load.

Returns:

an input stream providing the serialized job header.

Throws:

JobPersistenceException - if any erorr occurs during the persistence operation.

getPersistedJobUuids

public List<String> getPersistedJobUuids()
                                  throws JobPersistenceException

Description copied from interface: JobPersistence

Get the UUIDs of all persisted job.

Specified by:

getPersistedJobUuids in interface JobPersistence

Returns:

a list of strings reprensenting job UUIDs.

Throws:

JobPersistenceException - if any erorr occurs during the persistence operation.

getTaskPositions

public int[] getTaskPositions(String jobUuid)
                       throws JobPersistenceException

Description copied from interface: JobPersistence

Get the positions of all the tasks in the specified job.

Specified by:

getTaskPositions in interface JobPersistence

Parameters:

jobUuid - the uuid of the job for which to find the task positions.

Returns:

an array of int representing the positions.

Throws:

JobPersistenceException - if any erorr occurs during the persistence operation.

getTaskResultPositions

public int[] getTaskResultPositions(String jobUuid)
                             throws JobPersistenceException

Description copied from interface: JobPersistence

Get the positions of all the task results in the specified job.

Specified by:

getTaskResultPositions in interface JobPersistence

Parameters:

jobUuid - the uuid of the job for which to find the task result positions.

Returns:

an array of int representing the positions.

Throws:

JobPersistenceException - if any erorr occurs during the persistence operation.

deleteJob

public void deleteJob(String jobUuid)
               throws JobPersistenceException

Description copied from interface: JobPersistence

Delete the persisted job with the psecified UUID.

Specified by:

deleteJob in interface JobPersistence

Parameters:

jobUuid - the UUID of the job to load.

Throws:

JobPersistenceException - if any erorr occurs during the persistence operation.

isJobPersisted

public boolean isJobPersisted(String jobUuid)
                       throws JobPersistenceException

Description copied from interface: JobPersistence

Determine whether a job is persisted, that is, present in the persistence store.

Specified by:

isJobPersisted in interface JobPersistence

Parameters:

jobUuid - the UUID of the job to check.

Returns:

true if the job is in the persistence store, false otherwise.

Throws:

JobPersistenceException - if any error occurs while accessing the persistence store.

convertException

protected JobPersistenceException convertException(Exception e)

Description copied from class: AbstractFilePersistence

Create the appropriate type of exception.

Specified by:

convertException in class AbstractFilePersistence<PersistenceInfo,JobPersistenceException>

Parameters:

e - the actual exception from which to create the new one.

Returns:

an exception of type E.