Package org.verapdf.pdfa

Interface VeraPDFFoundry

All Superinterfaces:

AutoCloseable, Closeable, Component

All Known Implementing Classes:

AbstractFoundry

public interface VeraPDFFoundry
extends Component

The veraPDFFoundry interface provides methods for creating implementations of the classes provided by a PDF/A Parser and Metadata Fixer implementations.

Version:

0.1 Created 21 Sep 2016:12:37:55

Author:

Carl Wilson carlwilson AT github

Method Summary

Modifier and Type	Method	Description
PDFAValidator	createFailFastValidator(List<PDFAFlavour> flavours, int maxFailures, int maxNumberOfDisplayedFailedChecks, boolean logSuccess, boolean showErrorMessages, boolean showProgress)	Creates a new PDFAValidator initialised with the passed profile and parameters, requested fast failing behaviour.
PDFAValidator	createFailFastValidator(PDFAFlavour flavour, int maxFailures, int maxNumberOfDisplayedFailedChecks, boolean logSuccess, boolean showErrorMessages, boolean showProgress)	Creates a new PDFAValidator initialised with the passed profile and parameters.
PDFAValidator	createFailFastValidator(ValidationProfile profile, int maxFailures, int maxNumberOfDisplayedFailedChecks, boolean logSuccess, boolean showErrorMessages, boolean showProgress)	Creates a new PDFAValidator initialised with the passed profile and parameters, requested fast failing behaviour.
MetadataFixer	createMetadataFixer()	Obtain a new MetadataFixer instance.
PDFAParser	createParser(File pdfFile)	Method that returns a PDFAParser instance, parsing file passed as parameter.
PDFAParser	createParser(File pdfFile, PDFAFlavour flavour)	Method that returns a PDFAParser instance, parsing file passed as parameter.
PDFAParser	createParser(File pdfFile, PDFAFlavour flavour, String password)
PDFAParser	createParser(File pdfFile, PDFAFlavour flavour, PDFAFlavour defaultFlavour)
PDFAParser	createParser(File pdfFile, PDFAFlavour flavour, PDFAFlavour defaultFlavour, String password)
PDFAParser	createParser(InputStream pdfStream)	Method that returns a PDFAParser instance, parsing the passed parameter.
PDFAParser	createParser(InputStream pdfStream, PDFAFlavour flavour)	Method that returns a PDFAParser instance, parsing the passed parameter.
PDFAParser	createParser(InputStream pdfStream, PDFAFlavour flavour, String password)
PDFAParser	createParser(InputStream pdfStream, PDFAFlavour flavour, PDFAFlavour defaultFlavour)
PDFAParser	createParser(InputStream pdfStream, PDFAFlavour flavour, PDFAFlavour defaultFlavour, String password)
PDFAValidator	createValidator(List<PDFAFlavour> flavours)	Creates a new PDFAValidator instance that uses ValidationProfiles packaged as a core library resource.
PDFAValidator	createValidator(List<PDFAFlavour> flavour, int maxNumberOfDisplayedFailedChecks, boolean logSuccess, boolean showErrorMessages, boolean showProgress)	Creates a new PDFAValidator initialised with the passed profile and parameters.
PDFAValidator	createValidator(PDFAFlavour flavour, boolean logSuccess)	Creates a new PDFAValidator instance that uses one of the ValidationProfiles packaged as a core library resource.
PDFAValidator	createValidator(PDFAFlavour flavour, int maxNumberOfDisplayedFailedChecks, boolean logSuccess, boolean showErrorMessages, boolean showProgress)	Creates a new PDFAValidator initialised with the passed profile and parameters.
PDFAValidator	createValidator(ValidationProfile profile, boolean logSuccess)	Creates a new PDFAValidator initialised with the passed profile and chosen passed test logging.
PDFAValidator	createValidator(ValidationProfile profile, int maxNumberOfDisplayedFailedChecks, boolean logSuccess, boolean showErrorMessages, boolean showProgress)	Creates a new PDFAValidator initialised with the passed profile and parameters.
PDFAValidator	createValidator(ValidatorConfig config)	Obtain a new PDFAValidator instance.
PDFAValidator	createValidator(ValidatorConfig config, List<PDFAFlavour> flavours)	Obtain a new PDFAValidator instance that uses the list of a custom PDFAFlavours.
PDFAValidator	createValidator(ValidatorConfig config, PDFAFlavour flavour)	Obtain a new PDFAValidator instance that uses a custom PDFAFlavour.
PDFAValidator	createValidator(ValidatorConfig config, ValidationProfile profile)	Obtain a new PDFAValidator instance that uses a custom ValidationProfile instance.
PDFAFlavour	defaultFlavour()
String	getParserId()

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.verapdf.component.Component

getDetails

Method Details

createParser

PDFAParser createParser(InputStream pdfStream)
                 throws ModelParsingException,
EncryptedPdfException

Method that returns a PDFAParser instance, parsing the passed parameter. The parser or parser provider will detect the flavour of the PDF document stream and provide an appropriate parser.

Parameters:

pdfStream - InputStream for the PDF document to be parsed.

Returns:

a PDFAParser instance created from the supplied InputStream.

Throws:

ModelParsingException - when there's a problem parsing the PDF file

EncryptedPdfException - if the PDF to be parsed is encrypted

createParser

PDFAParser createParser(InputStream pdfStream,
 PDFAFlavour flavour)
                 throws ModelParsingException,
EncryptedPdfException

Method that returns a PDFAParser instance, parsing the passed parameter. The caller must explicitly state the flavour of the PDF document stream.

Parameters:

pdfStream - InputStream for the PDF document to be parsed.

flavour - a PDFAFlavour instance indicating parser configuration to be assumed when parsing the document.

Returns:

a PDFAParser instance created from the supplied InputStream.

Throws:

ModelParsingException - when there's a problem parsing the PDF file

EncryptedPdfException - if the PDF to be parsed is encrypted

createParser

PDFAParser createParser(InputStream pdfStream,
 PDFAFlavour flavour,
 PDFAFlavour defaultFlavour)
                 throws ModelParsingException,
EncryptedPdfException

Throws:

ModelParsingException

EncryptedPdfException

createParser

PDFAParser createParser(InputStream pdfStream,
 PDFAFlavour flavour,
 String password)
                 throws ModelParsingException,
EncryptedPdfException

Throws:

ModelParsingException

EncryptedPdfException

createParser

PDFAParser createParser(InputStream pdfStream,
 PDFAFlavour flavour,
 PDFAFlavour defaultFlavour,
 String password)
                 throws ModelParsingException,
EncryptedPdfException

Throws:

ModelParsingException

EncryptedPdfException

createParser

PDFAParser createParser(File pdfFile,
 PDFAFlavour flavour)
                 throws ModelParsingException,
EncryptedPdfException

Method that returns a PDFAParser instance, parsing file passed as parameter. The caller must explicitly state the flavour of the PDF document stream.

Parameters:

pdfFile - File with PDF document to be parsed.

flavour - a PDFAFlavour instance indicating parser configuration to be assumed when parsing the document.

Returns:

a PDFAParser instance created from the supplied InputStream.

Throws:

ModelParsingException - when there's a problem parsing the PDF file

EncryptedPdfException - if the PDF to be parsed is encrypted

createParser

PDFAParser createParser(File pdfFile,
 PDFAFlavour flavour,
 PDFAFlavour defaultFlavour)
                 throws ModelParsingException,
EncryptedPdfException

Throws:

ModelParsingException

EncryptedPdfException

createParser

PDFAParser createParser(File pdfFile,
 PDFAFlavour flavour,
 String password)
                 throws ModelParsingException,
EncryptedPdfException

Throws:

ModelParsingException

EncryptedPdfException

createParser

PDFAParser createParser(File pdfFile,
 PDFAFlavour flavour,
 PDFAFlavour defaultFlavour,
 String password)
                 throws ModelParsingException,
EncryptedPdfException

Throws:

ModelParsingException

EncryptedPdfException

createParser

PDFAParser createParser(File pdfFile)
                 throws ModelParsingException,
EncryptedPdfException

Method that returns a PDFAParser instance, parsing file passed as parameter. The parser or parser provider will detect the flavour of the PDF document stream and provide an appropriate parser.

Parameters:

pdfFile - File with the PDF document to be parsed.

Returns:

a PDFAParser instance created from the supplied InputStream.

Throws:

ModelParsingException - when there's a problem parsing the PDF file

EncryptedPdfException - if the PDF to be parsed is encrypted

createValidator

PDFAValidator createValidator(ValidatorConfig config)

Obtain a new PDFAValidator instance.

Parameters:

config - a ValidatorConfig instance used to configure the PDFAValidator

Returns:

an appropriately configured PDFAValidator instance.

createValidator

PDFAValidator createValidator(ValidatorConfig config,
 ValidationProfile profile)

Obtain a new PDFAValidator instance that uses a custom ValidationProfile instance.

Parameters:

config - a ValidatorConfig instance used to configure the PDFAValidator

profile - a validation profile

Returns:

an appropriately configured PDFAValidator instance.

createValidator

PDFAValidator createValidator(ValidatorConfig config,
 PDFAFlavour flavour)

Obtain a new PDFAValidator instance that uses a custom PDFAFlavour.

Parameters:

config - a ValidatorConfig instance used to configure the PDFAValidator

flavour - the particular PDFAFlavour to validated against.

Returns:

an appropriately configured PDFAValidator instance.

createValidator

PDFAValidator createValidator(ValidatorConfig config,
 List<PDFAFlavour> flavours)

Obtain a new PDFAValidator instance that uses the list of a custom PDFAFlavours.

Parameters:

config - a ValidatorConfig instance used to configure the PDFAValidator

flavours - the list of particular PDFAFlavours to validated against.

Returns:

an appropriately configured PDFAValidator instance.

createValidator

PDFAValidator createValidator(PDFAFlavour flavour,
 boolean logSuccess)

Creates a new PDFAValidator instance that uses one of the ValidationProfiles packaged as a core library resource.

Parameters:

flavour - the PDFAFlavour that's associated with the ValidationProfile to used to initialise the PDFAValidator.

logSuccess - boolean used to configure logging of passed tests by the PDFAValidator. Pass true to log passed tests, false to only log tests that don't pass.

Returns:

a PDFAValidator instance initialised from the passed parameters

createValidator

PDFAValidator createValidator(List<PDFAFlavour> flavours)

Creates a new PDFAValidator instance that uses ValidationProfiles packaged as a core library resource.

Parameters:

flavours - list of the PDFAFlavour that are associated with the ValidationProfile to used to initialise the PDFAValidator.

Returns:

a PDFAValidator instance initialised from the passed parameters

createValidator

PDFAValidator createValidator(ValidationProfile profile,
 boolean logSuccess)

Creates a new PDFAValidator initialised with the passed profile and chosen passed test logging.

Parameters:

profile - the ValidationProfile to be enforced by the returned PDFAValidator.

logSuccess - boolean used to configure logging of passed tests by the PDFAValidator. Pass true to log passed tests, false to only log tests that don't pass.

Returns:

a PDFAValidator instance initialised from the passed parameters

createValidator

PDFAValidator createValidator(PDFAFlavour flavour,
 int maxNumberOfDisplayedFailedChecks,
 boolean logSuccess,
 boolean showErrorMessages,
 boolean showProgress)

Creates a new PDFAValidator initialised with the passed profile and parameters.

Parameters:

flavour - the PDFAFlavour that's associated with the ValidationProfile to used to initialise the PDFAValidator.

maxNumberOfDisplayedFailedChecks - a max checks number to show

logSuccess - boolean used to configure logging of passed tests by the PDFAValidator. Pass true to log passed tests, false to only log tests that don't pass.

showErrorMessages - a flag to show error messages

showProgress - a flag to show validation progress

Returns:

a PDFAValidator instance initialised from the passed parameters

createValidator

PDFAValidator createValidator(List<PDFAFlavour> flavour,
 int maxNumberOfDisplayedFailedChecks,
 boolean logSuccess,
 boolean showErrorMessages,
 boolean showProgress)

Creates a new PDFAValidator initialised with the passed profile and parameters.

Parameters:

flavour - the PDFAFlavour that's associated with the ValidationProfile to used to initialise the PDFAValidator.

maxNumberOfDisplayedFailedChecks - a max checks number to show

logSuccess - boolean used to configure logging of passed tests by the PDFAValidator. Pass true to log passed tests, false to only log tests that don't pass.

showErrorMessages - a flag to show error messages

showProgress - a flag to show validation progress

Returns:

a PDFAValidator instance initialised from the passed parameters

createValidator

PDFAValidator createValidator(ValidationProfile profile,
 int maxNumberOfDisplayedFailedChecks,
 boolean logSuccess,
 boolean showErrorMessages,
 boolean showProgress)

Creates a new PDFAValidator initialised with the passed profile and parameters.

Parameters:

profile - the ValidationProfile to be enforced by the returned PDFAValidator.

maxNumberOfDisplayedFailedChecks - a max checks number to show

logSuccess - boolean used to configure logging of passed tests by the PDFAValidator. Pass true to log passed tests, false to only log tests that don't pass.

showErrorMessages - a flag to show error messages

showProgress - a flag to show validation progress

Returns:

a PDFAValidator instance initialised from the passed parameters

createFailFastValidator

PDFAValidator createFailFastValidator(PDFAFlavour flavour,
 int maxFailures,
 int maxNumberOfDisplayedFailedChecks,
 boolean logSuccess,
 boolean showErrorMessages,
 boolean showProgress)

Creates a new PDFAValidator initialised with the passed profile and parameters.

Parameters:

flavour - the PDFAFlavour that's associated with the ValidationProfile to used to initialise the PDFAValidator.

maxFailures - an int value that configures the PDFAValidator to abort validation after maxFailures failed tests. If maxFailures is less than 1 then the PDFAValidator will complete the full validation process.

maxNumberOfDisplayedFailedChecks - a max checks number to show

logSuccess - a flag to show success logs

showErrorMessages - a flag to show error message

showProgress - a flag to show validation progress

Returns:

a PDFAValidator instance initialised from the passed parameters

createFailFastValidator

PDFAValidator createFailFastValidator(List<PDFAFlavour> flavours,
 int maxFailures,
 int maxNumberOfDisplayedFailedChecks,
 boolean logSuccess,
 boolean showErrorMessages,
 boolean showProgress)

Creates a new PDFAValidator initialised with the passed profile and parameters, requested fast failing behaviour.

Parameters:

flavours - the list of PDFAFlavour that's associated with the ValidationProfile to used to initialise th PDFAValidator.

maxFailures - an int value that configures the PDFAValidator to abort validation after maxFailures failed tests. If maxFailures is less than 1 then the PDFAValidator will complete the full validation process.

maxNumberOfDisplayedFailedChecks - a max checks number to show

logSuccess - a flag to show success logs

showErrorMessages - a flag to show error message

showProgress - a flag to show validation progress

Returns:

a PDFAValidator instance initialised from the passed parameters

createFailFastValidator

PDFAValidator createFailFastValidator(ValidationProfile profile,
 int maxFailures,
 int maxNumberOfDisplayedFailedChecks,
 boolean logSuccess,
 boolean showErrorMessages,
 boolean showProgress)

Creates a new PDFAValidator initialised with the passed profile and parameters, requested fast failing behaviour.

Parameters:

profile - the ValidationProfile to be enforced by the returned PDFAValidator.

maxFailures - an int value that configures the PDFAValidator to abort validation after maxFailures failed tests. If maxFailures is less than 1 then the PDFAValidator will complete the full validation process.

maxNumberOfDisplayedFailedChecks - a max checks number to show

logSuccess - a flag to show success logs

showErrorMessages - a flag to show error message

showProgress - a flag to show validation progress

Returns:

a PDFAValidator instance initialised from the passed parameters

createMetadataFixer

MetadataFixer createMetadataFixer()

Obtain a new MetadataFixer instance.

Returns:

a MetadataFixer instance.

defaultFlavour

PDFAFlavour defaultFlavour()

Returns:

the default PDFAFlavour set for this VeraPDFFoundry

getParserId

String getParserId()