com.adobe.livecycle.encryption.client
Class BasePasswordEncryptionSpec

java.lang.Object
  com.adobe.livecycle.encryption.client.BasePasswordEncryptionSpec

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

PasswordEncryptionOptionSpec

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

Specifies encryption perferences for password protecting a PDF document using the LiveCycle Encryption service. To see an object of this type used in a code example, see the Encrypting a PDF document using the Java API quick start in Programming with LiveCycle ES4.

See Also:

Serialized Form

Constructor Summary

BasePasswordEncryptionSpec()
A standard constructor that creates a BasePasswordEncryptionSpec object.

BasePasswordEncryptionSpec(java.lang.String documentOpenPassword, java.lang.String permissionsPassword)
Constructs a BasePasswordEncryptionSpec object that is used to encrypt a PDF document with a password.

Method Summary

java.lang.String	getDocumentOpenPassword() Gets the password value that is used to open the password-encrypted PDF document.
java.lang.String	getPermissionPassword() Gets the password value that is used to modify permissions or remove password-based encryption from the PDF document.
java.util.List	getPermissionsRequested() Gets the permissions that are applicable to users that open a password-encrypted PDF document within Adobe Reader or Acrobat.
void	setDocumentOpenPassword(java.lang.String password) Sets the password value that is used to open the password-encrypted PDF document.
void	setPermissionPassword(java.lang.String password) Sets the password value that is used to modify permissions or remove password-based encryption from the PDF document.
void	setPermissionsRequested(java.util.List p) Sets the permissions that are applicable to users that open a password-encrypted PDF document within Adobe Reader or Acrobat.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasePasswordEncryptionSpec

public BasePasswordEncryptionSpec()

A standard constructor that creates a BasePasswordEncryptionSpec object.

BasePasswordEncryptionSpec

public BasePasswordEncryptionSpec(java.lang.String documentOpenPassword,
                                  java.lang.String permissionsPassword)

Constructs a BasePasswordEncryptionSpec object that is used to encrypt a PDF document with a password.

Parameters:

documentOpenPassword - The password value that is required to open a password-encrypted PDF document.

permissionsPassword - The password value that is required to modify permissions on the document or remove encryption.

Method Detail

setPermissionsRequested

public final void setPermissionsRequested(java.util.List p)

Sets the permissions that are applicable to users that open a password-encrypted PDF document within Adobe Reader or Acrobat. Each permission is a PasswordEncryptionPermission enumeration value. To see this method used in a code example, see the Encrypting a PDF document using the Java API quick start in Programming with LiveCycle ES4.

Parameters:

p - A java.util.List object of PasswordEncryptionPermission constants that define the permissions.

getPermissionsRequested

public final java.util.List getPermissionsRequested()

Gets the permissions that are applicable to users that open a password-encrypted PDF document within Adobe Reader or Acrobat.

Returns:

A java.util.List of PasswordEncryptionPermission constants that define the permissions.

getDocumentOpenPassword

public final java.lang.String getDocumentOpenPassword()

Gets the password value that is used to open the password-encrypted PDF document.

Returns:

The password value that is used to open the password-encrypted PDF document.

setDocumentOpenPassword

public final void setDocumentOpenPassword(java.lang.String password)

Sets the password value that is used to open the password-encrypted PDF document. To see this method used in a code example, see the Encrypting a PDF document using the Java API quick start in Programming with LiveCycle ES4.

Parameters:

password - The password value that is used to open the password-encrypted PDF document.

getPermissionPassword

public final java.lang.String getPermissionPassword()

Gets the password value that is used to modify permissions or remove password-based encryption from the PDF document.

Returns:

The password value that is used to modify permissions or remove password-based encryption from the PDF document.

setPermissionPassword

public final void setPermissionPassword(java.lang.String password)

Sets the password value that is used to modify permissions or remove password-based encryption from the PDF document. To see this method used in a code example, see the Encrypting a PDF document using the Java API quick start in Programming with LiveCycle ES4.

Parameters:

password - The password value that is used to modify permissions or remove password-based encryption from the PDF document.