Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.adobe.pdfg
Interface GeneratePDF

public interface GeneratePDF

Method Summary
 java.util.Map createPDF(Document inputDoc, java.lang.String inputFileName, java.lang.String fileTypeSettings, java.lang.String pdfSettings, java.lang.String securitySettings, Document settingsDoc, Document xmpDoc)
          Deprecated.  
 CreatePDFResult createPDF2(Document inputDoc, java.lang.String inputFileExtension, java.lang.String fileTypeSettings, java.lang.String pdfSettings, java.lang.String securitySettings, Document settingsDoc, Document xmpDoc)
          Creates Adobe PDF from supported file types.
 CreatePDFResult createPDF3(java.util.Map inputDocuments, java.lang.String primaryFileToConvertFilter, java.lang.String inputFileExtension, java.lang.String fileTypeSettings, java.lang.String pdfSettings, java.lang.String securitySettings, Document settingsDoc, Document xmpDoc)
          Creates Adobe PDF from supported file types.
 java.util.Map exportPDF(Document inputDoc, java.lang.String inputFileName, java.lang.String formatType, Document settingsDoc)
          Deprecated.  
 ExportPDFResult exportPDF2(Document inputDoc, java.lang.String inputFileExtension, java.lang.String formatType, Document settingsDoc)
          Converts Adobe PDF to supported application extensions.
 ExportPDFResult exportPDF3(Document inputDoc, java.lang.String inputFileExtension, java.lang.String formatType, Document customPreflightProfile, Document settingsDoc)
          Converts Adobe PDF to supported application extensions.
 HtmlToPdfResult htmlFileToPdf(Document inputDoc, java.lang.String fileTypeSettingsName, java.lang.String securitySettingsName, Document settingsDoc, Document xmpDoc)
          Creates PDF from Input Document containing the HTML page(s).
For invoking the API through client SDK, the API name is HtmlFileToPdf.
 java.util.Map htmlToPdf(java.lang.String inputUrl, java.lang.String fileTypeSettingsName, java.lang.String securitySettingsName, Document settingsDoc, Document xmpDoc)
          Deprecated.  
 HtmlToPdfResult htmlToPdf2(java.lang.String inputUrl, java.lang.String fileTypeSettingsName, java.lang.String securitySettingsName, Document settingsDoc, Document xmpDoc)
          Creates PDF from URLs pointing to an HTML page.
For invoking the API through client SDK, the API name is HtmlToPdf2.
 OptimizePDFResult optimizePDF(Document inputDoc, java.lang.String fileTypeSettings, Document settingsDoc)
          Optimizes the input pdf and also converts it to any of the PDF versions.
 

Method Detail

createPDF

java.util.Map createPDF(Document inputDoc,
                        java.lang.String inputFileName,
                        java.lang.String fileTypeSettings,
                        java.lang.String pdfSettings,
                        java.lang.String securitySettings,
                        Document settingsDoc,
                        Document xmpDoc)
                        throws ConversionException,
                               InvalidParameterException,
                               FileFormatNotSupportedException
Deprecated. 

Creates Adobe PDF from supported file types. The method takes in a file and converts it to PDF. Supported file formats are msword, mspowerpoint, msexcel, msproject, msvisio, publisher, autocad. In addition to these, any third party generic pdfgenerating application type can be plugged into it.

For conversion some parameters are mandatory and some are optional. An input document is converted to PDF. Security permissions, PDF Output Settings and Metadata information can be applied to the resultant PDF.

For invoking the API through client SDK, the API name is CreatePDF.

Parameters:
inputDoc - The Document that needs to be converted. com.adobe.idp.Document needs to be created over the input document. Required Parameter.

inputFileName - File name with extension of the document that needs to be converted. Required Parameter. While using Client SDK the key to be supplied in input Map is "File Name with Extension".

fileTypeSettings - Optional Parameter.While using Client SDK the key to be supplied in input Map is "Filetype Settings".

pdfSettings - PDF OutPut settings that need to be applied. Optional Parameter. They can be one of the following. High_Quality_Print
PDFA1b_2005_RGB
PDFA1b_2005_CMYK
PDFX1a_2001
PDFX3_2002
Press_Quality
Smallest_File_Size
While using Client SDK the key to be supplied in input Map is "Adobe PDF Settings".

securitySettings - For applying security settings.The parameter is optional. While using Client SDK the key to be supplied in input Map is "Security Settings".

Can be one of the following No Security
Password Security
Certificate Security
Adobe Policy Server

settingsDoc - The file that contains settings that need to be applied while generating the pdf(like optimization for web view) and also the settings that are applied once the pdf is created(InitialView, Security). Optional Parameter.

xmpDoc - The file that contains metadata information that will be applied to the generated pdf. The parameter is optional.

Returns:
A java.util.Map is returned with the results. Map keys are defined as
ConvertedDoc : This contains the PDF file that has been created
LogDoc : This contains the Log file that has been created
Throws:
ConversionException
InvalidParameterException
FileFormatNotSupportedException

createPDF2

CreatePDFResult createPDF2(Document inputDoc,
                           java.lang.String inputFileExtension,
                           java.lang.String fileTypeSettings,
                           java.lang.String pdfSettings,
                           java.lang.String securitySettings,
                           Document settingsDoc,
                           Document xmpDoc)
                           throws ConversionException,
                                  InvalidParameterException,
                                  FileFormatNotSupportedException
Creates Adobe PDF from supported file types. The method takes in a file and converts it to PDF. Supported file formats are msword, mspowerpoint, msexcel, msproject, msvisio, publisher, autocad. In addition to these, any third party generic pdfgenerating application type can be plugged into it.

For conversion some parameters are mandatory and some are optional. An input document is converted to PDF. Security permissions, PDF Output Settings and Metadata information can be applied to the resultant PDF.

For invoking the API through client SDK, the API name is CreatePDF2.

Parameters:
inputDoc - The Document that needs to be converted. com.adobe.idp.Document needs to be created over the input document. Required Parameter.

inputFileExtension - File name with extension of the document that needs to be converted. Required Parameter. While using Client SDK the key to be supplied in input Map is "File Name with Extension".

fileTypeSettings - Optional Parameter.While using Client SDK the key to be supplied in input Map is "Filetype Settings".

pdfSettings - PDF OutPut settings that need to be applied. Optional Parameter. They can be one of the following. High_Quality_Print
PDFA1b_2005_RGB
PDFA1b_2005_CMYK
PDFX1a_2001
PDFX3_2002
Press_Quality
Smallest_File_Size
While using Client SDK the key to be supplied in input Map is "Adobe PDF Settings".

securitySettings - For applying security settings.The parameter is optional. While using Client SDK the key to be supplied in input Map is "Security Settings".

Can be one of the following No Security
Password Security
Certificate Security
Adobe Policy Server

settingsDoc - The file that contains settings that need to be applied while generating the pdf(like optimization for web view) and also the settings that are applied once the pdf is created(InitialView, Security). Optional Parameter.

xmpDoc - The file that contains metadata information that will be applied to the generated pdf. The parameter is optional.

Returns:
CreatePDFResults
Throws:
ConversionException
InvalidParameterException
FileFormatNotSupportedException

createPDF3

CreatePDFResult createPDF3(java.util.Map inputDocuments,
                           java.lang.String primaryFileToConvertFilter,
                           java.lang.String inputFileExtension,
                           java.lang.String fileTypeSettings,
                           java.lang.String pdfSettings,
                           java.lang.String securitySettings,
                           Document settingsDoc,
                           Document xmpDoc)
                           throws InvalidParameterException,
                                  ConversionException,
                                  FileFormatNotSupportedException
Creates Adobe PDF from supported file types. The method takes in a file and converts it to PDF. Supported file formats are msword, mspowerpoint, msexcel, msproject, msvisio, publisher, autocad. In addition to these, any third party generic pdfgenerating application type can be plugged into it.

For conversion some parameters are mandatory and some are optional. An input document is converted to PDF. Security permissions, PDF Output Settings and Metadata information can be applied to the resultant PDF.

For invoking the API through client SDK, the API name is CreatePDF3.

Parameters:
inputDocuments - A Collection of Documents containing the Document that needs to be converted to PDF, along with resources referred to by this document. Required Parameter. Implemented as a java.util.Map with file names (java.lang.String) as the keys and corresponding com.adobe.idp.Document instances as values.

primaryFileToConvertFilter - A java.lang.String representing the pattern matching the name of the file to be converted. Required Parameter.

inputFileExtension - File name with extension of the document that needs to be converted. Required Parameter. While using Client SDK the key to be supplied in input Map is "File Name with Extension".

fileTypeSettings - Optional Parameter.While using Client SDK the key to be supplied in input Map is "Filetype Settings".

pdfSettings - PDF OutPut settings that need to be applied. Optional Parameter. They can be one of the following. High_Quality_Print
PDFA1b_2005_RGB
PDFA1b_2005_CMYK
PDFX1a_2001
PDFX3_2002
Press_Quality
Smallest_File_Size
While using Client SDK the key to be supplied in input Map is "Adobe PDF Settings".

securitySettings - For applying security settings.The parameter is optional. While using Client SDK the key to be supplied in input Map is "Security Settings".

Can be one of the following No Security
Password Security
Certificate Security
Adobe Policy Server

settingsDoc - The file that contains settings that need to be applied while generating the pdf(like optimization for web view) and also the settings that are applied once the pdf is created(InitialView, Security). Optional Parameter.

xmpDoc - The file that contains metadata information that will be applied to the generated pdf. The parameter is optional.

Returns:
CreatePDFResults
Throws:
ConversionException
InvalidParameterException
FileFormatNotSupportedException

htmlFileToPdf

HtmlToPdfResult htmlFileToPdf(Document inputDoc,
                              java.lang.String fileTypeSettingsName,
                              java.lang.String securitySettingsName,
                              Document settingsDoc,
                              Document xmpDoc)
                              throws ConversionException,
                                     InvalidParameterException,
                                     FileFormatNotSupportedException
Creates PDF from Input Document containing the HTML page(s).
For invoking the API through client SDK, the API name is HtmlFileToPdf.

Parameters:
inputDoc - The document containg the single HTML page or a zip containg the HTML pages, which need to be converted to PDF
fileTypeSettingsName -
securitySettingsName -
fileTypeSettings - Optional Parameter.While using Client SDK the key to be supplied in input Map is "Filetype Settings".

securitySettings - For applying security settings.The parameter is optional. While using Client SDK the key to be supplied in input Map is "Security Settings".

settingsDoc - The configuration document used for the settings. Only the security settings and the filetype settings are used while converting to PDF document.
xmpDoc - The XMP metadata document to be merged into the generated PDF document.
Returns:
HtmlToPdfResult
Throws:
ConversionException
InvalidParameterException
FileFormatNotSupportedException

htmlToPdf

java.util.Map htmlToPdf(java.lang.String inputUrl,
                        java.lang.String fileTypeSettingsName,
                        java.lang.String securitySettingsName,
                        Document settingsDoc,
                        Document xmpDoc)
                        throws ConversionException,
                               InvalidParameterException,
                               FileFormatNotSupportedException
Deprecated. 

Creates PDF from URLs pointing to an HTML page.
For invoking the API through client SDK, the API name is HtmlToPdf.

Parameters:
inputUrl - The URL pointing to the webpage or HTML file, which needs to be converted to PDF
fileTypeSettingsName -
securitySettingsName -
fileTypeSettings - Optional Parameter.While using Client SDK the key to be supplied in input Map is "Filetype Settings".

securitySettings - For applying security settings.The parameter is optional. While using Client SDK the key to be supplied in input Map is "Security Settings".

settingsDoc - The configuration document used for the settings. Only the security settings and the filetype settings are used while converting to PDF document.
xmpDoc - The XMP metadata document to be merged into the generated PDF document.
Returns:
A java.util.Map is returned with the results. Map keys are defined as
ConvertedDoc : This contains the PDF file that has been created
Throws:
ConversionException
InvalidParameterException
FileFormatNotSupportedException

htmlToPdf2

HtmlToPdfResult htmlToPdf2(java.lang.String inputUrl,
                           java.lang.String fileTypeSettingsName,
                           java.lang.String securitySettingsName,
                           Document settingsDoc,
                           Document xmpDoc)
                           throws ConversionException,
                                  InvalidParameterException,
                                  FileFormatNotSupportedException
Creates PDF from URLs pointing to an HTML page.
For invoking the API through client SDK, the API name is HtmlToPdf2.

Parameters:
inputUrl - The URL pointing to the webpage or HTML file, which needs to be converted to PDF
fileTypeSettingsName -
securitySettingsName -
fileTypeSettings - Optional Parameter.While using Client SDK the key to be supplied in input Map is "Filetype Settings".

securitySettings - For applying security settings.The parameter is optional. While using Client SDK the key to be supplied in input Map is "Security Settings".

settingsDoc - The configuration document used for the settings. Only the security settings and the filetype settings are used while converting to PDF document.
xmpDoc - The XMP metadata document to be merged into the generated PDF document.
Returns:
HtmlToPdfResult
Throws:
ConversionException
InvalidParameterException
FileFormatNotSupportedException

exportPDF

java.util.Map exportPDF(Document inputDoc,
                        java.lang.String inputFileName,
                        java.lang.String formatType,
                        Document settingsDoc)
                        throws ConversionException,
                               InvalidParameterException,
                               FileFormatNotSupportedException
Deprecated. 

Converts Adobe PDF to supported application extensions. The methods takes in a PDF and exports the content of the PDF to desired extension.
For invoking the API through client SDK, the API name is ExportPDF.

Parameters:
inputDoc - The document that needs to be converted.

inputFileName - The name of the input document.

formatType -
settingsDoc - The document holding the configuration file. This is typically
an xml file.

Returns:
java.util.Map containing the converted PDF.Map keys are defined as
ConvertedDoc : This contains the PDF file that has been created
Throws:
ConversionException
InvalidParameterException
FileFormatNotSupportedException

exportPDF2

ExportPDFResult exportPDF2(Document inputDoc,
                           java.lang.String inputFileExtension,
                           java.lang.String formatType,
                           Document settingsDoc)
                           throws ConversionException,
                                  InvalidParameterException,
                                  FileFormatNotSupportedException
Converts Adobe PDF to supported application extensions. The methods takes in a PDF and exports the content of the PDF to desired extension.
For invoking the API through client SDK, the API name is ExportPDF2.

Parameters:
inputDoc - The document that needs to be converted.

inputFileExtension - The name of the input document.

formatType -
settingsDoc - The document holding the configuration file. This is typically
an xml file.

Returns:
ExportPDFResult
Throws:
ConversionException
InvalidParameterException
FileFormatNotSupportedException

exportPDF3

ExportPDFResult exportPDF3(Document inputDoc,
                           java.lang.String inputFileExtension,
                           java.lang.String formatType,
                           Document customPreflightProfile,
                           Document settingsDoc)
                           throws ConversionException,
                                  InvalidParameterException,
                                  FileFormatNotSupportedException
Converts Adobe PDF to supported application extensions. The methods takes in a PDF and exports the content of the PDF to desired extension.
For invoking the API through client SDK, the API name is ExportPDF3.

Parameters:
inputDoc - The document that needs to be converted.

inputFileExtension - The name of the input document.

formatType -
customPreflightProfile - A document containing the custom Preflight profile to be used during conversion to PDF/A.

settingsDoc - The document holding the configuration file. This is typically
an xml file.

Returns:
ExportPDFResult
Throws:
ConversionException
InvalidParameterException
FileFormatNotSupportedException

optimizePDF

OptimizePDFResult optimizePDF(Document inputDoc,
                              java.lang.String fileTypeSettings,
                              Document settingsDoc)
                              throws ConversionException,
                                     InvalidParameterException,
                                     FileFormatNotSupportedException
Optimizes the input pdf and also converts it to any of the PDF versions. The methods takes in a PDF and optimizes the PDF along with changing the PDF version to any desired value.
For invoking the API through client SDK, the API name is OptimizePDF.

Parameters:
inputDoc - The PDF Document that needs to be optimized. com.adobe.idp.Document needs to be created over the input document. Required Parameter.

fileTypeSettings - Optional Parameter.While using Client SDK the key to be supplied in input Map is "Filetype Settings".

settingsDoc - Optional Parameter. The file that contains settings that need to be applied while generating the output pdf. If provided, the fileTypeSettings parameter should be ommitted.

Returns:
OptimizePDFResults
Throws:
ConversionException
InvalidParameterException
FileFormatNotSupportedException
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD