com.adobe.pdfservices.operation.pdfops

Class RemoveProtectionOperation

java.lang.Object

com.adobe.pdfservices.operation.pdfops.RemoveProtectionOperation

All Implemented Interfaces:

Operation

public class RemoveProtectionOperation
extends Object
implements Operation

An operation that allows to remove password security from a PDF document.

Sample Usage:

   RemoveProtectionOperation removeProtectionOperation = RemoveProtectionOperation.createNew();
   removeProtectionOperation.setInput(FileRef.createFromLocalFile("~/Documents/removeProtectionInput.pdf",
                                                             RemoveProtectionOperation.SupportedSourceFormat.PDF.getMediaType()));
   removeProtectionOperation.setPassword("password");
   Credentials credentials = Credentials.servicePrincipalCredentialsBuilder()
                                        .withClientId("PDF_SERVICES_CLIENT_ID")
                                        .withClientSecret("PDF_SERVICES_CLIENT_SECRET")
                                        .build();
   FileRef result = removeProtectionOperation.execute(ExecutionContext.create(credentials));
   result.saveAs("output/removeProtectionOutput.pdf");
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static RemoveProtectionOperation	createNew() Constructs a RemoveProtectionOperation 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.
void	setPassword(String password) Specifies the intended password depending on the type of password security attached to the input PDF document.

Methods inherited from class java.lang.Object

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

Method Detail

createNew

public static RemoveProtectionOperation createNew()

Constructs a RemoveProtectionOperation instance.

Returns:

a new RemoveProtectionOperation instance

setInput

public void setInput(FileRef sourceFileRef)

Sets an input file.

Parameters:

sourceFileRef - an input file; can not be null

setPassword

public void setPassword(String password)

Specifies the intended password depending on the type of password security attached to the input PDF document.

Parameters:

password - password for the removal of security of the input PDF file; can not be null or empty

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