Package org.apache.pdfbox.preflight

Class PreflightContext

java.lang.Object
org.apache.pdfbox.preflight.PreflightContext
All Implemented Interfaces:
Closeable, AutoCloseable
public class PreflightContext extends Object implements Closeable

  • Field Details

    • fontContainers

      private final Map<COSBase,FontContainer<?>> fontContainers
      Contains the list of font name embedded in the PDF document.

    • document

      private PreflightDocument document
      The PDFbox object representation of the PDF source.

    • dataSource

      private DataSource dataSource
      The datasource to load the document from. Needed by StreamValidationProcess.

    • xrefTrailerResolver

      private XrefTrailerResolver xrefTrailerResolver
      Contains all Xref/trailer objects and resolves them into single object using startxref reference.

    • iccProfileWrapper

      private ICCProfileWrapper iccProfileWrapper
      This wrapper contains the ICCProfile used by the PDF file.

    • iccProfileAlreadySearched

      private boolean iccProfileAlreadySearched

    • metadata

      private XMPMetadata metadata
      MetaData of the current pdf file.

    • config

      private PreflightConfiguration config

    • validationPath

      private PreflightPath validationPath

    • processedSet

      private final Set<COSObjectable> processedSet

    • currentPageNumber

      private Integer currentPageNumber

    • fileLen

      private long fileLen

  • Constructor Details

    • PreflightContext

      public PreflightContext(DataSource dataSource)
      Create the DocumentHandler using the DataSource which represent the PDF file to check.
      Parameters:
      dataSource -

    • PreflightContext

      public PreflightContext(DataSource dataSource, PreflightConfiguration configuration)

  • Method Details

    • getMetadata

      public XMPMetadata getMetadata()
      Returns:
      the metadata

    • setMetadata

      public void setMetadata(XMPMetadata metadata)
      Parameters:
      metadata - the metadata to set

    • getDocument

      public PreflightDocument getDocument()
      Returns:
      the PDFBox object representation of the document

    • getXrefTrailerResolver

      public XrefTrailerResolver getXrefTrailerResolver()

    • setXrefTrailerResolver

      public void setXrefTrailerResolver(XrefTrailerResolver xrefTrailerResolver)

    • setDocument

      public void setDocument(PreflightDocument document)
      Initialize the PDFBox object which present the PDF File.
      Parameters:
      document -

    • getSource

      public DataSource getSource()
      Returns:
      The datasource of the pdf document

    • isComplete

      public boolean isComplete()

    • addFontContainer

      public void addFontContainer(COSBase cBase, FontContainer<?> fc)
      Add a FontContainer to allow TextObject validation.
      Parameters:
      cBase - the COSBase for the font container.
      fc - the font container.

    • getFontContainer

      public FontContainer<?> getFontContainer(COSBase cBase)
      Return the FontContainer identified by the COSBase. If the given object is missing from the fontContainers map, the null value is returned.
      Parameters:
      cBase - the COSBase for the font container
      Returns:
      the font container.

    • getIccProfileWrapper

      public ICCProfileWrapper getIccProfileWrapper()
      Returns:
      the iccProfileWrapper

    • setIccProfileWrapper

      public void setIccProfileWrapper(ICCProfileWrapper iccProfileWrapper)
      Parameters:
      iccProfileWrapper - the iccProfileWrapper to set

    • getConfig

      public PreflightConfiguration getConfig()

    • setConfig

      public void setConfig(PreflightConfiguration config)

    • close

      public void close()
      Close all opened resources
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable

    • addValidationError

      public void addValidationError(ValidationResult.ValidationError error)
      Add the given error the PreflightDocument
      Parameters:
      error -

    • addValidationErrors

      public void addValidationErrors(List<ValidationResult.ValidationError> errors)
      Add the given errors the PreflightDocument
      Parameters:
      errors - the list of validation errors.

    • getValidationPath

      public PreflightPath getValidationPath()

    • setValidationPath

      public void setValidationPath(PreflightPath validationPath)

    • isIccProfileAlreadySearched

      public boolean isIccProfileAlreadySearched()

    • setIccProfileAlreadySearched

      public void setIccProfileAlreadySearched(boolean iccProfileAlreadySearched)

    • setCurrentPageNumber

      public void setCurrentPageNumber(Integer currentPageNumber)
      Sets or resets the current page number.
      Parameters:
      currentPageNumber - zero based page number or null if none is known.

    • getCurrentPageNumber

      public Integer getCurrentPageNumber()
      Returns the current page number or null if none is known.

    • setFileLen

      public void setFileLen(long fileLen)

    • getFileLen

      public long getFileLen()

    • addToProcessedSet

      public void addToProcessedSet(COSObjectable cos)
      Add the argument to the set of processed elements,
      Parameters:
      cos -

    • isInProcessedSet

      public boolean isInProcessedSet(COSObjectable cos)
      Tell if the argument is in the set of processed elements.
      Parameters:
      cos -
      Returns:
      true if in the set, false if not.