Package org.pgpainless.encryption_signing

Class EncryptionResult

java.lang.Object

org.pgpainless.encryption_signing.EncryptionResult

public final class EncryptionResult
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EncryptionResult.Builder

Method Summary

Modifier and Type	Method	Description
static EncryptionResult.Builder	builder()	Create a builder for the encryption result class.
CompressionAlgorithm	getCompressionAlgorithm()	Return the compression algorithm that was used to compress the message before encryption/signing.
MultiMap<SubkeyIdentifier,org.bouncycastle.openpgp.PGPSignature>	getDetachedSignatures()	Return a MultiMap of key identifiers and detached signatures that were generated for the message.
SymmetricKeyAlgorithm	getEncryptionAlgorithm()	Return the symmetric encryption algorithm used to encrypt the message.
StreamEncoding	getFileEncoding()	Return the encoding format of the encrypted/signed data.
String	getFileName()	Return the file name of the encrypted/signed data.
Date	getModificationDate()	Return the modification date of the encrypted/signed file.
Set<SubkeyIdentifier>	getRecipients()	Return the set of recipient encryption keys.
SymmetricKeyAlgorithm	getSymmetricKeyAlgorithm()	Deprecated. use getEncryptionAlgorithm() instead.
boolean	isForYourEyesOnly()	Return true, if the message is marked as for-your-eyes-only.

Methods inherited from class java.lang.Object

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

Method Detail

getSymmetricKeyAlgorithm

@Deprecated
public SymmetricKeyAlgorithm getSymmetricKeyAlgorithm()

Deprecated.

use getEncryptionAlgorithm() instead.

Return the symmetric encryption algorithm used to encrypt the message.

Returns:

symmetric encryption algorithm

getEncryptionAlgorithm

public SymmetricKeyAlgorithm getEncryptionAlgorithm()

Return the symmetric encryption algorithm used to encrypt the message.

Returns:

symmetric encryption algorithm

getCompressionAlgorithm

public CompressionAlgorithm getCompressionAlgorithm()

Return the compression algorithm that was used to compress the message before encryption/signing.

Returns:

compression algorithm

getDetachedSignatures

public MultiMap<SubkeyIdentifier,org.bouncycastle.openpgp.PGPSignature> getDetachedSignatures()

Return a MultiMap of key identifiers and detached signatures that were generated for the message. Each key of the map represents a signing key, which has one or more detached signatures associated with it.

Returns:

detached signatures

getRecipients

public Set<SubkeyIdentifier> getRecipients()

Return the set of recipient encryption keys.

Returns:

recipients

getFileName

public String getFileName()

Return the file name of the encrypted/signed data.

Returns:

filename

getModificationDate

public Date getModificationDate()

Return the modification date of the encrypted/signed file.

Returns:

modification date

getFileEncoding

public StreamEncoding getFileEncoding()

Return the encoding format of the encrypted/signed data.

Returns:

encoding format

isForYourEyesOnly

public boolean isForYourEyesOnly()

Return true, if the message is marked as for-your-eyes-only. This is typically done by setting the filename "_CONSOLE".

Returns:

is message for your eyes only?

builder

public static EncryptionResult.Builder builder()

Create a builder for the encryption result class.

Returns:

builder