Class PGPPipe

    • Constructor Detail

      • PGPPipe

        public PGPPipe()
    • Method Detail

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