Module org.sejda.sambox

Package org.sejda.sambox.pdmodel.encryption

Class ProtectionPolicy

java.lang.Object

org.sejda.sambox.pdmodel.encryption.ProtectionPolicy

Direct Known Subclasses:

PublicKeyProtectionPolicy, StandardProtectionPolicy

public abstract class ProtectionPolicy
extends Object

This class represents the protection policy to apply to a document.

Objects implementing this abstract class can be passed to the protect method of PDDocument to protect a document.

Field Summary

Fields

Modifier and Type	Field	Description
private static final short	DEFAULT_KEY_LENGTH
private short	encryptionKeyLength

Constructor Summary

Constructors

Constructor	Description
ProtectionPolicy()

Method Summary

Modifier and Type	Method	Description
short	getEncryptionKeyLength()	Get the length of the secrete key that will be used to encrypt document data.
void	setEncryptionKeyLength(int l)	set the length in (bits) of the secret key that will be used to encrypt document data.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_KEY_LENGTH

private static final short DEFAULT_KEY_LENGTH

See Also:

• Constant Field Values

encryptionKeyLength

private short encryptionKeyLength

Constructor Details

ProtectionPolicy

public ProtectionPolicy()

Method Details

setEncryptionKeyLength

public void setEncryptionKeyLength(int l)

set the length in (bits) of the secret key that will be used to encrypt document data. The default value is 40 bits, which provides a low security level but is compatible with old versions of Acrobat Reader.

Parameters:

l - the length in bits (must be 40, 128 or 256)

getEncryptionKeyLength

public short getEncryptionKeyLength()

Get the length of the secrete key that will be used to encrypt document data.

Returns:

The length (in bits) of the encryption key.