org.apache.pdfbox.pdmodel.encryption

Class PublicKeySecurityHandler

java.lang.Object

org.apache.pdfbox.pdmodel.encryption.SecurityHandler

org.apache.pdfbox.pdmodel.encryption.PublicKeySecurityHandler

public final class PublicKeySecurityHandler
extends SecurityHandler

This class implements the public key security handler described in the PDF specification.

Author:

Benoit Guillon

See Also:

to see how to protect document with this security handler.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILTER The filter name.

Fields inherited from class org.apache.pdfbox.pdmodel.encryption.SecurityHandler

encryptionKey, keyLength

Constructor Summary

Constructors

Constructor and Description
PublicKeySecurityHandler() Constructor.
PublicKeySecurityHandler(PublicKeyProtectionPolicy p) Constructor used for encryption.

Method Summary

Modifier and Type	Method and Description
boolean	hasProtectionPolicy() Returns whether a protection policy has been set.
void	prepareDocumentForEncryption(PDDocument doc) Prepare the document for encryption.
void	prepareForDecryption(PDEncryption encryption, COSArray documentIDArray, DecryptionMaterial decryptionMaterial) Prepares everything to decrypt the document.

Methods inherited from class org.apache.pdfbox.pdmodel.encryption.SecurityHandler

decrypt, decryptStream, encryptDataRC4, encryptDataRC4, encryptStream, encryptString, getCurrentAccessPermission, getKeyLength, isAES, setAES, setCurrentAccessPermission, setDecryptMetadata, setKeyLength

Methods inherited from class java.lang.Object

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

Field Detail

FILTER

public static final String FILTER

The filter name.

See Also:

Constant Field Values

Constructor Detail

PublicKeySecurityHandler

public PublicKeySecurityHandler()

Constructor.

PublicKeySecurityHandler

public PublicKeySecurityHandler(PublicKeyProtectionPolicy p)

Constructor used for encryption.

Parameters:

p - The protection policy.

Method Detail

prepareForDecryption

public void prepareForDecryption(PDEncryption encryption,
                                 COSArray documentIDArray,
                                 DecryptionMaterial decryptionMaterial)
                          throws IOException

Prepares everything to decrypt the document.

Specified by:

prepareForDecryption in class SecurityHandler

Parameters:

encryption - encryption dictionary, can be retrieved via PDDocument.getEncryption()

documentIDArray - document id which is returned via COSDocument.getDocumentID() (not used by this handler)

decryptionMaterial - Information used to decrypt the document.

Throws:

IOException - If there is an error accessing data. If verbose mode is enabled, the exception message will provide more details why the match wasn't successful.

prepareDocumentForEncryption

public void prepareDocumentForEncryption(PDDocument doc)
                                  throws IOException

Prepare the document for encryption.

Specified by:

prepareDocumentForEncryption in class SecurityHandler

Parameters:

doc - The document that will be encrypted.

Throws:

IOException - If there is an error while encrypting.

hasProtectionPolicy

public boolean hasProtectionPolicy()

Returns whether a protection policy has been set.

Specified by:

hasProtectionPolicy in class SecurityHandler

Returns:

true if a protection policy has been set.