com.adobe.livecycle.encryption.client
Class CertificateEncryptionOptionSpec

java.lang.Object
  extended by com.adobe.livecycle.encryption.client.CertificateEncryptionOptionSpec
All Implemented Interfaces:
java.io.Serializable

public class CertificateEncryptionOptionSpec
extends java.lang.Object
implements java.io.Serializable

Specifies encryption preferences that are used when encrypting a PDF document with a certificate. Using this object, you can specify whether to encrypt the entire PDF document, everything except for the documents metadata, or just the documents attachments. Also, you can specify the Acrobat version that is compatiable with the encrypted PDF document.

To see an object of this type used in a code example, see the Encrypting a PDF document with a certificate using the Java API quick start in Programming with Adobe Experience Manager forms.

See Also:
Serialized Form

Constructor Summary
CertificateEncryptionOptionSpec()
           
 
Method Summary
 CertificateEncryptionCompatibility getCompat()
          Specifies the earliest version of Acrobat for which the encryption is compatible.
 CertificateEncryptionOption getOption()
          Gets the PDF document resources to encrypt as a CertificateEncryptionOption enumeration value.
 void setCompat(CertificateEncryptionCompatibility compat)
          Sets the version compatibility to use when encrypting a PDF document with a certificate.
 void setOption(CertificateEncryptionOption option)
          Sets the PDF document resources to encrypt as a CertificateEncryptionOption enumeration value.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CertificateEncryptionOptionSpec

public CertificateEncryptionOptionSpec()
Method Detail

getCompat

public CertificateEncryptionCompatibility getCompat()
Specifies the earliest version of Acrobat for which the encryption is compatible.

Returns:
A CertificateEncryptionCompatibility enumeration value that specifies the earliest version of Acrobat for which the encryption is compatible.

setCompat

public void setCompat(CertificateEncryptionCompatibility compat)
Sets the version compatibility to use when encrypting a PDF document with a certificate.

To see this method in a code example, see the Encrypting a PDF document with a certificate using the Java API quick start in Programming with Adobe Experience Manager forms.

Parameters:
compat - A CertificateEncryptionCompatibility enumeration value that specifies the earliest version of Acrobat for which the encryption is compatible.

getOption

public CertificateEncryptionOption getOption()
Gets the PDF document resources to encrypt as a CertificateEncryptionOption enumeration value.

Returns:
A CertificateEncryptionOption enumeration value that specifies the PDF document resources to encrypt.

setOption

public void setOption(CertificateEncryptionOption option)
Sets the PDF document resources to encrypt as a CertificateEncryptionOption enumeration value.

To see this method in a code example, see the Encrypting a PDF document with a certificate using the Java API quick start in Programming with Adobe Experience Manager forms.

Parameters:
option - A CertificateEncryptionOption enumeration value that specifies the PDF document resources to encrypt.