Package com.realobjects.pdfreactor

Class PDFreactor

java.lang.Object

com.realobjects.pdfreactor.PDFreactor

public class PDFreactor
extends Object

PDFreactor converts HTML and XML documents into PDF or image.

This sample demonstrates the use of PDFreactor:

 PDFreactor pdfReactor = new PDFreactor();
 
 Configuration config = new Configuration();
 
 //required
 config.setDocument("https://www.realobjects.com/");
 
 Result result = pdfReactor.convert(config);
 byte[] pdf = result.getDocument();

Important: On a system without a graphical environment you have to enable the headless mode by setting the appropriate system property. Please see the manual for details.

For more information please have a look at the PDFreactor manual.

Field Summary

Fields

Modifier and Type	Field	Description
static final Version	VERSION

Constructor Summary

Constructors

Constructor	Description
PDFreactor()

Method Summary

Modifier and Type	Method	Description
Result	convert(Configuration configuration)	Converts the specified Configuration into PDF or image.
Result	convert(Configuration configuration, OutputStreamProvider function)	Converts the specified Configuration into PDF or image and writes it into OutputStream(s) created by the supplied function.
Result	convert(Configuration configuration, OutputStream outputStream)	Converts the specified Configuration into PDF or image and writes it directly in the supplied OutputStream.
byte[]	convertAsBinary(Configuration configuration)	Converts the specified Configuration into PDF or image.
void	convertAsBinary(Configuration configuration, OutputStream outputStream)	Converts the specified Configuration into PDF or image and writes it directly in the supplied OutputStream.
static final void	preinit()	Pre-initializes parts of PDFreactor in separate threads to improve the performance of the first conversion.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

VERSION

public static final Version VERSION

Constructor Details

PDFreactor

public PDFreactor()

Method Details

convert

public Result convert(Configuration configuration)
               throws PDFreactorException

Converts the specified Configuration into PDF or image.

Parameters:

configuration - The Configuration.

Returns:

The Result.

Throws:

PDFreactorException - If the conversion could not be completed.

convertAsBinary

public byte[] convertAsBinary(Configuration configuration)
                       throws PDFreactorException

Converts the specified Configuration into PDF or image.

Parameters:

configuration - The Configuration.

Returns:

The resulting PDF or image.

Throws:

PDFreactorException - If the conversion could not be completed.

convertAsBinary

public void convertAsBinary(Configuration configuration,
 OutputStream outputStream)
                     throws PDFreactorException

Converts the specified Configuration into PDF or image and writes it directly in the supplied OutputStream.

Parameters:

configuration - The Configuration.

outputStream - The OutputStream to write into.

Throws:

PDFreactorException - If the conversion could not be completed.

convert

public Result convert(Configuration configuration,
 OutputStream outputStream)
               throws PDFreactorException

Converts the specified Configuration into PDF or image and writes it directly in the supplied OutputStream.

Note that the Result.getDocument() and the Result.getDocumentArray() methods will always return null.

Parameters:

configuration - The Configuration.

outputStream - The OutputStream to write into.

Returns:

The Result.

Throws:

PDFreactorException - If the conversion could not be completed.

convert

public Result convert(Configuration configuration,
 OutputStreamProvider function)
               throws PDFreactorException

Converts the specified Configuration into PDF or image and writes it into OutputStream(s) created by the supplied function.

The supplied function must take an OutputItemImpl and returns an OutputStream

This convert method can be used to write results directly to OutputStream(s).

Note that the Result.getDocument() and the Result.getDocumentArray() methods will always return null.

Note that multiple images are generate for image Configuration.OutputFormat

if Configuration.OutputFormat.setMultiImage(Boolean) is not explicitly set to false.

Parameters:

configuration - The Configuration.

function - The function which creates OutputStreams.

Returns:

The Result.

Throws:

PDFreactorException - If the conversion could not be completed or the OutputStream could not be created by the supplied function.

preinit

public static final void preinit()

Pre-initializes parts of PDFreactor in separate threads to improve the performance of the first conversion. This is only relevant in environments where the performance of the first conversion is important, e.g. command-line or cloud. This method should be called as early as possible, but even calling it right before conversions improves performance. Calling this method repeatedly is fast and safe to do, as it has no further effect.