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
@Forward(name="failure",
description="verification has failed")
@EnterpriseIntegrationPattern(TRANSLATOR)
public class SignaturePipe
extends FixedForwardPipe
implements HasKeystore
- Specific parameters
- signature the signature to verify
-
Nested Class Summary
-
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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
checks for correct configuration of forwarddoPipe
(Message message, PipeLineSession session) This is where the action takes place.boolean
void
setAction
(SignaturePipe.Action action) Action to be taken when pipe is executed.void
setAlgorithm
(String algorithm) The signing algorithmvoid
setKeyManagerAlgorithm
(String keyManagerAlgorithm) Key manager algorithm.void
setKeystore
(String string) Keystore to obtain signing keyvoid
setKeystoreAlias
(String string) Alias in keystorevoid
setKeystoreAliasAuthAlias
(String string) Alias used to obtain keystoreAlias passwordvoid
setKeystoreAliasPassword
(String string) KeystoreAlias passwordvoid
setKeystoreAuthAlias
(String string) Alias used to obtain keystore passwordvoid
setKeystorePassword
(String string) Keystore passwordvoid
setKeystoreType
(KeystoreType value) Type of keystore, can be pkcs12 or pemvoid
setProvider
(String provider) Cryptography providervoid
setSignatureBase64
(boolean signatureBase64) if true, the signature is (expected to be) base64 encodedvoid
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
addForward, 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, hasRegisteredForward, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, registerEvent, 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
- See Also:
-
ALGORITHM_DEFAULT
- See Also:
-
-
Constructor Details
-
SignaturePipe
public SignaturePipe()
-
-
Method Details
-
configure
Description copied from class:FixedForwardPipe
checks for correct configuration of forward- Specified by:
configure
in interfaceIConfigurable
- Specified by:
configure
in interfaceIPipe
- Overrides:
configure
in classFixedForwardPipe
- Throws:
ConfigurationException
-
start
public void start()Description copied from interface:IPipe
Perform necessary action to start the pipe. This method is executed after theIPipe.configure()
method, for each start and stop command of the adapter.- Specified by:
start
in interfaceIPipe
- Overrides:
start
in classAbstractPipe
-
doPipe
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 theFixedResultPipe
, the Pipe can schedule the input to be closed at session exit, by callingMessage.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 interfaceIPipe
- Throws:
PipeRunException
-
setAction
Action to be taken when pipe is executed.- Default value
- SIGN
-
setAlgorithm
The signing algorithm- Default value
- ALGORITHM_DEFAULT
-
setProvider
Cryptography provider -
setSignatureBase64
public void setSignatureBase64(boolean signatureBase64) if true, the signature is (expected to be) base64 encoded- Default value
- true
-
setKeystore
Keystore to obtain signing key- Specified by:
setKeystore
in interfaceHasKeystore
-
setKeystoreType
Type of keystore, can be pkcs12 or pem- Specified by:
setKeystoreType
in interfaceHasKeystore
- Default value
- pkcs12
-
setKeystoreAuthAlias
Alias used to obtain keystore password- Specified by:
setKeystoreAuthAlias
in interfaceHasKeystore
-
setKeystorePassword
Keystore password- Specified by:
setKeystorePassword
in interfaceHasKeystore
-
setKeystoreAlias
Alias in keystore- Specified by:
setKeystoreAlias
in interfaceHasKeystore
-
setKeystoreAliasAuthAlias
Alias used to obtain keystoreAlias password- Specified by:
setKeystoreAliasAuthAlias
in interfaceHasKeystore
-
setKeystoreAliasPassword
KeystoreAlias password- Specified by:
setKeystoreAliasPassword
in interfaceHasKeystore
-
setKeyManagerAlgorithm
Description copied from interface:HasKeystore
Key manager algorithm. Can be left empty to use the servers default algorithm- Specified by:
setKeyManagerAlgorithm
in interfaceHasKeystore
-
getAction
-
getAlgorithm
-
getProvider
-
isSignatureBase64
public boolean isSignatureBase64() -
getKeystore
- Specified by:
getKeystore
in interfaceHasKeystore
-
getKeystoreType
- Specified by:
getKeystoreType
in interfaceHasKeystore
-
getKeystoreAuthAlias
- Specified by:
getKeystoreAuthAlias
in interfaceHasKeystore
-
getKeystorePassword
- Specified by:
getKeystorePassword
in interfaceHasKeystore
-
getKeystoreAlias
- Specified by:
getKeystoreAlias
in interfaceHasKeystore
-
getKeystoreAliasAuthAlias
- Specified by:
getKeystoreAliasAuthAlias
in interfaceHasKeystore
-
getKeystoreAliasPassword
- Specified by:
getKeystoreAliasPassword
in interfaceHasKeystore
-
getKeyManagerAlgorithm
- Specified by:
getKeyManagerAlgorithm
in interfaceHasKeystore
-