Class PGPPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.PGPPipe

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

@EnterpriseIntegrationPattern(TRANSLATOR)
public class PGPPipe
extends FixedForwardPipe

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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PGPPipe.Action

Field Summary

Fields inherited from class AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class TransactionAttributes

log

Fields inherited from interface IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor	Description
PGPPipe()

Method Summary

Modifier and Type	Method	Description
void	configure()	Checks for correct configuration of forward.
@NonNull 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.

Methods inherited from class FixedForwardPipe

getParameterValue

Methods inherited from class AbstractPipe

addForward, addParameter, createBean, findForward, getAdapter, getEventSourceName, getParameterList, getRegisteredForwards, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDefaultValue, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setIfParam, setIfValue, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setOnlyIfSessionKey, setOnlyIfValue, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setSkipOnEmptyInput, setStoreResultInSessionKey, setUnlessSessionKey, setUnlessValue, setWriteToSecLog, sizeStatisticsEnabled, skipPipe, start, stop, throwEvent

Methods inherited from class TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasName

getName

Methods inherited from interface HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface IForwardTarget

getName

Methods inherited from interface IPipe

getChompCharSize, getDefaultValue, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getIfParam, getIfValue, getLocker, getLogIntermediaryResults, getMaxThreads, getOnlyIfSessionKey, getOnlyIfValue, getSecLogSessionKeys, getStoreResultInSessionKey, getUnlessSessionKey, getUnlessValue, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isSkipOnEmptyInput, isWriteToSecLog, setPipeLine, throwEvent

Constructor Details

PGPPipe

public PGPPipe()

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

Overrides:

configure in class FixedForwardPipe

Throws:

ConfigurationException - in case it was not able to configure the component.

doPipe

public @NonNull 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.

Throws:

PipeRunException

setAction

public void setAction(PGPPipe.Action action)

Action to be taken when pipe is executed.

setRecipients

public void setRecipients(String recipients)

Recipients to be used during encryption stage. If multiple, separate with ';' (semicolon)

setVerificationAddresses

public void setVerificationAddresses(String verificationAddresses)

Emails of the senders. This will be used to verify that all the senders have signed the given message. If not set, and the action is verify; this pipe will validate that at least one person has signed. For signing action, it needs to be set to the email that was used to generate the private key that is being used for this process.

setSecretKey

public void setSecretKey(String secretKey)

Path to the private key. It will be used when signing or decrypting.

setSecretPassword

public void setSecretPassword(String secretPassword)

Password for the private key.

setPublicKeys

public void setPublicKeys(String publicKeys)

Path to the recipient's public key. It will be used for encryption and verification.