Package org.jppf.client.persistence

Class DefaultFilePersistenceManager

java.lang.Object

org.jppf.client.persistence.DefaultFilePersistenceManager

All Implemented Interfaces:

JobPersistence<String>

public class DefaultFilePersistenceManager
extends Object
implements JobPersistence<String>

This implementation of JobPersistence stores jobs on the file system using Java serialization to a file for each job, and uses the jobs uuids as keys to retrieve them.

The underlying datastore is a file folder with a flat structure, where each file represents a serialized job.

This implementation will use the serialisation scheme, if any, that is configured for the JPPF client.

Note that this implementation is very naive and has a sub-optimal performance, as it stores jobs data in a synchronous, blocking way.

Author:

Laurent Cohen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_EXT	The default extension for the files in the store.
static final String	DEFAULT_PREFIX	The default prefix for the files in the store.

Constructor Summary

Constructors

Constructor	Description
DefaultFilePersistenceManager(File root)	Initialize this persistence manager with the specified root path, using DEFAULT_PREFIX as the files prefix and DEFAULT_EXT as the extension.
DefaultFilePersistenceManager(File root, String prefix, String ext)	Initialize this persistence manager with the specified root path, file prefix and extension.
DefaultFilePersistenceManager(String root)	Initialize this persistence manager with the specified root path, using "job" as the files prefix and ".ser" as the extension.
DefaultFilePersistenceManager(String root, String prefix, String ext)	Initialize this persistence manager with the specified root path.

Method Summary

Modifier and Type	Method	Description
Collection<String>	allKeys()	Get the keys of all jobs in the persistence store.
void	close()	Close this store and release any used resources.
String	computeKey(JPPFJob job)	Compute the key assigned ot the specified job.
void	deleteJob(String key)	Delete the job with the specified key from the persistence store.
JPPFJob	loadJob(String key)	Load a job from the persistence store given its key.
void	storeJob(String key, JPPFJob job, List<org.jppf.node.protocol.Task<?>> tasks)	Store the specified job.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PREFIX

public static final String DEFAULT_PREFIX

The default prefix for the files in the store.

See Also:

• Constant Field Values

DEFAULT_EXT

public static final String DEFAULT_EXT

The default extension for the files in the store.

See Also:

• Constant Field Values

Constructor Details

DefaultFilePersistenceManager

public DefaultFilePersistenceManager(File root)

Initialize this persistence manager with the specified root path, using DEFAULT_PREFIX as the files prefix and DEFAULT_EXT as the extension. If the root does not exist, the persistence manager attempts to create it.

Parameters:

root - the root path for this persistence manager, where the persisted jobs are stored.

Throws:

IllegalArgumentException - if the root path is invalid or could not be created.

DefaultFilePersistenceManager

public DefaultFilePersistenceManager(File root,
 String prefix,
 String ext)

Initialize this persistence manager with the specified root path, file prefix and extension. If the root does not exist, the persistence manager attempts to create it.

Parameters:

root - the root path for this persistence manager, where the persisted jobs are stored.

prefix - the prefix for the names of the files in the store.

ext - the extension for the names of the files in the store.

Throws:

IllegalArgumentException - if the root path is invalid or could not be created.

DefaultFilePersistenceManager

public DefaultFilePersistenceManager(String root)

Initialize this persistence manager with the specified root path, using "job" as the files prefix and ".ser" as the extension.

Parameters:

root - the root path for this persistence manager, where the persisted jobs are stored.

Throws:

IllegalArgumentException - if the root path is invalid or could not be created.

DefaultFilePersistenceManager

public DefaultFilePersistenceManager(String root,
 String prefix,
 String ext)

Initialize this persistence manager with the specified root path.

Parameters:

root - the root path for this persistence manager, where the persisted jobs are stored.

prefix - the prefix for the names of the files in the store.

ext - the extension for the names of the files in the store.

Throws:

IllegalArgumentException - if the root path is invalid or could not be created.

Method Details

computeKey

public String computeKey(JPPFJob job)

Compute the key assigned ot the specified job.

Specified by:

computeKey in interface JobPersistence<String>

Parameters:

job - the job for which to get a key.

Returns:

the job's UUID.

allKeys

public Collection<String> allKeys()
                           throws JobPersistenceException

Description copied from interface: JobPersistence

Get the keys of all jobs in the persistence store.

Specified by:

allKeys in interface JobPersistence<String>

Returns:

a collection of objects representing the keys.

Throws:

JobPersistenceException - if any error occurs while retrieving the keys.

loadJob

public JPPFJob loadJob(String key)
                throws JobPersistenceException

Description copied from interface: JobPersistence

Load a job from the persistence store given its key.

Specified by:

loadJob in interface JobPersistence<String>

Parameters:

key - the key allowing to locate the job in the persistence store.

Returns:

a JPPFJob instance, retrieved from the store.

Throws:

JobPersistenceException - if any error occurs while loading the job.

storeJob

public void storeJob(String key,
 JPPFJob job,
 List<org.jppf.node.protocol.Task<?>> tasks)
              throws JobPersistenceException

Store the specified job. This implementation serializes the entire job to a file, the first time it is called for a job. On subsequent calls, only the deltas are persisted.

Specified by:

storeJob in interface JobPersistence<String>

Parameters:

key - the key allowing to locate the job in the persistence store.

job - the job to store.

tasks - the newly received completed tasks, may be used to only store the delta for better performance.

Throws:

JobPersistenceException - if any error occurs while storing the job.

deleteJob

public void deleteJob(String key)
               throws JobPersistenceException

Description copied from interface: JobPersistence

Delete the job with the specified key from the persistence store.

Specified by:

deleteJob in interface JobPersistence<String>

Parameters:

key - the key allowing to locate the job in the persistence store.

Throws:

JobPersistenceException - if any error occurs while deleting the job.

toString

public String toString()

Overrides:

toString in class Object

close

public void close()

Description copied from interface: JobPersistence

Close this store and release any used resources.

Specified by:

close in interface JobPersistence<String>