com.adobe.pdfservices.operation.pdfops

Class ProtectPDFOperation

java.lang.Object

com.adobe.pdfservices.operation.pdfops.ProtectPDFOperation

All Implemented Interfaces:

Operation

public class ProtectPDFOperation
extends Object
implements Operation

An operation that is used for securing PDF document with password(s). The password(s) is used for encrypting the PDF document and setting the restriction on certain features like printing, editing and copying in the PDF document.

The supported algorithm for encrypting the PDF document are listed here. The EncryptionAlgorithm enum can be used to set the encryption algorithm.

• AES-128
• AES-256

For AES-128 encryption the password supports LATIN-I characters only. For AES-256 encryption the password supports Unicode character set.

Sample Usage:

   Permissions permissions = Permissions.createNew();
   permissions.addPermission(Permission.PRINT_LOW_QUALITY);
   permissions.addPermission(Permission.EDIT_DOCUMENT_ASSEMBLY);
   permissions.addPermission(Permission.COPY_CONTENT);
   ProtectPDFOptions protectPDFOptions = ProtectPDFOptions.passwordProtectOptionsBuilder()
                  .setUserPassword("openpassword")
                  .setOwnerPassword("permissionspassword")
                  .setEncryptionAlgorithm(EncryptionAlgorithm.AES_128)
                  .setContentEncryption(ContentEncryption.ALL_CONTENT_EXCEPT_METADATA)
                  .setPermissions(permissions)
                  .build();
   ProtectPDFOperation protectPDFOperation = ProtectPDFOperation.createNew(protectPDFOptions);
   protectPDFOperation.setInput(FileRef.createFromLocalFile("~/Documents/protectOperationInput.pdf",
                                                              ProtectPDFOperation.SupportedSourceFormat.PDF.getMediaType()));
   Credentials credentials = Credentials.servicePrincipalCredentialsBuilder()
                                        .withClientId("PDF_SERVICES_CLIENT_ID")
                                        .withClientSecret("PDF_SERVICES_CLIENT_SECRET")
                                        .build();
   FileRef result = protectPDFOperation.execute(ExecutionContext.create(credentials));
   result.saveAs("output/protectOperationOutput.pdf");
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProtectPDFOperation.SupportedSourceFormat Supported source file formats for ProtectPDFOperation.

Method Summary

Modifier and Type	Method and Description
static ProtectPDFOperation	createNew(ProtectPDFOptions protectPDFOptions) Constructs a ProtectPDFOperation instance.
FileRef	execute(ExecutionContext context) Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
void	setInput(FileRef sourceFileRef) Sets an input file.

Methods inherited from class java.lang.Object

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

Method Detail

createNew

public static ProtectPDFOperation createNew(ProtectPDFOptions protectPDFOptions)

Constructs a ProtectPDFOperation instance.

Parameters:

protectPDFOptions - options for securing PDF file with password(s); Cannot be null

Returns:

a new ProtectPDFOperation instance

setInput

public void setInput(FileRef sourceFileRef)

Sets an input file.

Parameters:

sourceFileRef - an input file; can not be null

execute

public FileRef execute(ExecutionContext context)
                throws ServiceApiException,
                       IOException,
                       ServiceUsageException

Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.

The resulting file may be stored in the system temporary directory (per java.io.tmpdir System property). See FileRef for how temporary resources are cleaned up.

Specified by:

execute in interface Operation

Parameters:

context - the context in which to execute the operation

Returns:

the resulting PDF file

Throws:

ServiceApiException - if an API call results in an error response

IOException - if there is an error in reading either the input source or the resulting PDF file

ServiceUsageException - if service usage limits have been reached or credentials quota has been exhausted