Skip navigation links
PDF Tools SDK
A B C D E F G H I L O P R S T V W 

A

addAll() - Method in class com.adobe.platform.operation.pdfops.options.PageRanges
Adds a page range representing all pages.
addAllFrom(int) - Method in class com.adobe.platform.operation.pdfops.options.PageRanges
Adds a page range from start page index to the last page.
addInput(FileRef) - Method in class com.adobe.platform.operation.pdfops.CombineFilesOperation
Specifies a PDF file (media type "application/pdf") to be combined with other files.
addInput(FileRef, PageRanges) - Method in class com.adobe.platform.operation.pdfops.CombineFilesOperation
Specifies particular pages of a PDF file (media type "application/pdf") to be combined with other files.
addPagesForReplace(FileRef, int) - Method in class com.adobe.platform.operation.pdfops.ReplacePagesOperation
Adds all the pages of the input PDF file for replacing the page of the base PDF file.
addPagesForReplace(FileRef, PageRanges, int) - Method in class com.adobe.platform.operation.pdfops.ReplacePagesOperation
Adds the specified pages of the input PDF file for replacing the page of the base PDF file.
addPagesToInsertAt(FileRef, int) - Method in class com.adobe.platform.operation.pdfops.InsertPagesOperation
Adds all the pages of the input PDF file to be inserted at the specified page of the base PDF file.
addPagesToInsertAt(FileRef, PageRanges, int) - Method in class com.adobe.platform.operation.pdfops.InsertPagesOperation
Adds the specified pages of the input PDF file to be inserted at the specified page of the base PDF file
addRange(int, int) - Method in class com.adobe.platform.operation.pdfops.options.PageRanges
Adds a page range.
addSinglePage(int) - Method in class com.adobe.platform.operation.pdfops.options.PageRanges
Adds a single page.
Angle - Enum in com.adobe.platform.operation.pdfops.options.rotatepages
Supported rotation angle values for RotatePagesOperation

B

build() - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials.Builder
Returns a new ServiceAccountCredentials instance built from the current state of this builder.
build() - Method in class com.adobe.platform.operation.ClientConfig.Builder
Returns a new ClientConfig instance built from the current state of this builder.
build() - Method in class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions.Builder
Returns a new CreatePDFFromHTMLOptions instance built from the current state of this builder.
build() - Method in class com.adobe.platform.operation.pdfops.options.ocr.OCROptions.Builder
Returns a new OCROptions instance built from the current state of this builder.
build() - Method in class com.adobe.platform.operation.pdfops.options.protectpdf.PasswordProtectOptions.Builder
Returns a new PasswordProtectOptions instance built from the current state of this builder.
Builder() - Constructor for class com.adobe.platform.operation.auth.ServiceAccountCredentials.Builder
Constructs a Builder instance.
builder() - Static method in class com.adobe.platform.operation.ClientConfig
Creates a new ClientConfig builder.
Builder() - Constructor for class com.adobe.platform.operation.ClientConfig.Builder
Constructs a Builder instance.
Builder() - Constructor for class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions.Builder
Constructs a Builder instance.
Builder() - Constructor for class com.adobe.platform.operation.pdfops.options.ocr.OCROptions.Builder
Constructs a OCROptions.Builder instance.
Builder() - Constructor for class com.adobe.platform.operation.pdfops.options.protectpdf.PasswordProtectOptions.Builder
Constructs a Builder instance.

C

ClientConfig - Class in com.adobe.platform.operation
Encapsulates the API request configurations
ClientConfig() - Constructor for class com.adobe.platform.operation.ClientConfig
 
ClientConfig.Builder - Class in com.adobe.platform.operation
Builds a ClientConfig instance.
com.adobe.platform.operation - package com.adobe.platform.operation
Contains the classes and sub-packages for various operations.
com.adobe.platform.operation.auth - package com.adobe.platform.operation.auth
Contains the classes for all types of credentials supported by PDF Tools API.
com.adobe.platform.operation.exception - package com.adobe.platform.operation.exception
Contains the classes for various exceptions that can be thrown by an Operation.
com.adobe.platform.operation.io - package com.adobe.platform.operation.io
Contains the classes for providing input or receiving the output of an Operation.
com.adobe.platform.operation.pdfops - package com.adobe.platform.operation.pdfops
Contains the classes for operations that generate or transform PDF files.
com.adobe.platform.operation.pdfops.options - package com.adobe.platform.operation.pdfops.options
Contains the option classes and sub-packages for Operation implementations in the com.adobe.platform.operation.pdfops package.
com.adobe.platform.operation.pdfops.options.createpdf - package com.adobe.platform.operation.pdfops.options.createpdf
Contains the option classes for CreatePDFOperation.
com.adobe.platform.operation.pdfops.options.exportpdf - package com.adobe.platform.operation.pdfops.options.exportpdf
Contains the option classes for ExportPDFOperation.
com.adobe.platform.operation.pdfops.options.ocr - package com.adobe.platform.operation.pdfops.options.ocr
Contains the option classes for OCROperation.
com.adobe.platform.operation.pdfops.options.protectpdf - package com.adobe.platform.operation.pdfops.options.protectpdf
Contains the option classes for ProtectPDFOperation.
com.adobe.platform.operation.pdfops.options.rotatepages - package com.adobe.platform.operation.pdfops.options.rotatepages
Contains the option classes for RotatePagesOperation.
CombineFilesOperation - Class in com.adobe.platform.operation.pdfops
Combines multiple PDF files into a single PDF file.
CombineFilesOperation.SupportedSourceFormat - Enum in com.adobe.platform.operation.pdfops
Supported source file formats for CombineFilesOperation.
CompressPDFOperation - Class in com.adobe.platform.operation.pdfops
An operation that reduces the size of a PDF file.
CompressPDFOperation.SupportedSourceFormat - Enum in com.adobe.platform.operation.pdfops
Supported source file formats for CompressPDFOperation.
create(Credentials) - Static method in class com.adobe.platform.operation.ExecutionContext
Creates a context instance using the provided Credentials.
create(Credentials, ClientConfig) - Static method in class com.adobe.platform.operation.ExecutionContext
Creates a context instance using the provided Credentials and ClientConfig
createFromLocalFile(String, String) - Static method in class com.adobe.platform.operation.io.FileRef
Creates a FileRef instance from a local file path with an explicitly specified media type.
createFromLocalFile(String) - Static method in class com.adobe.platform.operation.io.FileRef
Creates a FileRef instance from a local file path where the media type can be inferred from the file extension.
createFromStream(InputStream, String) - Static method in class com.adobe.platform.operation.io.FileRef
Creates a FileRef instance from an input stream using the specified media type.
createNew() - Static method in class com.adobe.platform.operation.pdfops.CombineFilesOperation
Constructs a CombineFilesOperation instance.
createNew() - Static method in class com.adobe.platform.operation.pdfops.CompressPDFOperation
Constructs a CompressPDFOperation instance.
createNew() - Static method in class com.adobe.platform.operation.pdfops.CreatePDFOperation
Constructs a CreatePDFOperation instance.
createNew() - Static method in class com.adobe.platform.operation.pdfops.DeletePagesOperation
Constructs a DeletePagesOperation instance.
createNew(ExportPDFTargetFormat) - Static method in class com.adobe.platform.operation.pdfops.ExportPDFOperation
Constructs a ExportPDFOperation instance.
createNew() - Static method in class com.adobe.platform.operation.pdfops.InsertPagesOperation
Constructs a InsertPagesOperation instance.
createNew() - Static method in class com.adobe.platform.operation.pdfops.LinearizePDFOperation
Constructs a LinearizePDFOperation instance.
createNew() - Static method in class com.adobe.platform.operation.pdfops.OCROperation
Constructs a OCROperation instance.
createNew(ProtectPDFOptions) - Static method in class com.adobe.platform.operation.pdfops.ProtectPDFOperation
Constructs a ProtectPDFOperation instance.
createNew() - Static method in class com.adobe.platform.operation.pdfops.ReorderPagesOperation
Constructs a ReorderPagesOperation instance.
createNew() - Static method in class com.adobe.platform.operation.pdfops.ReplacePagesOperation
Constructs a ReplacePagesOperation instance.
createNew() - Static method in class com.adobe.platform.operation.pdfops.RotatePagesOperation
Constructs a RotatePagesOperation instance.
CreatePDFFromHTMLOptions - Class in com.adobe.platform.operation.pdfops.options.createpdf
Parameters for converting HTML to PDF using CreatePDFOperation.
CreatePDFFromHTMLOptions.Builder - Class in com.adobe.platform.operation.pdfops.options.createpdf
Builds a CreatePDFFromHTMLOptions instance.
CreatePDFOperation - Class in com.adobe.platform.operation.pdfops
An operation that converts a non-PDF file to a PDF file.
CreatePDFOperation.SupportedSourceFormat - Enum in com.adobe.platform.operation.pdfops
Supported source file formats for CreatePDFOperation.
CreatePDFOptions - Class in com.adobe.platform.operation.pdfops.options.createpdf
Marker base class for CreatePDFOperation options.
CreatePDFOptions() - Constructor for class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFOptions
 
Credentials - Class in com.adobe.platform.operation.auth
Marker base class for different types of credentials.
Credentials() - Constructor for class com.adobe.platform.operation.auth.Credentials
 

D

DEFAULT_STATUS_CODE - Variable in exception com.adobe.platform.operation.exception.ServiceApiException
the default value of status code if there is no status code for this service failure.
DEFAULT_STATUS_CODE - Variable in exception com.adobe.platform.operation.exception.ServiceUsageException
the default value of status code if there is no status code for this service failure.
DeletePagesOperation - Class in com.adobe.platform.operation.pdfops
An operation to delete pages in a PDF file.
DeletePagesOperation.SupportedSourceFormat - Enum in com.adobe.platform.operation.pdfops
Supported source file formats for DeletePagesOperation.

E

EncryptionAlgorithm - Enum in com.adobe.platform.operation.pdfops.options.protectpdf
Supported encryption algorithms for ProtectPDFOperation
execute(ExecutionContext) - Method in interface com.adobe.platform.operation.Operation
Executes this operation synchronously using the provided context instance.
execute(ExecutionContext) - Method in class com.adobe.platform.operation.pdfops.CombineFilesOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting file.
execute(ExecutionContext) - Method in class com.adobe.platform.operation.pdfops.CompressPDFOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.platform.operation.pdfops.CreatePDFOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.platform.operation.pdfops.DeletePagesOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.platform.operation.pdfops.ExportPDFOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting file.
execute(ExecutionContext) - Method in class com.adobe.platform.operation.pdfops.InsertPagesOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.platform.operation.pdfops.LinearizePDFOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.platform.operation.pdfops.OCROperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.platform.operation.pdfops.ProtectPDFOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.platform.operation.pdfops.ReorderPagesOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.platform.operation.pdfops.ReplacePagesOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.platform.operation.pdfops.RotatePagesOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
ExecutionContext - Class in com.adobe.platform.operation
Represents the execution context of an Operation.
ExecutionContext() - Constructor for class com.adobe.platform.operation.ExecutionContext
 
ExportPDFOperation - Class in com.adobe.platform.operation.pdfops
An operation which exports a source PDF file to a supported format specified by ExportPDFTargetFormat.
ExportPDFOperation.SupportedSourceFormat - Enum in com.adobe.platform.operation.pdfops
Supported source file formats for ExportPDFOperation.
ExportPDFTargetFormat - Enum in com.adobe.platform.operation.pdfops.options.exportpdf
Supported target formats for ExportPDFOperation

F

FileRef - Class in com.adobe.platform.operation.io
This class represents a local file.
FileRef() - Constructor for class com.adobe.platform.operation.io.FileRef
 
fromFile(String) - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials.Builder
Sets Service Account Credentials using the JSON credentials file path.
fromFile(String) - Method in class com.adobe.platform.operation.ClientConfig.Builder
Sets the connect timeout and socket timeout using the JSON client config file path.

G

getAccountId() - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials
Account ID(format: id@techacct.adobe.com)
getClaim() - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials
Identifies the Service for which Authorization(Access) Token will be issued
getClientId() - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials
Client Id (API Key)
getClientSecret() - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials
Client Secret
getDataToMerge() - Method in class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions
Returns JSON data that will be used to manipulate HTML DOM before it is converted into PDF file.
getEncryptionAlgorithm() - Method in class com.adobe.platform.operation.pdfops.options.protectpdf.PasswordProtectOptions
Returns the intended encryption algorithm of the resulting encrypted PDF file.
getFileExt() - Method in enum com.adobe.platform.operation.pdfops.options.exportpdf.ExportPDFTargetFormat
Returns the file extension of this format
getImsBaseUri() - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials
IMS Base URI of the API call to retrieve Authorization(Access) Token
getLocale() - Method in enum com.adobe.platform.operation.pdfops.options.ocr.OCRSupportedLocale
Returns the language code of this OCRSupportedLocale
getMediaType() - Method in enum com.adobe.platform.operation.pdfops.CombineFilesOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.platform.operation.pdfops.CompressPDFOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.platform.operation.pdfops.CreatePDFOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.platform.operation.pdfops.DeletePagesOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.platform.operation.pdfops.ExportPDFOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.platform.operation.pdfops.InsertPagesOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.platform.operation.pdfops.LinearizePDFOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.platform.operation.pdfops.OCROperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.platform.operation.pdfops.ProtectPDFOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.platform.operation.pdfops.ReorderPagesOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.platform.operation.pdfops.ReplacePagesOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.platform.operation.pdfops.RotatePagesOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMessage() - Method in exception com.adobe.platform.operation.exception.ServiceApiException
Returns the detail message of this exception.
getMessage() - Method in exception com.adobe.platform.operation.exception.ServiceUsageException
Returns the detailed message for this exception.
getOCRLocale() - Method in class com.adobe.platform.operation.pdfops.options.ocr.OCROptions
Determines the input language (OCRSupportedLocale) to be used for OCR
getOCRType() - Method in class com.adobe.platform.operation.pdfops.options.ocr.OCROptions
Determines OCR Type.
getOrganizationId() - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials
Identifies the organization(format: org_ident@AdobeOrg) that has been configured for access to PDF Tools API.
getPageHeight() - Method in class com.adobe.platform.operation.pdfops.options.createpdf.PageLayout
Returns the page height in inches.
getPageLayout() - Method in class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions
Returns the intended page layout of the resulting PDF file.
getPageWidth() - Method in class com.adobe.platform.operation.pdfops.options.createpdf.PageLayout
Returns the page width in inches.
getPrivateKey() - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials
Content of the Private Key (PEM format)
getRanges() - Method in class com.adobe.platform.operation.pdfops.options.PageRanges
Used internally by this SDK, not intended to be called by clients.
getRequestTrackingId() - Method in exception com.adobe.platform.operation.exception.ServiceApiException
Returns the Request ID (the value of the X-Request-ID header).
getRequestTrackingId() - Method in exception com.adobe.platform.operation.exception.ServiceUsageException
Returns the Request ID (the value of the X-Request-ID header).
getStatusCode() - Method in exception com.adobe.platform.operation.exception.ServiceApiException
Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn't adequately represent the error.
getStatusCode() - Method in exception com.adobe.platform.operation.exception.ServiceUsageException
Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn't adequately represent the error.
getType() - Method in enum com.adobe.platform.operation.pdfops.options.ocr.OCRSupportedType
Returns the string representation of this OCRSupportedType
getUserPassword() - Method in class com.adobe.platform.operation.pdfops.options.protectpdf.PasswordProtectOptions
Returns the intended user password of the resulting encrypted PDF file.
getValue() - Method in enum com.adobe.platform.operation.pdfops.options.protectpdf.EncryptionAlgorithm
Returns the value of this encryption algorithm
getValue() - Method in enum com.adobe.platform.operation.pdfops.options.rotatepages.Angle
Returns the value of this angle

H

htmlOptionsBuilder() - Static method in class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFOptions
Creates a new CreatePDFFromHTMLOptions builder.

I

includeHeaderFooter(boolean) - Method in class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions.Builder
Sets the includeHeaderFooter parameter.
includesHeaderFooter() - Method in class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions
Returns true if default header and footer will be included in the resulting PDF file.
InsertPagesOperation - Class in com.adobe.platform.operation.pdfops
An operation that can be used to insert pages of multiple PDF files into a base PDF file.
InsertPagesOperation.SupportedSourceFormat - Enum in com.adobe.platform.operation.pdfops
Supported source file formats for InsertPagesOperation.
isEmpty() - Method in class com.adobe.platform.operation.pdfops.options.PageRanges
Used internally by this SDK, not intended to be called by clients.

L

LinearizePDFOperation - Class in com.adobe.platform.operation.pdfops
An operation that converts a PDF file into a linearized (also known as "web optimized") PDF file.
LinearizePDFOperation.SupportedSourceFormat - Enum in com.adobe.platform.operation.pdfops
Supported source file formats for LinearizePDFOperation.

O

OCROperation - Class in com.adobe.platform.operation.pdfops
Convert a PDF file into a searchable PDF file.
OCROperation.SupportedSourceFormat - Enum in com.adobe.platform.operation.pdfops
Supported source file formats for OCROperation.
OCROptions - Class in com.adobe.platform.operation.pdfops.options.ocr
Parameters for converting PDF to a searchable PDF using OCROperation.
OCROptions.Builder - Class in com.adobe.platform.operation.pdfops.options.ocr
Builds a OCROptions instance.
ocrOptionsBuilder() - Static method in class com.adobe.platform.operation.pdfops.options.ocr.OCROptions
Creates a new OCROptions builder.
OCRSupportedLocale - Enum in com.adobe.platform.operation.pdfops.options.ocr
Supported locales for OCROperation
OCRSupportedType - Enum in com.adobe.platform.operation.pdfops.options.ocr
Supported OCR types for OCROperation
Operation - Interface in com.adobe.platform.operation
This interface represents the basic contract for all the Operations.

P

PageLayout - Class in com.adobe.platform.operation.pdfops.options.createpdf
Class for specifying the layout of a page.
PageLayout() - Constructor for class com.adobe.platform.operation.pdfops.options.createpdf.PageLayout
Constructor to initialize a default page layout.
PageRanges - Class in com.adobe.platform.operation.pdfops.options
Page ranges of a file, inclusive of start and end page index, where page index starts from 1.
PageRanges() - Constructor for class com.adobe.platform.operation.pdfops.options.PageRanges
Constructs a new PageRanges instance with no pages added.
PasswordProtectOptions - Class in com.adobe.platform.operation.pdfops.options.protectpdf
Parameters for securing PDF file with a password using ProtectPDFOperation.
PasswordProtectOptions.Builder - Class in com.adobe.platform.operation.pdfops.options.protectpdf
Builds a PasswordProtectOptions instance.
passwordProtectOptionsBuilder() - Static method in class com.adobe.platform.operation.pdfops.options.protectpdf.ProtectPDFOptions
Creates a new PasswordProtectOptions builder.
ProtectPDFOperation - Class in com.adobe.platform.operation.pdfops
An operation that converts a PDF file into a password protected PDF file.
ProtectPDFOperation.SupportedSourceFormat - Enum in com.adobe.platform.operation.pdfops
Supported source file formats for ProtectPDFOperation.
ProtectPDFOptions - Class in com.adobe.platform.operation.pdfops.options.protectpdf
Marker base class for ProtectPDFOperation options.
ProtectPDFOptions() - Constructor for class com.adobe.platform.operation.pdfops.options.protectpdf.ProtectPDFOptions
 

R

ReorderPagesOperation - Class in com.adobe.platform.operation.pdfops
An operation that allows to rearrange pages in a PDF file according to the specified order.
ReorderPagesOperation.SupportedSourceFormat - Enum in com.adobe.platform.operation.pdfops
Supported source file formats for ReorderPagesOperation.
ReplacePagesOperation - Class in com.adobe.platform.operation.pdfops
An operation that allows specific pages in a PDF file to be replaced with pages from multiple PDF files.
ReplacePagesOperation.SupportedSourceFormat - Enum in com.adobe.platform.operation.pdfops
Supported source file formats for ReplacePagesOperation.
RotatePagesOperation - Class in com.adobe.platform.operation.pdfops
An operation that allows rotation of specific pages in a PDF file.
RotatePagesOperation.SupportedSourceFormat - Enum in com.adobe.platform.operation.pdfops
Supported source file formats for RotatePagesOperation.

S

saveAs(String) - Method in class com.adobe.platform.operation.io.FileRef
Saves this file to the location specified by targetLocation.
saveAs(OutputStream) - Method in class com.adobe.platform.operation.io.FileRef
Writes the contents of this file to outputStream.
SdkException - Exception in com.adobe.platform.operation.exception
SdkException is typically thrown for client-side or network errors.
SdkException(String, Throwable) - Constructor for exception com.adobe.platform.operation.exception.SdkException
Creates an SdkException with the specified detail message and cause.
SdkException(String) - Constructor for exception com.adobe.platform.operation.exception.SdkException
Constructs an SdkException with the specified detail message.
ServiceAccountCredentials - Class in com.adobe.platform.operation.auth
Service Account credentials allow your application to call PDF Tools API on behalf of the application itself, or on behalf of an enterprise organization.
ServiceAccountCredentials.Builder - Class in com.adobe.platform.operation.auth
Builds a ServiceAccountCredentials instance.
serviceAccountCredentialsBuilder() - Static method in class com.adobe.platform.operation.auth.Credentials
Creates a new ServiceAccountCredentials builder.
ServiceApiException - Exception in com.adobe.platform.operation.exception
ServiceApiException is thrown when an underlying service API call results in an error.
ServiceApiException(String) - Constructor for exception com.adobe.platform.operation.exception.ServiceApiException
Constructs a ServiceApiException with the specified detail message.
ServiceApiException(String, String, int) - Constructor for exception com.adobe.platform.operation.exception.ServiceApiException
Constructs a ServiceApiException with the specified detail message, requestId and returned HTTP status code.
ServiceUsageException - Exception in com.adobe.platform.operation.exception
ServiceUsageException is thrown when either Service usage limit has been reached or credentials quota has been exhausted.
ServiceUsageException(String) - Constructor for exception com.adobe.platform.operation.exception.ServiceUsageException
Constructs a ServiceUsageException with the specified detail message.
ServiceUsageException(String, String, int) - Constructor for exception com.adobe.platform.operation.exception.ServiceUsageException
Constructs a ServiceUsageException with the specified detail message, requestId and returned HTTP status code.
setAngleToRotatePagesBy(Angle) - Method in class com.adobe.platform.operation.pdfops.RotatePagesOperation
Sets angle (in clockwise direction) for rotating all the pages of the input PDF file.
setAngleToRotatePagesBy(Angle, PageRanges) - Method in class com.adobe.platform.operation.pdfops.RotatePagesOperation
Sets angle (in clockwise direction) for rotating the specified pages of the input PDF file; can be invoked multiple times to set rotation for different set of page ranges.
setBaseInput(FileRef) - Method in class com.adobe.platform.operation.pdfops.InsertPagesOperation
Sets the base input file.
setBaseInput(FileRef) - Method in class com.adobe.platform.operation.pdfops.ReplacePagesOperation
Sets the base input file.
setEncryptionAlgorithm(EncryptionAlgorithm) - Method in class com.adobe.platform.operation.pdfops.options.protectpdf.PasswordProtectOptions.Builder
Sets the intended encryption algorithm required for encrypting the PDF file.
setInput(FileRef) - Method in class com.adobe.platform.operation.pdfops.CompressPDFOperation
Sets an input file.
setInput(FileRef) - Method in class com.adobe.platform.operation.pdfops.CreatePDFOperation
Sets an input file.
setInput(FileRef) - Method in class com.adobe.platform.operation.pdfops.DeletePagesOperation
Sets an input file.
setInput(FileRef) - Method in class com.adobe.platform.operation.pdfops.ExportPDFOperation
Sets an input PDF file (media type "application/pdf").
setInput(FileRef) - Method in class com.adobe.platform.operation.pdfops.LinearizePDFOperation
Sets an input file.
setInput(FileRef) - Method in class com.adobe.platform.operation.pdfops.OCROperation
Sets an input file.
setInput(FileRef) - Method in class com.adobe.platform.operation.pdfops.ProtectPDFOperation
Sets an input file.
setInput(FileRef) - Method in class com.adobe.platform.operation.pdfops.ReorderPagesOperation
Sets an input file.
setInput(FileRef) - Method in class com.adobe.platform.operation.pdfops.RotatePagesOperation
Sets an input file.
setOptions(CreatePDFOptions) - Method in class com.adobe.platform.operation.pdfops.CreatePDFOperation
Sets the conversion parameters for this operation.
setOptions(OCROptions) - Method in class com.adobe.platform.operation.pdfops.OCROperation
Sets the options for this operation.
setPageRanges(PageRanges) - Method in class com.adobe.platform.operation.pdfops.DeletePagesOperation
Specifies the pages to delete from the input PDF file
setPageSize(double, double) - Method in class com.adobe.platform.operation.pdfops.options.createpdf.PageLayout
Sets a custom page size.
setPagesOrder(PageRanges) - Method in class com.adobe.platform.operation.pdfops.ReorderPagesOperation
Sets the order of the pages.
setUserPassword(String) - Method in class com.adobe.platform.operation.pdfops.options.protectpdf.PasswordProtectOptions.Builder
Sets the intended user password required for encrypting the PDF file.

T

toString() - Method in class com.adobe.platform.operation.pdfops.options.PageRanges
Used internally by this SDK, not intended to be called by clients.

V

validate() - Method in class com.adobe.platform.operation.pdfops.options.PageRanges
Used internally by this SDK, not intended to be called by clients.
valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.CombineFilesOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.CompressPDFOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.CreatePDFOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.DeletePagesOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.ExportPDFOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.InsertPagesOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.LinearizePDFOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.OCROperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.options.exportpdf.ExportPDFTargetFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.options.ocr.OCRSupportedLocale
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.options.ocr.OCRSupportedType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.options.protectpdf.EncryptionAlgorithm
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.options.rotatepages.Angle
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.ProtectPDFOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.ReorderPagesOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.ReplacePagesOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.RotatePagesOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.adobe.platform.operation.pdfops.CombineFilesOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.platform.operation.pdfops.CompressPDFOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.platform.operation.pdfops.CreatePDFOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.platform.operation.pdfops.DeletePagesOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.platform.operation.pdfops.ExportPDFOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.platform.operation.pdfops.InsertPagesOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.platform.operation.pdfops.LinearizePDFOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.platform.operation.pdfops.OCROperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.platform.operation.pdfops.options.exportpdf.ExportPDFTargetFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.platform.operation.pdfops.options.ocr.OCRSupportedLocale
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.platform.operation.pdfops.options.ocr.OCRSupportedType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.platform.operation.pdfops.options.protectpdf.EncryptionAlgorithm
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.platform.operation.pdfops.options.rotatepages.Angle
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.platform.operation.pdfops.ProtectPDFOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.platform.operation.pdfops.ReorderPagesOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.platform.operation.pdfops.ReplacePagesOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.platform.operation.pdfops.RotatePagesOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.

W

withAccountId(String) - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials.Builder
Set Account Id (format: id@techacct.adobe.com)
withClientId(String) - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials.Builder
Set Client ID (API Key)
withClientSecret(String) - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials.Builder
Set Client Secret
withConnectTimeout(Integer) - Method in class com.adobe.platform.operation.ClientConfig.Builder
Sets the connect timeout.
withDataToMerge(JSONObject) - Method in class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions.Builder
Sets the data to be used by the javascript in the source html file to manipulate the HTML DOM before it gets converted to PDF.
withOCRLocale(OCRSupportedLocale) - Method in class com.adobe.platform.operation.pdfops.options.ocr.OCROptions.Builder
Sets input language to be used for OCR, specified by OCRSupportedLocale.
withOCRType(OCRSupportedType) - Method in class com.adobe.platform.operation.pdfops.options.ocr.OCROptions.Builder
Sets OCR type, specified by OCRSupportedType
withOrganizationId(String) - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials.Builder
Set Organization Id (format: org_ident@AdobeOrg) that has been configured for access to PDF Tools API
withPageLayout(PageLayout) - Method in class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions.Builder
Sets the pageLayout parameter.
withPrivateKey(String) - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials.Builder
Set private key
withSocketTimeout(Integer) - Method in class com.adobe.platform.operation.ClientConfig.Builder
Sets the socket timeout.
A B C D E F G H I L O P R S T V W 
Skip navigation links
PDF Tools SDK

Copyright © 2020 Adobe. All rights reserved.