Package net.simplace.pipe.processors

Class HashValueFromFileProcessor

java.lang.Object

net.simplace.pipe.control.FWProcessor

net.simplace.pipe.processors.HashValueFromFileProcessor

public class HashValueFromFileProcessor
extends FWProcessor

This processor computes the MD5 hash value of a given file and puts it into the pipeline.

Parameters:

filename

A complete or relative path to the file to be hashed. This parameter is mandatory!

resultParamKey

Key of the parameter that is put into the pipeline. This parameter is optional. The default is "hashValue".

Author:

ckunze

Field Summary

Fields inherited from class net.simplace.pipe.control.FWProcessor

iAllreadyLoopedCount, iContainer, iInObservable, iObservable, iProgressTasks

Constructor Summary

Constructors

Constructor	Description
HashValueFromFileProcessor()

Method Summary

Modifier and Type	Method	Description
protected boolean	checkInParameterMap()	Ensures that all required parameters contain a value.
protected String	getHexRepresentation(byte[] aDigestValue)
protected boolean	process()	Runs the processor

Methods inherited from class net.simplace.pipe.control.FWProcessor

checkOutParameterMap, clone, containsParameter, createProcessor, createProcessor, fireTaskEvent, getAllStringInParameters, getConfiguration, getInitialParameters, getInParameter, getInParameter, getInParameters, getNewProgressTask, getOutParameter, getOutParameterKeys, getPipeLine, getProgressTask, getStringInParameter, getStringInParameter, getSystemID, hasConfiguration, isEndOfPipe, pipe, removeOutParameter, setConfiguration, setEndOfPipeFlag, setInitialParameters, setInParameterMap, setLoopedCount, setOutParameter, setStateOfTask, setStateProgressing, toXML

Methods inherited from class java.lang.Object

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

Constructor Details

HashValueFromFileProcessor

public HashValueFromFileProcessor()

Method Details

process

protected boolean process()
                   throws PipeLineException

Runs the processor

Specified by:

process in class FWProcessor

Returns:

success

Throws:

PipeLineException

checkInParameterMap

protected boolean checkInParameterMap()

Ensures that all required parameters contain a value. If the value actually makes sense is checked when the processor is actually executed.

Overrides:

checkInParameterMap in class FWProcessor

Returns:

true if not overridden by implementations

getHexRepresentation

protected String getHexRepresentation(byte[] aDigestValue)

Parameters:

aDigestValue -

Returns:

the hex representation (as String) of the given byte array