Package org.frankframework.pipes

Class HashPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.HashPipe

All Implemented Interfaces:

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

@ElementType(TRANSLATOR)
public class HashPipe
extends FixedForwardPipe

Pipe that hashes the input message.

Author:

Niels Meijer

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
PipeRunResult	doPipe(Message message, PipeLineSession session)	This is where the action takes place.
HashPipe.HashAlgorithm	getAlgorithm()
String	getAuthAlias()
String	getCharset()
HashPipe.HashEncoding	getHashEncoding()
String	getSecret()
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 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

HashPipe

public HashPipe()

Method Details

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("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("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

getCharset

public String getCharset()

getSecret

public String getSecret()

getAuthAlias

public String getAuthAlias()

getAlgorithm

public HashPipe.HashAlgorithm getAlgorithm()

getHashEncoding

public HashPipe.HashEncoding getHashEncoding()