Package org.apache.pdfbox.preflight

Class PreflightConfiguration

java.lang.Object

org.apache.pdfbox.preflight.PreflightConfiguration

public class PreflightConfiguration
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACRO_FORM_PROCESS
private ActionManagerFactory	actionFact	Define the ActionManagerFactory used by ValidationProcess
static final String	ACTIONS_PROCESS
static final String	ANNOTATIONS_PROCESS
private AnnotationValidatorFactory	annotFact	Define the AnnotationFactory used by ValidationProcess
static final String	BOOKMARK_PROCESS
static final String	CATALOG_PROCESS
private ColorSpaceHelperFactory	colorSpaceHelperFact	Define the ColorSpaceHelperFactory used by the validationProcess.
static final String	DESTINATION_PROCESS
private boolean	errorOnMissingProcess	Boolean to know if an exception must be thrown if a ValidationProcess is missing.
static final String	EXTGSTATE_PROCESS
static final String	FILE_SPECIF_PROCESS
static final String	FONT_PROCESS
static final String	GRAPHIC_PROCESS
private final Map<String,Class<? extends ValidationProcess>>	innerProcesses
private boolean	lazyValidation	Boolean to know mark some error as a Warning, if the validation result contains only warning the validation is successful
private int	maxErrors	Define the maximum number of errors.
static final String	META_DATA_PROCESS
static final String	PAGE_PROCESS
static final String	PAGES_TREE_PROCESS
private final Map<String,Class<? extends ValidationProcess>>	processes
static final String	RESOURCES_PROCESS
static final String	SHADING_PATTERN_PROCESS
static final String	STREAM_PROCESS
static final String	TILING_PATTERN_PROCESS
static final String	TRAILER_PROCESS
static final String	XREF_PROCESS

Constructor Summary

Constructors

Constructor	Description
PreflightConfiguration()

Method Summary

Modifier and Type	Method	Description
static PreflightConfiguration	createPdfA1BConfiguration()
ActionManagerFactory	getActionFact()
AnnotationValidatorFactory	getAnnotFact()
ColorSpaceHelperFactory	getColorSpaceHelperFact()
ValidationProcess	getInstanceOfProcess(String processName)	Return the validation process linked with the given name
int	getMaxErrors()	Get the maximum number of errors after which to abort when possible.
Collection<String>	getPageValidationProcessNames()
Collection<String>	getProcessNames()
boolean	isErrorOnMissingProcess()
boolean	isLazyValidation()
void	removePageProcess(String processName)
void	removeProcess(String processName)
void	replacePageProcess(String processName, Class<? extends ValidationProcess> process)
void	replaceProcess(String processName, Class<? extends ValidationProcess> process)
void	setActionFact(ActionManagerFactory actionFact)
void	setAnnotFact(AnnotationValidatorFactory annotFact)
void	setColorSpaceHelperFact(ColorSpaceHelperFactory colorSpaceHelperFact)
void	setErrorOnMissingProcess(boolean errorOnMissingProcess)
void	setLazyValidation(boolean lazyValidation)
void	setMaxErrors(int maxErrors)	Set the maximum number of errors after which to abort when possible.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CATALOG_PROCESS

public static final String CATALOG_PROCESS

See Also:

• Constant Field Values

STREAM_PROCESS

public static final String STREAM_PROCESS

See Also:

• Constant Field Values

TRAILER_PROCESS

public static final String TRAILER_PROCESS

See Also:

• Constant Field Values

XREF_PROCESS

public static final String XREF_PROCESS

See Also:

• Constant Field Values

BOOKMARK_PROCESS

public static final String BOOKMARK_PROCESS

See Also:

• Constant Field Values

ACRO_FORM_PROCESS

public static final String ACRO_FORM_PROCESS

See Also:

• Constant Field Values

FILE_SPECIF_PROCESS

public static final String FILE_SPECIF_PROCESS

See Also:

• Constant Field Values

PAGES_TREE_PROCESS

public static final String PAGES_TREE_PROCESS

See Also:

• Constant Field Values

META_DATA_PROCESS

public static final String META_DATA_PROCESS

See Also:

• Constant Field Values

PAGE_PROCESS

public static final String PAGE_PROCESS

See Also:

• Constant Field Values

RESOURCES_PROCESS

public static final String RESOURCES_PROCESS

See Also:

• Constant Field Values

ACTIONS_PROCESS

public static final String ACTIONS_PROCESS

See Also:

• Constant Field Values

ANNOTATIONS_PROCESS

public static final String ANNOTATIONS_PROCESS

See Also:

• Constant Field Values

GRAPHIC_PROCESS

public static final String GRAPHIC_PROCESS

See Also:

• Constant Field Values

FONT_PROCESS

public static final String FONT_PROCESS

See Also:

• Constant Field Values

EXTGSTATE_PROCESS

public static final String EXTGSTATE_PROCESS

See Also:

• Constant Field Values

SHADING_PATTERN_PROCESS

public static final String SHADING_PATTERN_PROCESS

See Also:

• Constant Field Values

TILING_PATTERN_PROCESS

public static final String TILING_PATTERN_PROCESS

See Also:

• Constant Field Values

DESTINATION_PROCESS

public static final String DESTINATION_PROCESS

See Also:

• Constant Field Values

errorOnMissingProcess

private boolean errorOnMissingProcess

Boolean to know if an exception must be thrown if a ValidationProcess is missing.

lazyValidation

private boolean lazyValidation

Boolean to know mark some error as a Warning, if the validation result contains only warning the validation is successful

processes

private final Map<String,Class<? extends ValidationProcess>> processes

innerProcesses

private final Map<String,Class<? extends ValidationProcess>> innerProcesses

annotFact

private AnnotationValidatorFactory annotFact

Define the AnnotationFactory used by ValidationProcess

actionFact

private ActionManagerFactory actionFact

Define the ActionManagerFactory used by ValidationProcess

colorSpaceHelperFact

private ColorSpaceHelperFactory colorSpaceHelperFact

Define the ColorSpaceHelperFactory used by the validationProcess.

maxErrors

private int maxErrors

Define the maximum number of errors.

Constructor Details

PreflightConfiguration

public PreflightConfiguration()

Method Details

createPdfA1BConfiguration

public static PreflightConfiguration createPdfA1BConfiguration()

getProcessNames

public Collection<String> getProcessNames()

getInstanceOfProcess

public ValidationProcess getInstanceOfProcess(String processName)
                                       throws ValidationException

Return the validation process linked with the given name

Parameters:

processName -

Returns:

an instance of validationProcess, null if it doesn't exist and if the errorOnMissingProcess is false.

Throws:

MissingValidationProcessException - if the Process doesn't exist (errorOnMissingProcess is true).

ValidationException - if the process instance can't be created.

replaceProcess

public void replaceProcess(String processName,
 Class<? extends ValidationProcess> process)

removeProcess

public void removeProcess(String processName)

getPageValidationProcessNames

public Collection<String> getPageValidationProcessNames()

replacePageProcess

public void replacePageProcess(String processName,
 Class<? extends ValidationProcess> process)

removePageProcess

public void removePageProcess(String processName)

isErrorOnMissingProcess

public boolean isErrorOnMissingProcess()

setErrorOnMissingProcess

public void setErrorOnMissingProcess(boolean errorOnMissingProcess)

isLazyValidation

public boolean isLazyValidation()

setLazyValidation

public void setLazyValidation(boolean lazyValidation)

getAnnotFact

public AnnotationValidatorFactory getAnnotFact()

setAnnotFact

public void setAnnotFact(AnnotationValidatorFactory annotFact)

getActionFact

public ActionManagerFactory getActionFact()

setActionFact

public void setActionFact(ActionManagerFactory actionFact)

getColorSpaceHelperFact

public ColorSpaceHelperFactory getColorSpaceHelperFact()

setColorSpaceHelperFact

public void setColorSpaceHelperFact(ColorSpaceHelperFactory colorSpaceHelperFact)

getMaxErrors

public int getMaxErrors()

Get the maximum number of errors after which to abort when possible.

Returns:

setMaxErrors

public void setMaxErrors(int maxErrors)

Set the maximum number of errors after which to abort when possible.

Parameters:

maxErrors -