Package org.frankframework.pipes

Class SignaturePipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.SignaturePipe

All Implemented Interfaces:

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

@ElementType(TRANSLATOR)
public class SignaturePipe
extends FixedForwardPipe
implements HasKeystore

Specific parameters

signature the signature to verify

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SignaturePipe.Action

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALGORITHM_DEFAULT
static final String	PARAMETER_SIGNATURE

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

Method Summary

Modifier and Type	Method	Description
void	configure()	checks for correct configuration of forward
PipeRunResult	doPipe(Message message, PipeLineSession session)	This is where the action takes place.
SignaturePipe.Action	getAction()
String	getAlgorithm()
String	getKeyManagerAlgorithm()
String	getKeystore()
String	getKeystoreAlias()
String	getKeystoreAliasAuthAlias()
String	getKeystoreAliasPassword()
String	getKeystoreAuthAlias()
String	getKeystorePassword()
KeystoreType	getKeystoreType()
String	getProvider()
boolean	isSignatureBase64()
void	setAction(SignaturePipe.Action action)	Action to be taken when pipe is executed.
void	setAlgorithm(String algorithm)	The signing algorithm
void	setKeyManagerAlgorithm(String keyManagerAlgorithm)	Key manager algorithm.
void	setKeystore(String string)	Keystore to obtain signing key
void	setKeystoreAlias(String string)	Alias in keystore
void	setKeystoreAliasAuthAlias(String string)	Alias used to obtain keystoreAlias password
void	setKeystoreAliasPassword(String string)	KeystoreAlias password
void	setKeystoreAuthAlias(String string)	Alias used to obtain keystore password
void	setKeystorePassword(String string)	Keystore password
void	setKeystoreType(KeystoreType value)	Type of keystore, can be pkcs12 or pem
void	setProvider(String provider)	Cryptography provider
void	setSignatureBase64(boolean signatureBase64)	if true, the signature is (expected to be) base64 encoded
void	start()	Perform necessary action to start the pipe.

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

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, 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.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface org.frankframework.core.IPipe

throwEvent

Methods inherited from interface org.frankframework.core.IScopeProvider

getConfigurationClassLoader

Field Details

PARAMETER_SIGNATURE

public static final String PARAMETER_SIGNATURE

See Also:

• Constant Field Values

ALGORITHM_DEFAULT

public static final String ALGORITHM_DEFAULT

See Also:

• Constant Field Values

Constructor Details

SignaturePipe

public SignaturePipe()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

checks for correct configuration of forward

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class FixedForwardPipe

Throws:

ConfigurationException

start

public void start()
           throws PipeStartException

Description copied from interface: IPipe

Perform necessary action to start the pipe. This method is executed after the IPipe.configure() method, for each start and stop command of the adapter.

Specified by:

start in interface IPipe

Overrides:

start in class AbstractPipe

Throws:

PipeStartException

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.

Specified by:

doPipe in interface IPipe

Throws:

PipeRunException

setAction

public void setAction(SignaturePipe.Action action)

Action to be taken when pipe is executed.

Default value

SIGN

setAlgorithm

public void setAlgorithm(String algorithm)

The signing algorithm

Default value

ALGORITHM_DEFAULT

setProvider

public void setProvider(String provider)

Cryptography provider

setSignatureBase64

public void setSignatureBase64(boolean signatureBase64)

if true, the signature is (expected to be) base64 encoded

Default value

true

setKeystore

public void setKeystore(String string)

Keystore to obtain signing key

Specified by:

setKeystore in interface HasKeystore

setKeystoreType

public void setKeystoreType(KeystoreType value)

Type of keystore, can be pkcs12 or pem

Specified by:

setKeystoreType in interface HasKeystore

Default value

pkcs12

setKeystoreAuthAlias

public void setKeystoreAuthAlias(String string)

Alias used to obtain keystore password

Specified by:

setKeystoreAuthAlias in interface HasKeystore

setKeystorePassword

public void setKeystorePassword(String string)

Keystore password

Specified by:

setKeystorePassword in interface HasKeystore

setKeystoreAlias

public void setKeystoreAlias(String string)

Alias in keystore

Specified by:

setKeystoreAlias in interface HasKeystore

setKeystoreAliasAuthAlias

public void setKeystoreAliasAuthAlias(String string)

Alias used to obtain keystoreAlias password

Specified by:

setKeystoreAliasAuthAlias in interface HasKeystore

setKeystoreAliasPassword

public void setKeystoreAliasPassword(String string)

KeystoreAlias password

Specified by:

setKeystoreAliasPassword in interface HasKeystore

setKeyManagerAlgorithm

public void setKeyManagerAlgorithm(String keyManagerAlgorithm)

Description copied from interface: HasKeystore

Key manager algorithm. Can be left empty to use the servers default algorithm

Specified by:

setKeyManagerAlgorithm in interface HasKeystore

getAction

public SignaturePipe.Action getAction()

getAlgorithm

public String getAlgorithm()

getProvider

public String getProvider()

isSignatureBase64

public boolean isSignatureBase64()

getKeystore

public String getKeystore()

Specified by:

getKeystore in interface HasKeystore

getKeystoreType

public KeystoreType getKeystoreType()

Specified by:

getKeystoreType in interface HasKeystore

getKeystoreAuthAlias

public String getKeystoreAuthAlias()

Specified by:

getKeystoreAuthAlias in interface HasKeystore

getKeystorePassword

public String getKeystorePassword()

Specified by:

getKeystorePassword in interface HasKeystore

getKeystoreAlias

public String getKeystoreAlias()

Specified by:

getKeystoreAlias in interface HasKeystore

getKeystoreAliasAuthAlias

public String getKeystoreAliasAuthAlias()

Specified by:

getKeystoreAliasAuthAlias in interface HasKeystore

getKeystoreAliasPassword

public String getKeystoreAliasPassword()

Specified by:

getKeystoreAliasPassword in interface HasKeystore

getKeyManagerAlgorithm

public String getKeyManagerAlgorithm()

Specified by:

getKeyManagerAlgorithm in interface HasKeystore