@ElementType(value=TRANSLATOR) public class PGPPipe extends StreamingPipe
Performs various PGP (Pretty Good Privacy) actions such as Encrypt, Sign, Decrypt, Verify.
To use this pipe action parameter has to be set to one of the actions above.
Note: When secret key is required in any of the actions, the related public key should also be included in public keys.
Note: For fields that require multiple input (such as recipients, senders and publicKey -in certain actions-) you can seperate multiple values with ";" (semicolon).
Modifier and Type | Class and Description |
---|---|
static class |
PGPPipe.Action |
AUTOMATIC_STREAMING
parameterNamesMustBeUnique
log
LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT
Constructor and Description |
---|
PGPPipe() |
Modifier and Type | Method and Description |
---|---|
void |
configure()
checks for correct configuration of forward
|
PipeRunResult |
doPipe(Message message,
PipeLineSession session)
This is where the action takes place.
|
void |
setAction(PGPPipe.Action action)
Action to be taken when pipe is executed.
|
void |
setPublicKeys(String publicKeys)
Path to the recipient's public key.
|
void |
setRecipients(String recipients)
Recipients to be used during encryption stage.
|
void |
setSecretKey(String secretKey)
Path to the private key.
|
void |
setSecretPassword(String secretPassword)
Password for the private key.
|
void |
setVerificationAddresses(String verificationAddresses)
Emails of the senders.
|
canProvideOutputStream, canStreamToNextPipe, getNextPipe, getTargetStream, isStreamingActive, provideOutputStream, provideOutputStream, setStreamingActive, supportsOutputStreamPassThrough
getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe
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
configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine
getMaxThreads
getName
getApplicationContext, getName
getConfigurationClassLoader
getName
getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute
public void configure() throws ConfigurationException
FixedForwardPipe
configure
in interface IConfigurable
configure
in interface IPipe
configure
in class StreamingPipe
ConfigurationException
public PipeRunResult doPipe(Message message, PipeLineSession session) throws PipeRunException
AbstractPipe
doPipe
in interface IPipe
doPipe
in class AbstractPipe
PipeRunException
public void setAction(PGPPipe.Action action)
public void setRecipients(String recipients)
public void setVerificationAddresses(String verificationAddresses)
public void setSecretKey(String secretKey)
public void setSecretPassword(String secretPassword)
public void setPublicKeys(String publicKeys)
Copyright © 2023 Frank!Framework. All rights reserved.