Foxit PDF SDK
com.foxit.sdk.pdf.CertificateSecurityHandler Class Reference
Inheritance diagram for com.foxit.sdk.pdf.CertificateSecurityHandler:
com.foxit.sdk.pdf.SecurityHandler com.foxit.sdk.common.Base

Public Member Functions

 CertificateSecurityHandler ()
 Constructor.
 
 CertificateSecurityHandler (SecurityHandler other)
 Constructor, with parent class object. More...
 
synchronized void delete ()
 Clean up related C++ resources immediately. More...
 
boolean initialize (CertificateEncryptData encrypt_data, byte[] encrypt_key) throws com.foxit.sdk.PDFException
 Initialize current certificate security handler. More...
 
- Public Member Functions inherited from com.foxit.sdk.pdf.SecurityHandler
 SecurityHandler ()
 Constructor.
 
 SecurityHandler (SecurityHandler other)
 Constructor, with another security handler object. More...
 
synchronized void delete ()
 Clean up related C++ resources immediately. More...
 
int getSecurityType ()
 Get the encryption type of current security handler. More...
 
boolean isEmpty ()
 Check whether current object is empty or not. More...
 
- Public Member Functions inherited from com.foxit.sdk.common.Base
synchronized void delete ()
 Clean up related C++ resources immediately. More...
 

Additional Inherited Members

- Static Public Attributes inherited from com.foxit.sdk.pdf.SecurityHandler
static final int e_CipherAES = 2
 Use AES encryption algorithm, with the key length be 16 bytes (as AES-128) or 32 bytes (as AES-256, only supported in PDF 2.0).
 
static final int e_CipherNone = 0
 Not use encryption algorithm.
 
static final int e_CipherRC4 = 1
 Use RC4 encryption algorithm, with the key length between 5 bytes and 16 bytes.
 

Detailed Description

This class represents a certificate security handler, used for certificate encryption.

See also
SecurityHandler

Constructor & Destructor Documentation

◆ CertificateSecurityHandler()

com.foxit.sdk.pdf.CertificateSecurityHandler.CertificateSecurityHandler ( SecurityHandler  other)

Constructor, with parent class object.

Parameters
[in]otherParent class object.

Member Function Documentation

◆ delete()

synchronized void com.foxit.sdk.pdf.CertificateSecurityHandler.delete ( )

Clean up related C++ resources immediately.

Returns
None.
Note
Once this function is called, current object cannot be used anymore.

◆ initialize()

boolean com.foxit.sdk.pdf.CertificateSecurityHandler.initialize ( CertificateEncryptData  encrypt_data,
byte []  encrypt_key 
) throws com.foxit.sdk.PDFException

Initialize current certificate security handler.

Parameters
[in]encrypt_dataA certificate encrypt data object. In the encryption data, cipher type should not be com.foxit.sdk.pdf.SecurityHandler.e_CipherNone .
[in]encrypt_keyThe key for encryption.
For com.foxit.sdk.pdf.SecurityHandler.e_CipherRC4 cipher, the length of encryption key should be between 5 and 16. For com.foxit.sdk.pdf.SecurityHandler.e_CipherAES cipher, the length of encryption key should be 16 or 32.
Returns
true means success, while false means failure.