Package com.itextpdf.kernel.pdf

Class ReaderProperties

java.lang.Object

com.itextpdf.kernel.pdf.ReaderProperties

public class ReaderProperties
extends java.lang.Object

The class representing various properties used to read PDF documents.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.security.cert.Certificate	certificate
protected java.security.Key	certificateKey
protected java.lang.String	certificateKeyProvider
protected IExternalDecryptionProcess	externalDecryptionProcess
protected MemoryLimitsAwareHandler	memoryLimitsAwareHandler
protected byte[]	password

Constructor Summary

Constructors

Constructor	Description
ReaderProperties()	Creates an instance of ReaderProperties.
ReaderProperties(ReaderProperties readerProperties)

Method Summary

Modifier and Type	Method	Description
private void	clearEncryptionParams()
ReaderProperties	setMemoryLimitsAwareHandler(MemoryLimitsAwareHandler memoryLimitsAwareHandler)	Sets the memory handler which will be used to handle decompressed PDF streams.
ReaderProperties	setPassword(byte[] password)	Defines the password which will be used if the document is encrypted with standard encryption.
ReaderProperties	setPublicKeySecurityParams(java.security.cert.Certificate certificate, IExternalDecryptionProcess externalDecryptionProcess)	Defines the certificate which will be used if the document is encrypted with public key encryption (see Pdf 1.7 specification, 7.6.4.
ReaderProperties	setPublicKeySecurityParams(java.security.cert.Certificate certificate, java.security.Key certificateKey, java.lang.String certificateKeyProvider, IExternalDecryptionProcess externalDecryptionProcess)	Defines the certificate which will be used if the document is encrypted with public key encryption (see Pdf 1.7 specification, 7.6.4.

Methods inherited from class java.lang.Object

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

Field Detail

password

protected byte[] password

certificateKey

protected java.security.Key certificateKey

certificate

protected java.security.cert.Certificate certificate

certificateKeyProvider

protected java.lang.String certificateKeyProvider

externalDecryptionProcess

protected IExternalDecryptionProcess externalDecryptionProcess

memoryLimitsAwareHandler

protected MemoryLimitsAwareHandler memoryLimitsAwareHandler

Constructor Detail

ReaderProperties

public ReaderProperties()

Creates an instance of ReaderProperties.

ReaderProperties

ReaderProperties(ReaderProperties readerProperties)

Method Detail

setPassword

public ReaderProperties setPassword(byte[] password)

Defines the password which will be used if the document is encrypted with standard encryption. This could be either user or owner password.

Parameters:

password - the password to use in order to open the document

Returns:

this ReaderProperties instance

setPublicKeySecurityParams

public ReaderProperties setPublicKeySecurityParams(java.security.cert.Certificate certificate,
                                                   java.security.Key certificateKey,
                                                   java.lang.String certificateKeyProvider,
                                                   IExternalDecryptionProcess externalDecryptionProcess)

Defines the certificate which will be used if the document is encrypted with public key encryption (see Pdf 1.7 specification, 7.6.4. Public-Key Security Handlers)

Parameters:

certificate - the recipient Certificate, serves as recipient identifier

certificateKey - the recipient private Key to the certificate

certificateKeyProvider - the certificate key provider id for Security.getProvider(String)

externalDecryptionProcess - the external decryption process to be used

Returns:

this ReaderProperties instance

setPublicKeySecurityParams

public ReaderProperties setPublicKeySecurityParams(java.security.cert.Certificate certificate,
                                                   IExternalDecryptionProcess externalDecryptionProcess)

Defines the certificate which will be used if the document is encrypted with public key encryption (see Pdf 1.7 specification, 7.6.4. Public-Key Security Handlers)

Parameters:

certificate - the recipient Certificate, serves as recipient identifier

externalDecryptionProcess - the external decryption process to be used

Returns:

this ReaderProperties instance

setMemoryLimitsAwareHandler

public ReaderProperties setMemoryLimitsAwareHandler(MemoryLimitsAwareHandler memoryLimitsAwareHandler)

Sets the memory handler which will be used to handle decompressed PDF streams.

Parameters:

memoryLimitsAwareHandler - the memory handler which will be used to handle decompressed PDF streams

Returns:

this ReaderProperties instance

clearEncryptionParams

private void clearEncryptionParams()