Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.pdfbox.pdmodel.PDDocument
public class PDDocument
extends java.lang.Object
implements Pageable
Constructor Summary | |
| |
|
Method Summary | |
void | |
void |
|
void |
|
void |
|
void |
|
AccessPermission |
|
COSDocument |
|
PDDocumentCatalog |
|
PDDocumentInformation |
|
PDEncryptionDictionary |
|
int | |
String |
|
int |
|
PageFormat |
|
Printable |
|
SecurityHandler |
|
String |
|
PDPage |
|
boolean |
|
boolean |
|
boolean |
|
static PDDocument |
|
static PDDocument |
|
static PDDocument |
|
static PDDocument |
|
static PDDocument |
|
static PDDocument |
|
static PDDocument |
|
static PDDocument |
|
void |
|
void |
|
void |
|
boolean |
|
boolean |
|
void |
|
void |
|
void |
|
void |
|
void |
|
boolean |
|
boolean |
|
public PDDocument() throws IOException
Constructor, creates a new PDF Document with no pages. You need to add at least one page for the document to be valid.
public PDDocument(COSDocument doc)
Constructor that uses an existing document. The COSDocument that is passed in must be valid.
- Parameters:
doc
- The COSDocument that this document wraps.
public void addPage(PDPage page)
This will add a page to the document. This is a convenience method, that will add the page to the root of the hierarchy and set the parent of the page to the root.
- Parameters:
page
- The page to add to the document.
public void clearWillEncryptWhenSaving()
Deprecated. Do not rely on this method anymore. It is the responsability of COSWriter to hold this state.
This shoule only be called by the COSWriter after encryption has completed.
public void close() throws IOException
This will close the underlying COSDocument object.
public void decrypt(String password) throws CryptographyException, IOException, InvalidPasswordException
This will decrypt a document. This method is provided for compatibility reasons only. User should use the new security layer instead and the openProtection method especially.
- Parameters:
password
- Either the user or owner password.
- Throws:
InvalidPasswordException
- If the password is not a user or owner password.
public void encrypt(String ownerPassword, String userPassword) throws CryptographyException, IOException
This will mark a document to be encrypted. The actual encryption will occur when the document is saved. This method is provided for compatibility reasons only. User should use the new security layer instead and the openProtection method especially.
- Parameters:
ownerPassword
- The owner password to encrypt the document.userPassword
- The user password to encrypt the document.
- Throws:
CryptographyException
- If an error occurs during encryption.
public AccessPermission getCurrentAccessPermission()
Returns the access permissions granted when the document was decrypted. If the document was not decrypted this method returns the access permission for a document owner (ie can do everything). The returned object is in read only mode so that permissions cannot be changed. Methods providing access to content should rely on this object to verify if the current user is allowed to proceed.
- Returns:
- the access permissions for the current user on the document.
public COSDocument getDocument()
This will get the low level document.
- Returns:
- The document that this layer sits on top of.
public PDDocumentCatalog getDocumentCatalog()
This will get the document CATALOG. This is guaranteed to not return null.
- Returns:
- The documents /Root dictionary
public PDDocumentInformation getDocumentInformation()
This will get the document info dictionary. This is guaranteed to not return null.
- Returns:
- The documents /Info dictionary
public PDEncryptionDictionary getEncryptionDictionary() throws IOException
This will get the encryption dictionary for this document. This will still return the parameters if the document was decrypted. If the document was never encrypted then this will return null. As the encryption architecture in PDF documents is plugable this returns an abstract class, but the only supported subclass at this time is a PDStandardEncryption object.
- Returns:
- The encryption dictionary(most likely a PDStandardEncryption object)
public int getNumberOfPages()
public String getOwnerPasswordForEncryption()
Deprecated. Do not rely on this method anymore.
The owner password that was passed into the encrypt method. You should never use this method. This will not longer be valid once encryption has occured.
- Returns:
- The owner password passed to the encrypt method.
public int getPageCount()
Deprecated. Use the getNumberOfPages method instead!
This will return the total page count of the PDF document. Note: This method is deprecated in favor of the getNumberOfPages method. The getNumberOfPages is a required interface method of the Pageable interface. This method will be removed in a future version of PDFBox!!
- Returns:
- The total number of pages in the PDF document.
public PageFormat getPageFormat(int pageIndex)
public Printable getPrintable(int pageIndex)
public SecurityHandler getSecurityHandler()
Get the security handler that is used for document encryption.
- Returns:
- The handler used to encrypt/decrypt the document.
public String getUserPasswordForEncryption()
Deprecated. Do not rely on this method anymore.
The user password that was passed into the encrypt method. You should never use this method. This will not longer be valid once encryption has occured.
- Returns:
- The user password passed to the encrypt method.
public PDPage importPage(PDPage page) throws IOException
This will import and copy the contents from another location. Currently the content stream is stored in a scratch file. The scratch file is associated with the document. If you are adding a page to this document from another document and want to copy the contents to this document's scratch file then use this method otherwise just use the addPage method.
- Parameters:
page
- The page to import.
- Returns:
- The page that was imported.
public boolean isEncrypted()
This will tell if this document is encrypted or not.
- Returns:
- true If this document is encrypted.
public boolean isOwnerPassword(String password) throws IOException, CryptographyException
Deprecated.
This will determine if this is the owner password. This only applies when the document is encrypted and uses standard encryption.
- Parameters:
password
- The plain text owner password.
- Returns:
- true If the password passed in matches the owner password used to encrypt the document.
- Throws:
CryptographyException
- If there is an error in the encryption algorithms.
public boolean isUserPassword(String password) throws IOException, CryptographyException
Deprecated.
This will determine if this is the user password. This only applies when the document is encrypted and uses standard encryption.
- Parameters:
password
- The plain text user password.
- Returns:
- true If the password passed in matches the user password used to encrypt the document.
- Throws:
CryptographyException
- If there is an error in the encryption algorithms.
public static PDDocument load(File file) throws IOException
This will load a document from a file.
- Parameters:
file
- The name of the file to load.
- Returns:
- The document that was loaded.
public static PDDocument load(File file, RandomAccess scratchFile) throws IOException
This will load a document from a file.
- Parameters:
file
- The name of the file to load.scratchFile
- A location to store temp PDFBox data for this document.
- Returns:
- The document that was loaded.
public static PDDocument load(InputStream input) throws IOException
This will load a document from an input stream.
- Parameters:
input
- The stream that contains the document.
- Returns:
- The document that was loaded.
public static PDDocument load(InputStream input, RandomAccess scratchFile) throws IOException
This will load a document from an input stream.
- Parameters:
input
- The stream that contains the document.scratchFile
- A location to store temp PDFBox data for this document.
- Returns:
- The document that was loaded.
public static PDDocument load(String filename) throws IOException
This will load a document from a file.
- Parameters:
filename
- The name of the file to load.
- Returns:
- The document that was loaded.
public static PDDocument load(String filename, RandomAccess scratchFile) throws IOException
This will load a document from a file.
- Parameters:
filename
- The name of the file to load.scratchFile
- A location to store temp PDFBox data for this document.
- Returns:
- The document that was loaded.
public static PDDocument load(URL url) throws IOException
This will load a document from a url.
- Parameters:
url
- The url to load the PDF from.
- Returns:
- The document that was loaded.
public static PDDocument load(URL url, RandomAccess scratchFile) throws IOException
This will load a document from a url.
- Parameters:
url
- The url to load the PDF from.scratchFile
- A location to store temp PDFBox data for this document.
- Returns:
- The document that was loaded.
public void openProtection(DecryptionMaterial pm) throws BadSecurityHandlerException, IOException, CryptographyException
Tries to decrypt the document in memory using the provided decryption material.
- Parameters:
pm
- The decryption material (password or certificate).
- Throws:
CryptographyException
- If there is an error during decryption.
public void print() throws PrinterException
This will send the PDF document to a printer. The printing functionality depends on the org.pdfbox.pdfviewer.PageDrawer functionality. The PageDrawer is a work in progress and some PDFs will print correctly and some will not. This is a convenience method to create the java.awt.print.PrinterJob. The PDDocument implements the java.awt.print.Pageable interface and PDPage implementes the java.awt.print.Printable interface, so advanced printing capabilities can be done by using those interfaces instead of this method.
public void protect(ProtectionPolicy pp) throws BadSecurityHandlerException
Protects the document with the protection policy pp. The document content will be really encrypted when it will be saved. This method only marks the document for encryption.
- Parameters:
pp
- The protection policy.
- Throws:
BadSecurityHandlerException
- If there is an error during protection.
public boolean removePage(int pageNumber)
Remove the page from the document.
- Parameters:
pageNumber
- 0 based index to page number.
- Returns:
- true if the page was found false otherwise.
public boolean removePage(PDPage page)
Remove the page from the document.
- Parameters:
page
- The page to remove from the document.
- Returns:
- true if the page was found false otherwise.
public void save(OutputStream output) throws IOException, COSVisitorException
This will save the document to an output stream.
- Parameters:
output
- The stream to write to.
- Throws:
COSVisitorException
- If an error occurs while generating the data.
public void save(String fileName) throws IOException, COSVisitorException
This will save this document to the filesystem.
- Parameters:
fileName
- The file to save as.
- Throws:
COSVisitorException
- If an error occurs while generating the data.
public void setDocumentInformation(PDDocumentInformation info)
This will set the document information for this document.
- Parameters:
info
- The updated document information.
public void setEncryptionDictionary(PDEncryptionDictionary encDictionary) throws IOException
This will set the encryption dictionary for this document.
- Parameters:
encDictionary
- The encryption dictionary(most likely a PDStandardEncryption object)
public void silentPrint() throws PrinterException
This will send the PDF to the default printer without prompting the user for any printer settings.
- See Also:
print()
public boolean wasDecryptedWithOwnerPassword()
Deprecated. use
getCurrentAccessPermission
insteadThis will tell if the document was decrypted with the master password. This entry is invalid if the PDF was not decrypted.
- Returns:
- true if the pdf was decrypted with the master password.
public boolean willEncryptWhenSaving()
Deprecated. Do not rely on this method anymore. It is the responsibility of COSWriter to hold this state
Internal method do determine if the document will be encrypted when it is saved.
- Returns:
- True if encrypt has been called and the document has not been saved yet.