Package org.frankframework.pipes

Enum Class PGPPipe.Action

java.lang.Object

java.lang.Enum<PGPPipe.Action>

org.frankframework.pipes.PGPPipe.Action

All Implemented Interfaces:

Serializable, Comparable<PGPPipe.Action>, Constable

Enclosing class:

PGPPipe

public static enum PGPPipe.Action
extends Enum<PGPPipe.Action>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DECRYPT	Decrypts the given input.
ENCRYPT	Encrypts the given input.
SIGN	Encrypts and then signs the given input.
VERIFY	Decrypts and verifies the given input.

Method Summary

Modifier and Type	Method	Description
static PGPPipe.Action	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PGPPipe.Action[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ENCRYPT

public static final PGPPipe.Action ENCRYPT

Encrypts the given input. Requires the publicKey to be set to recipients public key, and recipients to be set to recipients email addresses.

SIGN

public static final PGPPipe.Action SIGN

Encrypts and then signs the given input. On top of the requirements for Encrypt action, signing requires senders to bet set for user's email; and secretKey & secretPassword to be set to private key's path and it's password (password is optional, if private key does not have protection).

DECRYPT

public static final PGPPipe.Action DECRYPT

Decrypts the given input. Requires secretKey and secretPassword to bet set to private key's path and it's password. Just like signing, password is not required, if private key does not have protection.

VERIFY

public static final PGPPipe.Action VERIFY

Decrypts and verifies the given input. On top of the requirements for Decrypt action, verification expects list of senders' email's and corresponding public keys. However, sender emails does not have to be set, and in that case, this pipe will only validate that someone signed the input.

Method Details

values

public static PGPPipe.Action[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PGPPipe.Action valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null