Class PDFParser

    • Field Detail

      • LOG

        private static final org.apache.commons.logging.Log LOG
    • Constructor Detail

      • PDFParser

        public PDFParser​(RandomAccessRead source)
                  throws java.io.IOException
        Constructor. Unrestricted main memory will be used for buffering PDF streams.
        Parameters:
        source - source representing the pdf.
        Throws:
        java.io.IOException - If something went wrong.
      • PDFParser

        public PDFParser​(RandomAccessRead source,
                         ScratchFile scratchFile)
                  throws java.io.IOException
        Constructor.
        Parameters:
        source - input representing the pdf.
        scratchFile - use a ScratchFile for temporary storage.
        Throws:
        java.io.IOException - If something went wrong.
      • PDFParser

        public PDFParser​(RandomAccessRead source,
                         java.lang.String decryptionPassword)
                  throws java.io.IOException
        Constructor. Unrestricted main memory will be used for buffering PDF streams.
        Parameters:
        source - input representing the pdf.
        decryptionPassword - password to be used for decryption.
        Throws:
        java.io.IOException - If something went wrong.
      • PDFParser

        public PDFParser​(RandomAccessRead source,
                         java.lang.String decryptionPassword,
                         ScratchFile scratchFile)
                  throws java.io.IOException
        Constructor.
        Parameters:
        source - input representing the pdf.
        decryptionPassword - password to be used for decryption.
        scratchFile - use a ScratchFile for temporary storage.
        Throws:
        java.io.IOException - If something went wrong.
      • PDFParser

        public PDFParser​(RandomAccessRead source,
                         java.lang.String decryptionPassword,
                         java.io.InputStream keyStore,
                         java.lang.String alias)
                  throws java.io.IOException
        Constructor. Unrestricted main memory will be used for buffering PDF streams.
        Parameters:
        source - input representing the pdf.
        decryptionPassword - password to be used for decryption.
        keyStore - key store to be used for decryption when using public key security
        alias - alias to be used for decryption when using public key security
        Throws:
        java.io.IOException - If something went wrong.
      • PDFParser

        public PDFParser​(RandomAccessRead source,
                         java.lang.String decryptionPassword,
                         java.io.InputStream keyStore,
                         java.lang.String alias,
                         ScratchFile scratchFile)
                  throws java.io.IOException
        Constructor.
        Parameters:
        source - input representing the pdf.
        decryptionPassword - password to be used for decryption.
        keyStore - key store to be used for decryption when using public key security
        alias - alias to be used for decryption when using public key security
        scratchFile - buffer handler for temporary storage; it will be closed on COSDocument.close()
        Throws:
        java.io.IOException - If something went wrong.
    • Method Detail

      • init

        private void init​(ScratchFile scratchFile)
      • getPDDocument

        public PDDocument getPDDocument()
                                 throws java.io.IOException
        This will get the PD document that was parsed. When you are done with this document you must call close() on it to release resources.
        Returns:
        The document at the PD layer.
        Throws:
        java.io.IOException - If there is an error getting the document.
      • initialParse

        protected void initialParse()
                             throws java.io.IOException
        The initial parse will first parse only the trailer, the xrefstart and all xref tables to have a pointer (offset) to all the pdf's objects. It can handle linearized pdfs, which will have an xref at the end pointing to an xref at the beginning of the file. Last the root object is parsed.
        Throws:
        InvalidPasswordException - If the password is incorrect.
        java.io.IOException - If something went wrong.
      • parse

        public void parse()
                   throws java.io.IOException
        This will parse the stream and populate the COSDocument object. This will close the keystore stream when it is done parsing.
        Throws:
        InvalidPasswordException - If the password is incorrect.
        java.io.IOException - If there is an error reading from the stream or corrupt data is found.