Package org.frankframework.pipes

Class ChecksumPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.ChecksumPipe

All Implemented Interfaces:

HasTransactionAttribute, IConfigurable, IConfigurationAware, IForwardTarget, INamedObject, IPipe, IScopeProvider, IWithParameters, EventThrowing, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class ChecksumPipe
extends FixedForwardPipe

Pipe to calculate checksum on input.

Since:

4.9

Author:

Gerrit van Brakel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	ChecksumPipe.ChecksumGenerator
static enum	ChecksumPipe.ChecksumType
protected static class	ChecksumPipe.MessageDigestChecksumGenerator
protected static class	ChecksumPipe.ZipChecksumGenerator

Field Summary

Fields inherited from class org.frankframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class org.frankframework.core.TransactionAttributes

log

Fields inherited from interface org.frankframework.core.IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor	Description
ChecksumPipe()

Method Summary

Modifier and Type	Method	Description
protected ChecksumPipe.ChecksumGenerator	createChecksumGenerator()
PipeRunResult	doPipe(Message message, PipeLineSession session)	This is where the action takes place.
String	getCharset()
ChecksumPipe.ChecksumType	getType()
boolean	isInputIsFile()
void	setCharset(String string)	Character encoding to be used to encode message before calculating checksum.
void	setInputIsFile(boolean b)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setType(ChecksumPipe.ChecksumType value)	Type of checksum to be calculated

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

configure, getIfParam, getIfValue, getOnlyIfSessionKey, getOnlyIfValue, getParameterValue, getSuccessForward, getUnlessSessionKey, getUnlessValue, isSkipOnEmptyInput, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class org.frankframework.pipes.AbstractPipe

addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getApplicationContext, getChompCharSize, getConfigurationClassLoader, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getEventSourceName, getForwards, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getName, getParameterList, getPipeLine, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setEventPublisher, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPipeLine, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, start, stop, throwEvent

Methods inherited from class org.frankframework.core.TransactionAttributes

configureTransactionAttributes, getTransactionAttribute, getTransactionTimeout, getTxDef, isTransacted, isTransacted, setTransacted, setTransactionAttribute, setTransactionTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.frankframework.core.IPipe

throwEvent

Constructor Details

ChecksumPipe

public ChecksumPipe()

Method Details

createChecksumGenerator

protected ChecksumPipe.ChecksumGenerator createChecksumGenerator()
                                                          throws NoSuchAlgorithmException

Throws:

NoSuchAlgorithmException

doPipe

public PipeRunResult doPipe(Message message,
 PipeLineSession session)
                     throws PipeRunException

Description copied from interface: IPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.

Throws:

PipeRunException

setCharset

public void setCharset(String string)

Character encoding to be used to encode message before calculating checksum.

setType

public void setType(ChecksumPipe.ChecksumType value)

Type of checksum to be calculated

Default value

MD5

setInputIsFile

@Deprecated(forRemoval=true,
            since="7.7.0")
@ConfigurationWarning("Please use fileSystemPipe to read the file first.")
public void setInputIsFile(boolean b)

Deprecated, for removal: This API element is subject to removal in a future version.

If set true, the input is assumed to be a filename; otherwise the input itself is used in the calculations.

Default value

false

getCharset

public String getCharset()

getType

public ChecksumPipe.ChecksumType getType()

isInputIsFile

public boolean isInputIsFile()