com.qoppa.pdfOptimizer

Class PDFOptimizer

java.lang.Object

com.qoppa.pdfOptimizer.PDFOptimizer

public class PDFOptimizer
extends Object

The PDFOptimizer class provides methods to load and optimize a PDF document.

Author:

Qoppa Software

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PDFOptimizer.KeyInfoOptimizer This is the Main-Class for the jPDFOptimizer.jar, it can generate server key requests, validate a key, and display server information.

Constructor Summary

Constructors

Constructor and Description
PDFOptimizer(InputStream inStream, IPassword password) Creates a PDFOptimizer object by loading a PDF document from an InputStream.
PDFOptimizer(PDFSource pdfSource, IPassword password) Creates a PDFOptimizer object by loading a PDF document from a PDFSource object.
PDFOptimizer(String fileName, IPassword password) Loads a PDF document from a file.
PDFOptimizer(URL url, IPassword password) Creates a PDFOptimizer object by loading a PDF document from a URL.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Add a property change listener to this PDFOptimizer object.
AuditResults	audit() Audits the PDFDocument and returns the audit results.
void	close() Close / release all resources held by this document.
DocumentInfo	getDocumentInfo() Returns a DocumentInfo object containing the information section of a PDF document (author, title, etc.)
int	getPageCount() Returns the number of pages in this document.
AllPDFPermissions	getPDFPermissions() Returns the AllPDFPermissions object which encompasses this document's PasswordPermissions, DocMDPPermissions, and UsageRightsPermissions.
static String	getVersion() Returns version string for jPDFOptimizer.
static void	loadLicense(InputStream licenseStream) Method to load a license file from an inputstream.
static void	loadLicense(String licenseFile) Method to load a license file.
OptimizeResults	optimize(OptSettings optInfo, OutputStream outStream) Optimizes and saves this document to an output stream.
OptimizeResults	optimize(OptSettings optInfo, OutputStream outStream, File log) Deprecated. As of 2017R1 replaced by optimize(OptSettings, OutputStream).
OptimizeResults	optimize(OptSettings optInfo, String outFile) Optimize and save this document to a file.
OptimizeResults	optimize(OptSettings optInfo, String outFile, File log) Deprecated. As of 2017R1 replaced by optimize(OptSettings, String).
void	removePropertyChangeListener(PropertyChangeListener listener) Remove a PropertyChangeListener so that it will stop being notified for progress.
static boolean	setAppletKey(String key, Applet applet) Method to unlock the production version of the library when running in an applet.
static boolean	setKey(String key) Method to unlock the production version of the library.
boolean	usePermissionsPassword(String ownerPassword) Tells the PDFOptimizer object that the permissions password is known, so all permissions are granted.

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFOptimizer

public PDFOptimizer(String fileName,
                    IPassword password)
             throws PDFException

Loads a PDF document from a file.

Parameters:

fileName - Name of the PDF file.

password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.

Throws:

PDFException

PDFOptimizer

public PDFOptimizer(InputStream inStream,
                    IPassword password)
             throws PDFException

Creates a PDFOptimizer object by loading a PDF document from an InputStream.

Parameters:

inStream - InputStream to read the PDF document.

password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.

Throws:

PDFException

PDFOptimizer

public PDFOptimizer(URL url,
                    IPassword password)
             throws PDFException

Creates a PDFOptimizer object by loading a PDF document from a URL.

Parameters:

url - Location of the PDF document.

password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.

Throws:

PDFException

PDFOptimizer

public PDFOptimizer(PDFSource pdfSource,
                    IPassword password)
             throws PDFException

Creates a PDFOptimizer object by loading a PDF document from a PDFSource object.

Parameters:

pdfSource - The source for the PDF document.

password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.

Throws:

PDFException

Method Detail

close

public void close()

Close / release all resources held by this document. After this method is called, this object becomes invalid and should not be used anymore.

setKey

public static boolean setKey(String key)

Method to unlock the production version of the library.

Parameters:

key - Production key.

loadLicense

public static void loadLicense(InputStream licenseStream)
                        throws com.qoppa.pdf.LicenseException

Method to load a license file from an inputstream. This is useful when the license file is placed in the classpath of the host application and an input stream can be opened to it as a resource.

Parameters:

licenseStream - The input stream for the license file contents.

Throws:

com.qoppa.pdf.LicenseException - If there are any problems with the license file

loadLicense

public static void loadLicense(String licenseFile)
                        throws com.qoppa.pdf.LicenseException,
                               IOException

Method to load a license file.

Parameters:

licenseFile - The full path to the license file.

Throws:

com.qoppa.pdf.LicenseException - If there are any problems with the license file

IOException

setAppletKey

public static boolean setAppletKey(String key,
                                   Applet applet)

Method to unlock the production version of the library when running in an applet.

Parameters:

key - Production key.

getDocumentInfo

public DocumentInfo getDocumentInfo()

Returns a DocumentInfo object containing the information section of a PDF document (author, title, etc.)

Returns:

DocumentInfo Object containing header information for the document.

getPageCount

public int getPageCount()
                 throws PDFException

Returns the number of pages in this document.

Throws:

PDFException

getPDFPermissions

public final AllPDFPermissions getPDFPermissions()

Returns the AllPDFPermissions object which encompasses this document's PasswordPermissions, DocMDPPermissions, and UsageRightsPermissions.

getVersion

public static String getVersion()

Returns version string for jPDFOptimizer. If this is the demo version, the return string will contain 'Demo Version' at the end.

optimize

public OptimizeResults optimize(OptSettings optInfo,
                                OutputStream outStream)
                         throws PDFException,
                                IOException

Optimizes and saves this document to an output stream. This method optimizes the document according to the options in the optInfo object and writes the optimized document to the output stream.

Parameters:

optInfo - The optimization options.

outStream - The output stream to write the document to.

Throws:

PDFException

IOException

optimize

public OptimizeResults optimize(OptSettings optInfo,
                                OutputStream outStream,
                                File log)
                         throws PDFException,
                                IOException

Deprecated. As of 2017R1 replaced by optimize(OptSettings, OutputStream).

Optimizes and saves this document to an output stream. This method optimizes the document according to the options in the optInfo object and writes the optimized document to the output stream.

Parameters:

optInfo - The optimization options.

outStream - The output stream to write the document to.

log - The file to write the optimizer log.

Throws:

PDFException

IOException

optimize

public OptimizeResults optimize(OptSettings optInfo,
                                String outFile)
                         throws PDFException,
                                IOException

Optimize and save this document to a file. This method optimizes the document according to the options in the optInfo object and writes the optimized document to the output stream.

Parameters:

optInfo - The optimization options.

outFile - The output file to write the document to.

Throws:

PDFException

IOException

optimize

public OptimizeResults optimize(OptSettings optInfo,
                                String outFile,
                                File log)
                         throws PDFException,
                                IOException

Deprecated. As of 2017R1 replaced by optimize(OptSettings, String).

Optimize and save this document to a file. This method optimizes the document according to the options in the optInfo object and writes the optimized document to the output stream.

Parameters:

optInfo - The optimization options.

outFile - The output file to write the document to.

log - The file to write the optimizer log.

Throws:

PDFException

IOException

audit

public AuditResults audit()
                   throws IOException

Audits the PDFDocument and returns the audit results.

Throws:

IOException

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Add a property change listener to this PDFOptimizer object. The PDFOptimizer will fire PropertyChangeEvents to notify a listener for progress during optimization.

Parameters:

listener - The object to receive PropertChangeEvents.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Remove a PropertyChangeListener so that it will stop being notified for progress.

Parameters:

listener - the listener to remove.

usePermissionsPassword

public boolean usePermissionsPassword(String ownerPassword)
                               throws PDFException

Tells the PDFOptimizer object that the permissions password is known, so all permissions are granted.

Parameters:

ownerPassword - The permissions password

Returns:

true if the password was validated

Throws:

PDFException