com.qoppa.pdfSecure

Class PDFSecure

java.lang.Object

com.qoppa.pdfSecure.PDFSecure

public class PDFSecure
extends Object

The PDFSecure class provides methods to update security settings on a pdf document. It can encrypt and decrypt a PDF document as well as set permissions on the document.

Author:

Qoppa Software

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PDFSecure.KeyInfoSecure This is the Main-Class for the jPDFSecure.jar that can generate server key requests, validate a key, and display server information.

Constructor Summary

Constructors

Constructor and Description
PDFSecure(InputStream inStream, IPassword password) Loads a PDF document from an InputStream.
PDFSecure(String fileName, IPassword password) Loads a PDF document from a file.
PDFSecure(URL url, IPassword password) Loads a PDF document from a URL.

Method Summary

Modifier and Type	Method and Description
SignatureField	addSignatureField(int pageIndex, String fieldName, Rectangle2D bounds) Adds a signature field to a page in the document.
void	clearPasswordPermissions(String currentPermissionsPwd) Clears the security for this document.
void	clearSecurity(String currentPermissionsPwd) Deprecated.
void	clearUsageRights() Remove extended permissions from the document.
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	getEncryptionType() Get the encryption type used to encrypt the document (PasswordPermissions.ENCRYPTION_RC4_128, PasswordPermissions.ENCRYPTION_RC4_128, PasswordPermissions.ENCRYPTION_AES_128, etc...).
String	getPDFFileVersion() Return the PDF file version for the current document.
AllPDFPermissions	getPDFPermissions() Returns the AllPDFPermissions object which encompasses this document's PasswordPermissions, DocMDPPermissions, and UsageRightsPermissions.
Vector<SignatureField>	getSignatureFields() Gets a list of signature fields, if any.
static String	getVersion() Returns version string for jPDFSecure.
boolean	hasOpenPassword() Returns a flag indicating whether this document is encrypted with a 'user' password.
boolean	hasPermissionsPassword() Returns a flag indicating whether this document is encrypted with a 'owner' password.
boolean	isEncrypted() Returns a flag indicating whether this document is encrypted.
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.
void	saveDocument(OutputStream outStream) Saves this document to an output stream.
void	saveDocument(String fileName) Saves this document to a file.
static boolean	setAppletKey(String key, Applet applet) Method to unlock the production version of the library.
static boolean	setKey(String key) Method to unlock the production version of the library.
void	setPasswordPermissions(String newPermPwd, String newOpenPwd, PasswordPermissions permissions, String currentPermPwd, int encryptType) Sets the security for this document.
void	setPDFFileVersion(int majorVersion, int minorVersion) Set the PDF file version.
void	setSecurity(String newPermPwd, String newOpenPwd, PasswordPermissions permissions, String currentPermPwd, int encryptType) Deprecated. Use setPasswordPermissions(String, String, PasswordPermissions, String, int) instead.
void	signDocument(SignatureField signField, SigningInformation signingInfo) Signs this document using the given signature field.
boolean	usePermissionsPassword(String ownerPassword) Tells the PDFSecure 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

PDFSecure

public PDFSecure(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 - When there is an error loading the document.

PDFSecure

public PDFSecure(InputStream inStream,
                 IPassword password)
          throws PDFException

Loads 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 - When there is an error loading the document.

PDFSecure

public PDFSecure(URL url,
                 IPassword password)
          throws PDFException

Loads 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 - When there is an error loading the document.

Method Detail

close

public void close()

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

setSecurity

public void setSecurity(String newPermPwd,
                        String newOpenPwd,
                        PasswordPermissions permissions,
                        String currentPermPwd,
                        int encryptType)
                 throws PDFException

Deprecated. Use setPasswordPermissions(String, String, PasswordPermissions, String, int) instead.

Sets the security for this document. If the open password is null, the user won't have to enter a password to open the document. If the permissions password is null, any user can change the permissions on the document. The document will be encrypted regardless. To clear the encryption, call the @method clearSecurity method.

Parameters:

newPermPwd - The document's new permissions password.

newOpenPwd - The document's new open password.

permissions - Permission object.

currentPermPwd - The current permissions password. This parameter is needed if the document has a permissions password.

encryptType - - The encryption type to use: PDFPermissions.ENCRYPTION_RC4_128, PDFPermissions.ENCRYPTION_RC4_128, PDFPermissions.ENCRYPTION_AES_128, etc...

Throws:

PDFException

setPasswordPermissions

public void setPasswordPermissions(String newPermPwd,
                                   String newOpenPwd,
                                   PasswordPermissions permissions,
                                   String currentPermPwd,
                                   int encryptType)
                            throws PDFException

Sets the security for this document. If the open password is null, the user won't have to enter a password to open the document. If the permissions password is null, any user can change the permissions on the document. The document will be encrypted regardless. To clear the encryption, call the clearPasswordPermissions method.

Parameters:

newPermPwd - The document's new permissions password.

newOpenPwd - The document's new open password.

permissions - Permission object.

currentPermPwd - The current permissions password. This parameter is needed if the document has a permissions password.

encryptType - - The encryption type to use: PasswordPermissions.ENCRYPTION_RC4_128, PasswordPermissions.ENCRYPTION_RC4_128, PasswordPermissions.ENCRYPTION_AES_128, etc...

Throws:

PDFException - If there is an error setting the password permissions.

hasOpenPassword

public boolean hasOpenPassword()

Returns a flag indicating whether this document is encrypted with a 'user' password.

Returns:

boolean true if the document is encrypted with an open password, false otherwise.

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.

getPDFPermissions

public final AllPDFPermissions getPDFPermissions()

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

clearUsageRights

public void clearUsageRights()
                      throws PDFException

Remove extended permissions from the document.

Throws:

PDFException - If there is an error clearing the usage rights.

hasPermissionsPassword

public boolean hasPermissionsPassword()

Returns a flag indicating whether this document is encrypted with a 'owner' password.

Returns:

boolean true if the document is encrypted with a permissions password, false otherwise.

saveDocument

public void saveDocument(String fileName)
                  throws IOException,
                         PDFException

Saves this document to a file.

Parameters:

fileName - Name of the file to save the document.

Throws:

IOException

PDFException

saveDocument

public void saveDocument(OutputStream outStream)
                  throws IOException,
                         PDFException

Saves this document to an output stream.

Parameters:

outStream - OutputStream where the document will be written to.

Throws:

IOException

PDFException

setKey

public static boolean setKey(String key)

Method to unlock the production version of the library.

Parameters:

key - Production key.

Returns:

True when the key is valid, false if not.

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.

Parameters:

key - Production key.

Returns:

True when the key is valid, false if not.

getVersion

public static String getVersion()

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

isEncrypted

public boolean isEncrypted()

Returns a flag indicating whether this document is encrypted.

Returns:

boolean true if the document is encrypted with a user password, false otherwise.

clearSecurity

public void clearSecurity(String currentPermissionsPwd)
                   throws PDFException

Deprecated.

Clears the security for this document. Calling this method will clear user password, owner password, permissions and encryption.

Parameters:

currentPermissionsPwd - The document's current permissions password. This parameter is needed if the document has a permissions password.

Throws:

PDFException

clearPasswordPermissions

public void clearPasswordPermissions(String currentPermissionsPwd)
                              throws PDFException

Clears the security for this document. Calling this method will clear user password, owner password, permissions and encryption.

Parameters:

currentPermissionsPwd - The document's current permissions password. This parameter is needed if the document has a permissions password.

Throws:

PDFException

usePermissionsPassword

public boolean usePermissionsPassword(String ownerPassword)
                               throws PDFException

Tells the PDFSecure object that the permissions password is known, so all permissions are granted. This method is here as a convenience so that if the owner password is known, the host application does not have to clear the security, make changes to the document, and then restore the security.

Parameters:

ownerPassword - The permissions password

Returns:

true if the password was validated

Throws:

PDFException

signDocument

public void signDocument(SignatureField signField,
                         SigningInformation signingInfo)
                  throws PDFException

Signs this document using the given signature field.

Parameters:

signField - The field to use to sign the document.

signingInfo - Information required to sign the document.

Throws:

PDFException

addSignatureField

public SignatureField addSignatureField(int pageIndex,
                                        String fieldName,
                                        Rectangle2D bounds)
                                 throws PDFException

Adds a signature field to a page in the document. The signature field is added to the page but is NOT signed. To sign the document, the application must call PDFSecure.signDocument. To create an invisible signature field, the bound rectangle should be set to (0,0,0,0) for the bounds.

Parameters:

pageIndex - The index of the page to add the signature field on.

fieldName - The name of the new field.

bounds - The bounds of the field on the page. (0,0,0,0) indicates that the signature field will be invisible.

Throws:

PDFException - If there is a problem adding the signature field.

getSignatureFields

public Vector<SignatureField> getSignatureFields()

Gets a list of signature fields, if any. The list returned contains objects of type SignatureField.

Returns:

List of signature fields (if any) in the AcroForm. If there are no fields, this method returns null.

getEncryptionType

public int getEncryptionType()

Get the encryption type used to encrypt the document (PasswordPermissions.ENCRYPTION_RC4_128, PasswordPermissions.ENCRYPTION_RC4_128, PasswordPermissions.ENCRYPTION_AES_128, etc...).

Returns:

The encryption type. Returns -1 if the encryption type is not supported or the document is not encrypted.

getPDFFileVersion

public String getPDFFileVersion()

Return the PDF file version for the current document.

Returns:

The version of the PDF document.

setPDFFileVersion

public void setPDFFileVersion(int majorVersion,
                              int minorVersion)

Set the PDF file version. This method does not check for valid PDF versions, please consult the current PDF reference to make sure that the version set is a valid version. The method takes two arguments, one for the major part of the version and the second for the minor. When writing the PDF, these two parts are put together as follows:

majorVersion.minorVersion

Parameters:

majorVersion - The integer part of the version

minorVersion - The decimal part of the version