Package com.adobe.pdfservices.operation.pdfjobs.result.pdfproperties

Class EncryptionSettings

java.lang.Object

com.adobe.pdfservices.operation.pdfjobs.result.pdfproperties.EncryptionSettings

public class EncryptionSettings
extends Object

This class provides information about the encryption settings of the specified PDF file, such as user and owner passwords, encryption algorithm etc.

Field Summary

Fields

Modifier and Type	Field	Description
String	algorithm
Integer	bitLength
Boolean	encryptAttachmentsOnly
Boolean	encryptMetadata
Boolean	hasOwnerPassword
Boolean	hasUserPassword

Constructor Summary

Constructors

Constructor	Description
EncryptionSettings()

Method Summary

Modifier and Type	Method	Description
String	getAlgorithm()	Returns a string specifying the encryption algorithm used to encrypt the specified PDF file - e.g.
Integer	getBitLength()	Returns the number of bits in the key used by a cryptographic algorithm to encrypt the specified PDF file.
Boolean	isMetadataEncrypted()	Returns a boolean specifying whether the metadata of the specified PDF file is encrypted or not.
Boolean	isOwnerPasswordSet()	Returns a boolean specifying whether the owner password is set for the specified PDF file.
Boolean	isUserPasswordSet()	Returns a boolean specifying whether the user password is set for the specified PDF file.
Boolean	onlyAttachmentsEncrypted()	Returns a boolean specifying whether only the file attachments in the specified PDF file are encrypted.

Methods inherited from class java.lang.Object

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

Field Detail

encryptAttachmentsOnly

public Boolean encryptAttachmentsOnly

hasOwnerPassword

public Boolean hasOwnerPassword

encryptMetadata

public Boolean encryptMetadata

hasUserPassword

public Boolean hasUserPassword

bitLength

public Integer bitLength

algorithm

public String algorithm

Constructor Detail

EncryptionSettings

public EncryptionSettings()

Method Detail

onlyAttachmentsEncrypted

public Boolean onlyAttachmentsEncrypted()

Returns a boolean specifying whether only the file attachments in the specified PDF file are encrypted.

Returns:

true if only the file attachments in the specified PDF file are encrypted. False otherwise.

isOwnerPasswordSet

public Boolean isOwnerPasswordSet()

Returns a boolean specifying whether the owner password is set for the specified PDF file.

Returns:

true if the owner password is set for the specified PDF file. False otherwise.

isMetadataEncrypted

public Boolean isMetadataEncrypted()

Returns a boolean specifying whether the metadata of the specified PDF file is encrypted or not.

Returns:

true if the metadata of the specified PDF file is encrypted. False otherwise.

isUserPasswordSet

public Boolean isUserPasswordSet()

Returns a boolean specifying whether the user password is set for the specified PDF file.

Returns:

true if the user password is set for the specified PDF file. False otherwise.

getBitLength

public Integer getBitLength()

Returns the number of bits in the key used by a cryptographic algorithm to encrypt the specified PDF file.

Returns:

An Integer denoting the number of bits in the key used by a cryptographic algorithm.

getAlgorithm

public String getAlgorithm()

Returns a string specifying the encryption algorithm used to encrypt the specified PDF file - e.g. "AES" etc.

Returns:

A String denoting the name of the encryption algorithm used to encrypt the specified PDF file.