com.itextpdf.dito.sdk.output

Class PdfProducer

java.lang.Object

com.itextpdf.dito.sdk.output.PdfProducer

public final class PdfProducer
extends Object

This class is responsible for PDF production from templates

Method Summary

Modifier and Type	Method and Description
static PdfProductionResult	convertTemplateFromExplodedProject(File explodedProjectDirectory, String templateName, OutputStream outputPdfStream, JsonData data, PdfProducerProperties properties) Produces a PDF file from an output template from an unpacked template project with JSON data
static PdfProductionResult	convertTemplateFromExplodedProject(File explodedProjectDirectory, String templateName, OutputStream outputPdfStream, PackageProvidedData projectProvidedData, PdfProducerProperties properties) Produces a PDF file from an output template from an unpacked template project with data from template project
static PdfProductionResult	convertTemplateFromPackage(File templateProject, String templateName, OutputStream outputPdfStream, JsonData data) Produces a PDF file from an output template from a template project with JSON data
static PdfProductionResult	convertTemplateFromPackage(File templateProject, String templateName, OutputStream outputPdfStream, JsonData data, PdfProducerProperties properties) Produces a PDF file from an output template from a template project with JSON data
static PdfProductionResult	convertTemplateFromPackage(File templateProject, String templateName, OutputStream outputPdfStream, PackageProvidedData projectProvidedData) Produces a PDF file from an output template from a template project with data from template project
static PdfProductionResult	convertTemplateFromPackage(File templateProject, String templateName, OutputStream outputPdfStream, PackageProvidedData projectProvidedData, PdfProducerProperties properties) Produces a PDF file from an output template from a template project with data from template project
static PdfProductionResult	convertTemplateFromPackage(InputStream templateProject, String templateName, OutputStream outputPdfStream, JsonData data, PdfProducerProperties properties) Produces a PDF file from an output template from a template project with JSON data
static PdfProductionResult	convertTemplateFromPackage(InputStream templateProject, String templateName, OutputStream outputPdfStream, PackageProvidedData projectProvidedData, PdfProducerProperties properties) Produces a PDF file from an output template from a template project with data from template project
static Long	getRemainingProduceEvents() Deprecated. Use com.itextpdf.licensing.base.LicenseKey to obtain remaining events
static Long	getRemainingProducePagesEvents() Deprecated.

Methods inherited from class java.lang.Object

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

Method Detail

convertTemplateFromPackage

public static PdfProductionResult convertTemplateFromPackage(File templateProject,
                                                             String templateName,
                                                             OutputStream outputPdfStream,
                                                             PackageProvidedData projectProvidedData)
                                                      throws IOException

Produces a PDF file from an output template from a template project with data from template project

Parameters:

templateProject - the template project

templateName - name of the output template used for the PDF production

outputPdfStream - output stream where the resultant PDF would be written

projectProvidedData - data from the package that would be merged with the output template

Returns:

PdfProductionResult – structure class containing information about PDF production

Throws:

IOException - when error during reading or writing occurred

convertTemplateFromPackage

public static PdfProductionResult convertTemplateFromPackage(File templateProject,
                                                             String templateName,
                                                             OutputStream outputPdfStream,
                                                             PackageProvidedData projectProvidedData,
                                                             PdfProducerProperties properties)
                                                      throws IOException

Produces a PDF file from an output template from a template project with data from template project

Parameters:

templateProject - the template project

templateName - name of the output template used for the PDF production

outputPdfStream - output stream where the resultant PDF would be written

projectProvidedData - data from the package that would be merged with the output template

properties - the PdfProducerProperties for conversion to PDF e.g PDF version.

Returns:

PdfProductionResult – structure class containing information about PDF production

Throws:

IOException - when error during reading or writing occurred

convertTemplateFromPackage

public static PdfProductionResult convertTemplateFromPackage(InputStream templateProject,
                                                             String templateName,
                                                             OutputStream outputPdfStream,
                                                             PackageProvidedData projectProvidedData,
                                                             PdfProducerProperties properties)
                                                      throws IOException

Produces a PDF file from an output template from a template project with data from template project

Parameters:

templateProject - the template project stream

templateName - name of the output template used for the PDF production

outputPdfStream - output stream where the resultant PDF would be written

projectProvidedData - data from the package that would be merged with the output template

properties - the PdfProducerProperties for conversion to PDF e.g PDF version.

Returns:

PdfProductionResult – structure class containing information about PDF production

Throws:

IOException - when error during reading or writing occurred

convertTemplateFromPackage

public static PdfProductionResult convertTemplateFromPackage(File templateProject,
                                                             String templateName,
                                                             OutputStream outputPdfStream,
                                                             JsonData data)
                                                      throws IOException

Produces a PDF file from an output template from a template project with JSON data

Parameters:

templateProject - the template project

templateName - name of the output template used for the PDF production

outputPdfStream - output stream where the resultant PDF would be written

data - JSON data that would be merged with the output template

Returns:

PdfProductionResult – structure class containing information about PDF production

Throws:

IOException - when error during reading or writing occurred

convertTemplateFromPackage

public static PdfProductionResult convertTemplateFromPackage(File templateProject,
                                                             String templateName,
                                                             OutputStream outputPdfStream,
                                                             JsonData data,
                                                             PdfProducerProperties properties)
                                                      throws IOException

Produces a PDF file from an output template from a template project with JSON data

Parameters:

templateProject - the template project

templateName - name of the output template used for the PDF production

outputPdfStream - output stream where the resultant PDF would be written

data - JSON data that would be merged with the output template

properties - the PdfProducerProperties for conversion to PDF e.g PDF version

Returns:

PdfProductionResult – structure class containing information about PDF production

Throws:

IOException - when error during reading or writing occurred

convertTemplateFromPackage

public static PdfProductionResult convertTemplateFromPackage(InputStream templateProject,
                                                             String templateName,
                                                             OutputStream outputPdfStream,
                                                             JsonData data,
                                                             PdfProducerProperties properties)
                                                      throws IOException

Produces a PDF file from an output template from a template project with JSON data

Parameters:

templateProject - the template project stream

templateName - name of the output template used for the PDF production

outputPdfStream - output stream where the resultant PDF would be written

data - JSON data that would be merged with the output template

properties - the PdfProducerProperties for conversion to PDF e.g PDF version

Returns:

PdfProductionResult – structure class containing information about PDF production

Throws:

IOException - when error during reading or writing occurred

convertTemplateFromExplodedProject

public static PdfProductionResult convertTemplateFromExplodedProject(File explodedProjectDirectory,
                                                                     String templateName,
                                                                     OutputStream outputPdfStream,
                                                                     JsonData data,
                                                                     PdfProducerProperties properties)
                                                              throws IOException

Produces a PDF file from an output template from an unpacked template project with JSON data

Parameters:

explodedProjectDirectory - the unpacked template project directory

templateName - name of the output template used for the PDF production

outputPdfStream - output stream where the resultant PDF would be written

data - JSON data that would be merged with the output template

properties - the PdfProducerProperties for conversion to PDF e.g PDF version

Returns:

PdfProductionResult – structure class containing information about PDF production

Throws:

IOException - when error during reading or writing occurred

See Also:

PackageHelper.unpackTemplatePackage(File, File)

convertTemplateFromExplodedProject

public static PdfProductionResult convertTemplateFromExplodedProject(File explodedProjectDirectory,
                                                                     String templateName,
                                                                     OutputStream outputPdfStream,
                                                                     PackageProvidedData projectProvidedData,
                                                                     PdfProducerProperties properties)
                                                              throws IOException

Produces a PDF file from an output template from an unpacked template project with data from template project

Parameters:

explodedProjectDirectory - the unpacked template project directory

templateName - name of the output template used for the PDF production

outputPdfStream - output stream where the resultant PDF would be written

projectProvidedData - data from the package that would be merged with the output template

properties - the PdfProducerProperties for conversion to PDF e.g PDF version

Returns:

PdfProductionResult – structure class containing information about PDF production

Throws:

IOException - when error during reading or writing occurred

See Also:

PackageHelper.unpackTemplatePackage(File, File)

getRemainingProduceEvents

@Deprecated
public static Long getRemainingProduceEvents()

Deprecated. Use com.itextpdf.licensing.base.LicenseKey to obtain remaining events

Gets the number of remaining pdf document according to currently loaded license, or null in case there is no limit

Returns:

number of remaining pdf document, or null in case there is no limit on them

getRemainingProducePagesEvents

@Deprecated
public static Long getRemainingProducePagesEvents()

Deprecated.

Gets the number of remaining pages in pdf pages according to currently loaded license, or null in case there is no limit

Returns:

number of remaining pdf pages, or null in case there is no limit on them