|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.livecycle.pdfutility.client.PDFUtilityServiceClient
public class PDFUtilityServiceClient
Enables the creation of a Java object that invokes operations that belong to the PDF Utility service. Using this object, you can perform tasks such as converting a PDF document to an XDP file. Another task that you can perform is to query information about a PDF document. For example, you can determine whether a PDF document contains comments or attachments. For information, see Working With PDF Utility Service.
Constructor Summary | |
---|---|
PDFUtilityServiceClient(ServiceClientFactory serviceClientFactory)
Used to create an PDFUtilityService client. |
Method Summary | |
---|---|
Document |
clone(Document pdf)
Clones a PDF document. |
Document |
convertPDFtoXDP(Document pdf)
Converts a PDF document into an XDP file. |
Document |
convertXDPtoPDF(Document xdp)
Converts an XDP file into a PDF file. |
PDFPropertiesResult |
getPDFProperties(Document pdf,
PDFPropertiesOptionSpec options)
Performs queries on the specified PDF document and returns the results as a PDFPropertiesResult object. |
PDFUtilitySaveMode |
getSaveMode(Document pdf)
Returns the save mode of a PDF document. |
String |
getVersion()
Returns the PDF Utility service version. |
List |
multiclone(Document pdf,
int copies)
Clones a PDF document a specified number of times. |
RedactionResult |
redact(Document inDoc,
RedactionOptionSpec redactionOptionSpec)
|
Document |
setSaveMode(Document pdf,
PDFUtilitySaveMode saveMode,
boolean override)
Sets the save mode of a PDF document. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PDFUtilityServiceClient(ServiceClientFactory serviceClientFactory)
serviceClientFactory
- The service client factory needed to create an instance of the
PDFUtilityService client.Method Detail |
---|
public String getVersion()
public PDFPropertiesResult getPDFProperties(Document pdf, PDFPropertiesOptionSpec options) throws PDFUtilityException
PDFPropertiesResult
object.
pdf
- A Document
object that represents the PDF document on which to
perform the query.options
- A PDFPropertiesOptionSpec
object that specifies which queries are performed.
PDFPropertiesResult
object that
contains the result of the query.
PDFUtilityException
- if an error occurs during this operation.public Document convertXDPtoPDF(Document xdp) throws PDFUtilityException
xdp
- A Document
object that represents the XDP file to convert to a PDF file.
Document
object that represents the PDF document that was converted.
PDFUtilityException
- If an error occured during this operation. For example, if you specified an XDP
file that does not contain an embedded PDF data stream.public Document convertPDFtoXDP(Document pdf) throws PDFUtilityException
pdf
- A Document
object that represents the PDF document to convert to an XDP
file.
Document
object that represents an XDP file.
PDFUtilityException
- If an error occured during this operation. For example, if you specified an XDP
file that does not contain an XFA stream.public Document clone(Document pdf) throws PDFUtilityException
For example, assume that a PDF document is passed to two services sequentially.
When the first service modifies and returns the PDF document as a Document
object,
the next service to use the Document
object sees modifications
made by the first service.
After invoking the clone
method, you are assured that the input
Document
object
and the result Document
object are the same,
and that any future modification of either object will not be reflected in the other object.
pdf
- A Document
object that represents the PDF document to clone.
Document
object that represents the cloned PDF document.
PDFUtilityException
- If the document could not be cloned.public List multiclone(Document pdf, int copies) throws PDFUtilityException
For example, assume that a PDF document is passed to two services sequentially.
When the first service modifies and returns the PDF document as a Document
object,
the next service to use the Document
object sees modifications
made by the first service.
After invoking the multiclone
method, you are assured that the input
Document
object
and the result Document
object contains the same content,
and that any future modification of either object will not be reflected in the other object.
pdf
- A Document
object that represents the PDF document to clone.copies
- The number of copies to return.
Document
objects that stores one or more cloned PDF documents.
PDFUtilityException
- If an error occurred while cloning the PDF document.public PDFUtilitySaveMode getSaveMode(Document pdf)
The save mode represents the mode in which the PDF document is saved. The following are PDF save mode values:
FAST_WEB_VIEW
- Used while viewing the PDF document online.INCREMENTAL
- Performs the save operation in the least amount of time.FULL
- Saves with fewer optimizations.In addition, the save mode specifies whether the request is considered a requirement or only a suggestion. Save modes values are not influenced by the PDF document content.
pdf
- A Document
object that represents the PDF document for which save
mode information is returned.
PDFUtilitySaveMode
object that
represents the save mode of the PDF document.PDFUtilityServiceClient.setSaveMode(Document, PDFUtilitySaveMode, boolean)
public Document setSaveMode(Document pdf, PDFUtilitySaveMode saveMode, boolean override)
The following are PDF save mode values:
FAST_WEB_VIEW
- Used while viewing the PDF document online.INCREMENTAL
- Performs the save operation in the least amount of time.FULL
- Saves with fewer optimizations.
pdf
- A Document
object that represents the PDF document for
which save mode information is set.saveMode
- A PDFUtilitySaveMode
object that specifies the save mode of the PDF document.override
- A Boolean value that specifies whether to make the setting regardless of any previous requests.
Document
object that represents the PDF document for which the save
mode information has been set.PDFUtilityServiceClient.getSaveMode(Document)
public RedactionResult redact(Document inDoc, RedactionOptionSpec redactionOptionSpec) throws PDFUtilityException
inDoc
- A com.adobe.idp.Document
object.redactionOptionSpec
- A com.adobe.livecycle.pdfutility.client.RedactionOptionSpec
object
specifying the redaction options.
come.adobe.livecycle.pdfutility.client.RedactionResult
object containing the resultant PDF Document.
PDFUtilityException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |