dk.netarkivet.common.utils.batch
Class LoadableFileBatchJob

java.lang.Object
  dk.netarkivet.common.utils.batch.FileBatchJob
      dk.netarkivet.common.utils.batch.LoadableFileBatchJob

All Implemented Interfaces:

java.io.Serializable

public class LoadableFileBatchJob
extends FileBatchJob

This implementation of FileBatchJob is a bridge to a class file given as a File object. The given class will be loaded and used to perform the actions of the FileBatchJob class.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class dk.netarkivet.common.utils.batch.FileBatchJob

FileBatchJob.ExceptionOccurrence

Field Summary

(package private) byte[]	fileContents The binary contents of the file before they are turned into a class.
(package private) java.lang.String	fileName The name of the file before they are turned into a class.
(package private) FileBatchJob	loadedJob The job loaded from file.
(package private) org.apache.commons.logging.Log	log The class logger.

Fields inherited from class dk.netarkivet.common.utils.batch.FileBatchJob

batchJobTimeout, exceptions, filesFailed, noOfFilesProcessed

Constructor Summary

LoadableFileBatchJob(java.io.File classFile, java.util.List<java.lang.String> arguments)
Create a new batch job that runs the loaded class.

Method Summary

void	finish(java.io.OutputStream os) Finish up the job.
void	initialize(java.io.OutputStream os) Initialize the job before runnning.
protected void	loadBatchJob() Method for initializing the loaded batchjob.
boolean	postProcess(java.io.InputStream input, java.io.OutputStream output) Processes the concatenated result files.
boolean	processFile(java.io.File file, java.io.OutputStream os) Process one file stored in the bit archive.
java.lang.String	toString() Override of the default toString to include name of loaded class.

Methods inherited from class dk.netarkivet.common.utils.batch.FileBatchJob

addException, addFinishException, addInitializeException, getBatchJobTimeout, getExceptions, getFilenamePattern, getFilesFailed, getNoOfFilesProcessed, maxExceptionsReached, processOnlyFileNamed, processOnlyFilesMatching, processOnlyFilesMatching, processOnlyFilesNamed, setBatchJobTimeout

Methods inherited from class java.lang.Object

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

Field Detail

log

transient org.apache.commons.logging.Log log

The class logger.

loadedJob

transient FileBatchJob loadedJob

The job loaded from file.

fileContents

byte[] fileContents

The binary contents of the file before they are turned into a class.

fileName

java.lang.String fileName

The name of the file before they are turned into a class.

Constructor Detail

LoadableFileBatchJob

public LoadableFileBatchJob(java.io.File classFile,
                            java.util.List<java.lang.String> arguments)
                     throws ArgumentNotValid

Create a new batch job that runs the loaded class.

Parameters:

classFile - the classfile for the batch job we want to run.

arguments - The arguments for the batchjobs. This can be null.

Throws:

ArgumentNotValid - If the classfile is null.

Method Detail

toString

public java.lang.String toString()

Override of the default toString to include name of loaded class.

Overrides:

toString in class java.lang.Object

Returns:

string representation of this class.

initialize

public void initialize(java.io.OutputStream os)

Initialize the job before runnning. This is called before the processFile() calls.

Specified by:

initialize in class FileBatchJob

Parameters:

os - the OutputStream to which output should be written

loadBatchJob

protected void loadBatchJob()
                     throws IOFailure

Method for initializing the loaded batchjob.

Throws:

IOFailure - If the batchjob cannot be loaded.

processFile

public boolean processFile(java.io.File file,
                           java.io.OutputStream os)

Process one file stored in the bit archive.

Specified by:

processFile in class FileBatchJob

Parameters:

file - the file to be processed.

os - the OutputStream to which output should be written

Returns:

true if the file was successfully processed, false otherwise

finish

public void finish(java.io.OutputStream os)

Finish up the job. This is called after the last process() call.

Specified by:

finish in class FileBatchJob

Parameters:

os - the OutputStream to which output should be written

postProcess

public boolean postProcess(java.io.InputStream input,
                           java.io.OutputStream output)

Description copied from class: FileBatchJob

Processes the concatenated result files. This is intended to be overridden by batchjobs, who they wants a different post-processing process than concatenation.

Overrides:

postProcess in class FileBatchJob

Parameters:

input - The inputstream to the file containing the concatenated results.

output - The outputstream where the resulting data should be written.

Returns:

Whether it actually does any post processing. If false is returned then the default concatenated result file is returned.