Package com.pdftools.toolbox.pdf

Class Encryption

java.lang.Object

com.pdftools.toolbox.internal.NativeBase

com.pdftools.toolbox.internal.NativeObject

com.pdftools.toolbox.pdf.Encryption

public class Encryption
extends NativeObject

The password and permissions that should be applied to a document, when it is created using the Document.create(com.pdftools.toolbox.sys.Stream, com.pdftools.toolbox.pdf.Conformance, com.pdftools.toolbox.pdf.Encryption) or Document.createWithFdf(com.pdftools.toolbox.sys.Stream, com.pdftools.toolbox.sys.Stream, com.pdftools.toolbox.pdf.Conformance, com.pdftools.toolbox.pdf.Encryption) methods. The encryption algorithm (e.g., MD4, AES) will be the highest level of encryption that is supported for the document Document.getConformance(). Note that encryption is not permitted for any PDF/A level Document.getConformance().

Constructor Summary

Constructors

Constructor	Description
Encryption(java.lang.String userPassword, java.lang.String ownerPassword, java.util.EnumSet<Permission> permissions)	The getUserPassword() may be used to open the document with the permissions defined by the getPermissions() parameter.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getOwnerPassword()	The owner password opens the document with no access restrictions.
java.util.EnumSet<Permission>	getPermissions()	The permissions that will be granted to a user who opens the document using the getUserPassword().
java.lang.String	getUserPassword()	The user password opens the document with the permissions defined by the getPermissions() parameter.
void	setOwnerPassword(java.lang.String value)	The owner password opens the document with no access restrictions.
void	setPermissions(java.util.EnumSet<Permission> value)	The permissions that will be granted to a user who opens the document using the getUserPassword().
void	setUserPassword(java.lang.String value)	The user password opens the document with the permissions defined by the getPermissions() parameter.

Methods inherited from class com.pdftools.toolbox.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Encryption

public Encryption(java.lang.String userPassword,
                  java.lang.String ownerPassword,
                  java.util.EnumSet<Permission> permissions)

The getUserPassword() may be used to open the document with the permissions defined by the getPermissions() parameter. The getOwnerPassword() may be used to open the document with no access restrictions. The getPermissions() may be null (all permissions), or a concatenation of the allowed Permission values.

Parameters:

userPassword -

ownerPassword -

permissions -

Throws:

java.lang.IllegalArgumentException - if permissions is null

Method Detail

getUserPassword

public java.lang.String getUserPassword()

The user password opens the document with the permissions defined by the getPermissions() parameter.

setUserPassword

public void setUserPassword(java.lang.String value)

The user password opens the document with the permissions defined by the getPermissions() parameter.

getOwnerPassword

public java.lang.String getOwnerPassword()

The owner password opens the document with no access restrictions.

setOwnerPassword

public void setOwnerPassword(java.lang.String value)

The owner password opens the document with no access restrictions.

getPermissions

public java.util.EnumSet<Permission> getPermissions()

The permissions that will be granted to a user who opens the document using the getUserPassword(). The value is either null (all permissions), or a concatenation of the allowed Permission values.

setPermissions

public void setPermissions(java.util.EnumSet<Permission> value)

The permissions that will be granted to a user who opens the document using the getUserPassword(). The value is either null (all permissions), or a concatenation of the allowed Permission values.

Throws:

java.lang.IllegalArgumentException - if value is null