com.princexml

Class PrinceControl

Object

com.princexml.Prince

com.princexml.PrinceControl

public class PrinceControl
extends Prince

Class for creating persistent Prince control processes that can be used for multiple consecutive document conversions.

Field Summary

Fields inherited from class com.princexml.Prince

mBaseURL, mCompress, mDisallowAnnotate, mDisallowCopy, mDisallowModify, mDisallowPrint, mEmbedFonts, mEncrypt, mFallbackCMYKProfile, mFileRoot, mForceIdentityEncoding, mInputType, mJavaScript, mKeyBits, mOwnerPassword, mPDFOutputIntent, mPDFProfile, mPDFXMP, mScripts, mStyleSheets, mSubsetFonts, mUserPassword, mXInclude

Constructor Summary

Constructors

Constructor and Description
PrinceControl(String exePath) Constructor for PrinceControl.
PrinceControl(String exePath, PrinceEvents events) Constructor for PrinceControl.

Method Summary

Modifier and Type	Method and Description
boolean	convert(byte[] xmlInput, OutputStream pdfOutput) Convert an XML or HTML file to a PDF file.
boolean	convert(InputStream xmlInput, OutputStream pdfOutput) Convert an XML or HTML file to a PDF file.
String	getVersion() Get the version string for the running Prince process.
void	start() Start a Prince control process that can be used for multiple consecutive document conversions.
void	stop()

Methods inherited from class com.princexml.Prince

addScript, addStyleSheet, clearScripts, clearStyleSheets, convert, convert, convert, convertMultiple, convertString, convertString, getBaseCommandLine, getJobCommandLine, readMessages, setBaseURL, setCompress, setDebug, setEmbedFonts, setEncrypt, setEncryptInfo, setFallbackCMYKProfile, setFileRoot, setForceIdentityEncoding, setHTML, setHttpPassword, setHttpProxy, setHttpUsername, setInputType, setJavaScript, setLog, setNetwork, setOptions, setOptions, setPDFOutputIntent, setPDFProfile, setPDFXMP, setSubsetFonts, setVerbose, setXInclude

Methods inherited from class Object

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

Constructor Detail

PrinceControl

public PrinceControl(String exePath)

Constructor for PrinceControl.

Parameters:

exePath - The path of the Prince executable. (For example, this may be C:\Program Files\Prince\engine\bin\prince.exe on Windows or /usr/bin/prince on Linux).

PrinceControl

public PrinceControl(String exePath,
                     PrinceEvents events)

Constructor for PrinceControl.

Parameters:

exePath - The path of the Prince executable. (For example, this may be C:\Program Files\Prince\engine\bin\prince.exe on Windows or /usr/bin/prince on Linux).

events - An instance of the PrinceEvents interface that will receive error/warning messages returned from Prince.

Method Detail

getVersion

public String getVersion()

Get the version string for the running Prince process.

start

public void start()
           throws IOException

Start a Prince control process that can be used for multiple consecutive document conversions.

Throws:

IOException

stop

public void stop()
          throws IOException

Throws:

IOException

convert

public boolean convert(InputStream xmlInput,
                       OutputStream pdfOutput)
                throws IOException

Convert an XML or HTML file to a PDF file. This method is useful for servlets as it allows Prince to write the PDF output directly to the OutputStream of the servlet response.

Note that it may be helpful to specify a base URL or path for the input document using the setBaseURL() method. This allows relative URLs and paths in the document (eg. for images) to be resolved correctly.

Overrides:

convert in class Prince

Parameters:

xmlInput - The InputStream from which Prince will read the XML or HTML document.

pdfOutput - The OutputStream to which Prince will write the PDF output.

Returns:

True if a PDF file was generated successfully.

Throws:

IOException

convert

public boolean convert(byte[] xmlInput,
                       OutputStream pdfOutput)
                throws IOException

Convert an XML or HTML file to a PDF file. This method is useful for servlets as it allows Prince to write the PDF output directly to the OutputStream of the servlet response.

Note that it may be helpful to specify a base URL or path for the input document using the setBaseURL() method. This allows relative URLs and paths in the document (eg. for images) to be resolved correctly.

Parameters:

xmlInput - The byte array from which Prince will read the XML or HTML document.

pdfOutput - The OutputStream to which Prince will write the PDF output.

Returns:

True if a PDF file was generated successfully.

Throws:

IOException