nl.nn.adapterframework.pipes

Class HashPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.pipes.HashPipe

All Implemented Interfaces:

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

@ElementType(value=TRANSLATOR)
public class HashPipe
extends FixedForwardPipe

Pipe that hashes the input message.

Author:

Niels Meijer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HashPipe.HashAlgorithm
static class	HashPipe.HashEncoding

Field Summary

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
HashPipe()

Method Summary

Modifier and Type	Method and Description
PipeRunResult	doPipe(Message message, PipeLineSession session) This is where the action takes place.
void	setAlgorithm(HashPipe.HashAlgorithm algorithm) Hash Algorithm to use
void	setAuthAlias(String authAlias) authAlias to retrieve the secret from (password field).
void	setBinaryToTextEncoding(HashPipe.HashEncoding hashEncoding) Deprecated.
void	setCharset(String charset) Character set to use for converting the secret from String to bytes
void	setEncoding(String encoding) Deprecated.
void	setHashEncoding(HashPipe.HashEncoding hashEncoding) Method to use for converting the hash from bytes to String
void	setSecret(String secret) The secret to hash with.

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

configure, 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, 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, throwEvent

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

HashPipe

public HashPipe()

Method Detail

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

setAlgorithm

public void setAlgorithm(HashPipe.HashAlgorithm algorithm)

Hash Algorithm to use

Default value

HmacSHA256

setEncoding

@Deprecated
 @ConfigurationWarning(value="attribute encoding has been replaced with attribute charset, default has changed from ISO8859_1 to UTF-8")
public void setEncoding(String encoding)

Deprecated.

setCharset

public void setCharset(String charset)

Character set to use for converting the secret from String to bytes

Default value

UTF-8

setHashEncoding

public void setHashEncoding(HashPipe.HashEncoding hashEncoding)

Method to use for converting the hash from bytes to String

Default value

Base64

setBinaryToTextEncoding

@Deprecated
 @ConfigurationWarning(value="use attribute hashEncoding instead")
public void setBinaryToTextEncoding(HashPipe.HashEncoding hashEncoding)

Deprecated.

setSecret

public void setSecret(String secret)

The secret to hash with. Only used if no parameter secret is configured. The secret is only used when there is no authAlias specified, by attribute or parameter

setAuthAlias

public void setAuthAlias(String authAlias)

authAlias to retrieve the secret from (password field). Only used if no parameter authAlias is configured