com.itextpdf.dito.sdk.output.properties

Class PdfEncryptionProperties

java.lang.Object

com.itextpdf.dito.sdk.output.properties.PdfEncryptionProperties

public class PdfEncryptionProperties
extends Object

Class that declares encryption for produced pdf document

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	CONTENT_COPYING_ALLOWED_DEFAULT The default value of isContentCopyingAllowed()
static boolean	EDITING_ALLOWED_DEFAULT The default value of isEditingAllowed()
static boolean	PRINTING_ALLOWED_DEFAULT The default value of isPrintingAllowed()
static boolean	SCREEN_READER_ACCESS_ALLOWED_DEFAULT The default value of isScreenReaderAccessAllowed()

Constructor Summary

Constructors

Constructor and Description
PdfEncryptionProperties()

Method Summary

Modifier and Type	Method and Description
byte[]	getOwnerPassword() Gets owner password bytes
byte[]	getUserPassword() Gets user password bytes
boolean	isContentCopyingAllowed() Gets whether it is possible to copy content from PDF when it is opened with user permissions
boolean	isEditingAllowed() Gets whether it is possible to edit content in PDF (including annotations) when it is opened with user permissions
boolean	isPrintingAllowed() Gets whether it is possible to print PDF when it is opened with user permissions
boolean	isScreenReaderAccessAllowed() Gets whether it is possible for screen reader to access content in PDF when it is opened with user permissions
PdfEncryptionProperties	setContentCopyingAllowed(boolean contentCopyingAllowed) Sets whether it is possible to copy content from PDF when it is opened with user permissions
PdfEncryptionProperties	setEditingAllowed(boolean editingAllowed) Sets whether it is possible to edit content in PDF (including annotations) when it is opened with user permissions
PdfEncryptionProperties	setOwnerPassword(byte[] ownerPassword) Sets owner password from raw bytes
PdfEncryptionProperties	setOwnerPassword(String ownerPassword) Sets owner password from String
PdfEncryptionProperties	setPrintingAllowed(boolean printingAllowed) Sets whether it is possible to print PDF when it is opened with user permissions
PdfEncryptionProperties	setScreenReaderAccessAllowed(boolean screenReaderAccessAllowed) Sets whether it is possible for screen reader to access content in PDF when it is opened with user permissions
PdfEncryptionProperties	setUserPassword(byte[] userPassword) Sets user password from raw bytes
PdfEncryptionProperties	setUserPassword(String userPassword) Sets user password from String

Methods inherited from class java.lang.Object

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

Field Detail

PRINTING_ALLOWED_DEFAULT

public static final boolean PRINTING_ALLOWED_DEFAULT

The default value of isPrintingAllowed()

See Also:

Constant Field Values

CONTENT_COPYING_ALLOWED_DEFAULT

public static final boolean CONTENT_COPYING_ALLOWED_DEFAULT

The default value of isContentCopyingAllowed()

See Also:

Constant Field Values

EDITING_ALLOWED_DEFAULT

public static final boolean EDITING_ALLOWED_DEFAULT

The default value of isEditingAllowed()

See Also:

Constant Field Values

SCREEN_READER_ACCESS_ALLOWED_DEFAULT

public static final boolean SCREEN_READER_ACCESS_ALLOWED_DEFAULT

The default value of isScreenReaderAccessAllowed()

See Also:

Constant Field Values

Constructor Detail

PdfEncryptionProperties

public PdfEncryptionProperties()

Method Detail

getOwnerPassword

public byte[] getOwnerPassword()

Gets owner password bytes

If encryption is used, owner password must be not null and not empty There are no restrictions when working with PDF opened with owner permissions

Returns:

owner password bytes

setOwnerPassword

public PdfEncryptionProperties setOwnerPassword(byte[] ownerPassword)

Sets owner password from raw bytes

Note: Use this if you know what's you are doing, for most cases consider using setOwnerPassword(String) instead.

If encryption is used, owner password must be not null and not empty There are no restrictions when working with PDF opened with owner permissions

Parameters:

ownerPassword - owner password bytes

Returns:

instance of this PdfEncryptionProperties class for chaining

setOwnerPassword

public PdfEncryptionProperties setOwnerPassword(String ownerPassword)

Sets owner password from String

Conversion to byte array is performed according to ISO-32000-1 7.6.4.3.3 Algorithm 2.A: Retrieving the file encryption key from an encrypted document in order to decrypt it (revision 6 and later): the SASLPrep (RFC 4013) profile of StringPrep (RFC 3454) is applied first using the Normalize and BiDi options, then conversion to a UTF-8 representation is performed.

If encryption is used, owner password must be not null and not empty There are no restrictions when working with PDF opened with owner permissions

Parameters:

ownerPassword - owner password string

Returns:

instance of this PdfEncryptionProperties class for chaining

getUserPassword

public byte[] getUserPassword()

Gets user password bytes

If null or empty is treated as absent.

If absent PDF document can be opened with user permissions without any password.

The isContentCopyingAllowed(), isEditingAllowed(), isPrintingAllowed(), isScreenReaderAccessAllowed() are indicating what is allowed, when PDF is opened with user permissions

Returns:

user password bytes

setUserPassword

public PdfEncryptionProperties setUserPassword(byte[] userPassword)

Sets user password from raw bytes

Note: Use this if you know what's you are doing, for most cases consider using setUserPassword(String) instead.

If null or empty is treated as absent.

If absent PDF document can be opened with user permissions without any password.

The isContentCopyingAllowed(), isEditingAllowed(), isPrintingAllowed(), isScreenReaderAccessAllowed() are indicating what is allowed, when PDF is opened with user permissions

Parameters:

userPassword - user password bytes

Returns:

instance of this PdfEncryptionProperties class for chaining

setUserPassword

public PdfEncryptionProperties setUserPassword(String userPassword)

Sets user password from String

Conversion to byte array is performed according to ISO-32000-1 7.6.4.3.3 Algorithm 2.A: Retrieving the file encryption key from an encrypted document in order to decrypt it (revision 6 and later): the SASLPrep (RFC 4013) profile of StringPrep (RFC 3454) is applied first using the Normalize and BiDi options, then conversion to a UTF-8 representation is performed.

If null or empty is treated as absent.

If absent PDF document can be opened with user permissions without any password.

The isContentCopyingAllowed(), isEditingAllowed(), isPrintingAllowed(), isScreenReaderAccessAllowed() are indicating what is allowed, when PDF is opened with user permissions

Parameters:

userPassword - user password string

Returns:

instance of this PdfEncryptionProperties class for chaining

isPrintingAllowed

public boolean isPrintingAllowed()

Gets whether it is possible to print PDF when it is opened with user permissions

Is PRINTING_ALLOWED_DEFAULT by default

Returns:

true if printing is allowed, otherwise false

setPrintingAllowed

public PdfEncryptionProperties setPrintingAllowed(boolean printingAllowed)

Sets whether it is possible to print PDF when it is opened with user permissions

Is PRINTING_ALLOWED_DEFAULT by default

Parameters:

printingAllowed - true if it is possible to print PDF, otherwise false

Returns:

instance of this PdfEncryptionProperties class for chaining

isContentCopyingAllowed

public boolean isContentCopyingAllowed()

Gets whether it is possible to copy content from PDF when it is opened with user permissions

Is CONTENT_COPYING_ALLOWED_DEFAULT by default

Returns:

true if content is allowed to copy, otherwise false

setContentCopyingAllowed

public PdfEncryptionProperties setContentCopyingAllowed(boolean contentCopyingAllowed)

Sets whether it is possible to copy content from PDF when it is opened with user permissions

Is CONTENT_COPYING_ALLOWED_DEFAULT by default

Parameters:

contentCopyingAllowed - true to allow to copy content, otherwise false

Returns:

instance of this PdfEncryptionProperties class for chaining

isEditingAllowed

public boolean isEditingAllowed()

Gets whether it is possible to edit content in PDF (including annotations) when it is opened with user permissions

Is EDITING_ALLOWED_DEFAULT by default

Returns:

true if editing is allowed, otherwise false

setEditingAllowed

public PdfEncryptionProperties setEditingAllowed(boolean editingAllowed)

Sets whether it is possible to edit content in PDF (including annotations) when it is opened with user permissions

Is EDITING_ALLOWED_DEFAULT by default

Parameters:

editingAllowed - true to allow to edit, otherwise false

Returns:

instance of this PdfEncryptionProperties class for chaining

isScreenReaderAccessAllowed

public boolean isScreenReaderAccessAllowed()

Gets whether it is possible for screen reader to access content in PDF when it is opened with user permissions

Is SCREEN_READER_ACCESS_ALLOWED_DEFAULT by default

Returns:

true if screen reader access is allowed, otherwise false

setScreenReaderAccessAllowed

public PdfEncryptionProperties setScreenReaderAccessAllowed(boolean screenReaderAccessAllowed)

Sets whether it is possible for screen reader to access content in PDF when it is opened with user permissions

Is SCREEN_READER_ACCESS_ALLOWED_DEFAULT by default

Parameters:

screenReaderAccessAllowed - true to allow screen reader access, otherwise false

Returns:

instance of this PdfEncryptionProperties class for chaining