nl.nn.adapterframework.pipes

Class ChecksumPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.stream.StreamingPipe

nl.nn.adapterframework.pipes.ChecksumPipe

All Implemented Interfaces:

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

@SupportsOutputStreaming
public class ChecksumPipe
extends StreamingPipe

Pipe to calculate checksum on input.

Since:

4.9

Author:

Gerrit van Brakel

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class nl.nn.adapterframework.stream.StreamingPipe

AUTOMATIC_STREAMING

Fields inherited from class nl.nn.adapterframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor and Description
ChecksumPipe()

Method Summary

Modifier and Type	Method and Description
protected boolean	canProvideOutputStream() returns true when: a) the pipe might be able to accept an input by providing an OutputStream, and b) there are no side effects configured that prevent handing over its PipeRunResult to the calling pipe (e.g.
protected ChecksumPipe.ChecksumGenerator	createChecksumGenerator()
PipeRunResult	doPipe(Message message, PipeLineSession session) This is where the action takes place.
protected MessageOutputStream	provideOutputStream(PipeLineSession session) provide the outputstream, or null if a stream cannot be provided.
void	setCharset(String string) Character encoding to be used to encode message before calculating checksum.
void	setInputIsFile(boolean b) Deprecated.
void	setType(ChecksumPipe.ChecksumType value) Type of checksum to be calculated

Methods inherited from class nl.nn.adapterframework.stream.StreamingPipe

canStreamToNextPipe, configure, getNextPipe, getTargetStream, isStreamingActive, provideOutputStream, setStreamingActive, supportsOutputStreamPassThrough

Methods inherited from class nl.nn.adapterframework.pipes.FixedForwardPipe

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class nl.nn.adapterframework.pipes.AbstractPipe

addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, getParameterOverriddenAttributeValue, getParameterValueList, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, start, stop, throwEvent

Methods inherited from class nl.nn.adapterframework.core.TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.IExtendedPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine

Methods inherited from interface nl.nn.adapterframework.core.IPipe

getMaxThreads

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface nl.nn.adapterframework.core.IForwardTarget

getName

Methods inherited from interface nl.nn.adapterframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Constructor Detail

ChecksumPipe

public ChecksumPipe()

Method Detail

createChecksumGenerator

protected ChecksumPipe.ChecksumGenerator createChecksumGenerator()
                                                          throws NoSuchAlgorithmException

Throws:

NoSuchAlgorithmException

doPipe

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

Description copied from class: AbstractPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object.

Specified by:

doPipe in interface IPipe

Specified by:

doPipe in class AbstractPipe

Throws:

PipeRunException

canProvideOutputStream

protected boolean canProvideOutputStream()

Description copied from class: StreamingPipe

returns true when: a) the pipe might be able to accept an input by providing an OutputStream, and b) there are no side effects configured that prevent handing over its PipeRunResult to the calling pipe (e.g. storeResultInSessionKey) c) there are no side effects that require the input to be available at the end of the pipe (e.g. preserveInput=true) d) there are no parameters that require the input value or context (b and c are implemented by PipeProcessors, that do not support outputStreaming)

Overrides:

canProvideOutputStream in class StreamingPipe

provideOutputStream

protected MessageOutputStream provideOutputStream(PipeLineSession session)
                                           throws StreamingException

Description copied from class: StreamingPipe

provide the outputstream, or null if a stream cannot be provided. Implementations should provide a forward target by calling StreamingPipe.getNextPipe().

Overrides:

provideOutputStream in class StreamingPipe

Throws:

StreamingException

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
 @ConfigurationWarning(value="Please use fileSystemPipe to read the file first.")
public void setInputIsFile(boolean b)

Deprecated.

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

Default value

false