Package org.pgpainless.encryption_signing

Class ProducerOptions

java.lang.Object

org.pgpainless.encryption_signing.ProducerOptions

public final class ProducerOptions
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
static ProducerOptions	encrypt(EncryptionOptions encryptionOptions)	Encrypt some data without signing.
java.lang.String	getComment()	Return comment set for header in ascii armored output.
CompressionAlgorithm	getCompressionAlgorithmOverride()
StreamEncoding	getEncoding()
EncryptionOptions	getEncryptionOptions()
java.lang.String	getFileName()	Return the encrypted files name.
java.util.Date	getModificationDate()	Return the modification date of the encrypted file.
SigningOptions	getSigningOptions()
boolean	hasComment()	Return whether a comment was set (!
boolean	isAsciiArmor()	Return true if the output of the encryption/signing operation shall be ascii armored.
boolean	isCleartextSigned()
static ProducerOptions	noEncryptionNoSigning()
ProducerOptions	overrideCompressionAlgorithm(CompressionAlgorithm compressionAlgorithm)	Override which compression algorithm shall be used.
ProducerOptions	setAsciiArmor(boolean asciiArmor)	Specify, whether the result of the encryption/signing operation shall be ascii armored.
ProducerOptions	setCleartextSigned()
ProducerOptions	setComment(java.lang.String comment)	Set the comment header in ASCII armored output.
ProducerOptions	setEncoding(StreamEncoding encoding)	Set the format of the literal data packet.
ProducerOptions	setFileName(java.lang.String fileName)	Set the name of the encrypted file.
ProducerOptions	setForYourEyesOnly()	Mark the encrypted message as for-your-eyes-only by setting a special file name.
ProducerOptions	setModificationDate(java.util.Date modificationDate)	Set the modification date of the encrypted file.
static ProducerOptions	sign(SigningOptions signingOptions)	Sign some data without encryption.
static ProducerOptions	signAndEncrypt(EncryptionOptions encryptionOptions, SigningOptions signingOptions)	Sign and encrypt some data.

Methods inherited from class java.lang.Object

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

Method Detail

signAndEncrypt

public static ProducerOptions signAndEncrypt(EncryptionOptions encryptionOptions,
                                             SigningOptions signingOptions)

Sign and encrypt some data.

Parameters:

encryptionOptions - encryption options

signingOptions - signing options

Returns:

builder

sign

public static ProducerOptions sign(SigningOptions signingOptions)

Sign some data without encryption.

Parameters:

signingOptions - signing options

Returns:

builder

encrypt

public static ProducerOptions encrypt(EncryptionOptions encryptionOptions)

Encrypt some data without signing.

Parameters:

encryptionOptions - encryption options

Returns:

builder

noEncryptionNoSigning

public static ProducerOptions noEncryptionNoSigning()

setAsciiArmor

public ProducerOptions setAsciiArmor(boolean asciiArmor)

Specify, whether the result of the encryption/signing operation shall be ascii armored. The default value is true.

Parameters:

asciiArmor - ascii armor

Returns:

builder

isAsciiArmor

public boolean isAsciiArmor()

Return true if the output of the encryption/signing operation shall be ascii armored.

Returns:

ascii armored

setComment

public ProducerOptions setComment(java.lang.String comment)

Set the comment header in ASCII armored output. The default value is null, which means no comment header is added. Multiline comments are possible using '\\n'. Note: If a default header comment is set using ArmoredOutputStreamFactory.setComment(String), then both comments will be written to the produced ASCII armor.

Parameters:

comment - comment header text

Returns:

builder

getComment

public java.lang.String getComment()

Return comment set for header in ascii armored output.

Returns:

comment

hasComment

public boolean hasComment()

Return whether a comment was set (!= null).

Returns:

comment

setCleartextSigned

public ProducerOptions setCleartextSigned()

isCleartextSigned

public boolean isCleartextSigned()

setFileName

public ProducerOptions setFileName(@Nonnull
                                   java.lang.String fileName)

Set the name of the encrypted file. Note: This option cannot be used simultaneously with setForYourEyesOnly().

Parameters:

fileName - name of the encrypted file

Returns:

this

getFileName

public java.lang.String getFileName()

Return the encrypted files name.

Returns:

file name

setForYourEyesOnly

public ProducerOptions setForYourEyesOnly()

Mark the encrypted message as for-your-eyes-only by setting a special file name. Note: Therefore this method cannot be used simultaneously with setFileName(String).

Returns:

this

setModificationDate

public ProducerOptions setModificationDate(@Nonnull
                                           java.util.Date modificationDate)

Set the modification date of the encrypted file.

Parameters:

modificationDate - Modification date of the encrypted file.

Returns:

this

getModificationDate

public java.util.Date getModificationDate()

Return the modification date of the encrypted file.

Returns:

modification date

setEncoding

public ProducerOptions setEncoding(@Nonnull
                                   StreamEncoding encoding)

Set the format of the literal data packet. Defaults to StreamEncoding.BINARY.

Parameters:

encoding - encoding

Returns:

this

See Also:

RFC4880 §5.9. Literal Data Packet

getEncoding

public StreamEncoding getEncoding()

overrideCompressionAlgorithm

public ProducerOptions overrideCompressionAlgorithm(CompressionAlgorithm compressionAlgorithm)

Override which compression algorithm shall be used.

Parameters:

compressionAlgorithm - compression algorithm override

Returns:

builder

getCompressionAlgorithmOverride

public CompressionAlgorithm getCompressionAlgorithmOverride()

getEncryptionOptions

@Nullable
public EncryptionOptions getEncryptionOptions()

getSigningOptions

@Nullable
public SigningOptions getSigningOptions()