Top Fields Constructors Methods
org.apache.pdfbox.preflight

public Class PreflightConfiguration

extends Object
Class Inheritance
Imports
java.lang.reflect.InvocationTargetException, java.util.Collection, .LinkedHashMap, .Map, org.apache.pdfbox.preflight.action.ActionManagerFactory, org.apache.pdfbox.preflight.annotation.AnnotationValidatorFactory, org.apache.pdfbox.preflight.annotation.pdfa.PDFAbAnnotationFactory, org.apache.pdfbox.preflight.exception.MissingValidationProcessException, .ValidationException, org.apache.pdfbox.preflight.graphic.ColorSpaceHelperFactory, org.apache.pdfbox.preflight.process.AcroFormValidationProcess, .BookmarkValidationProcess, .CatalogValidationProcess, .EmptyValidationProcess, .FileSpecificationValidationProcess, .MetadataValidationProcess, .PageTreeValidationProcess, .StreamValidationProcess, .TrailerValidationProcess, .ValidationProcess, .XRefValidationProcess, org.apache.pdfbox.preflight.process.reflect.ActionsValidationProcess, .AnnotationValidationProcess, .DestinationValidationProcess, .ExtGStateValidationProcess, .FontValidationProcess, .GraphicObjectPageValidationProcess, .ResourcesValidationProcess, .ShadingPatternValidationProcess, .SinglePageValidationProcess, .TilingPatternValidationProcess

Field Summary

Modifier and TypeField and Description
public static final String
ACRO_FORM_PROCESS

private ActionManagerFactory
actionFact

Define the ActionManagerFactory used by ValidationProcess

public static final String
ACTIONS_PROCESS

public static final String
ANNOTATIONS_PROCESS

private AnnotationValidatorFactory
annotFact

Define the AnnotationFactory used by ValidationProcess

public static final String
BOOKMARK_PROCESS

public static final String
CATALOG_PROCESS

private ColorSpaceHelperFactory
colorSpaceHelperFact

Define the ColorSpaceHelperFactory used by the validationProcess.

public static final String
DESTINATION_PROCESS

private boolean
errorOnMissingProcess

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

public static final String
EXTGSTATE_PROCESS

public static final String
FILE_SPECIF_PROCESS

public static final String
FONT_PROCESS

public 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.

public static final String
META_DATA_PROCESS

public static final String
PAGE_PROCESS

public static final String
PAGES_TREE_PROCESS

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

public static final String
RESOURCES_PROCESS

public static final String
SHADING_PATTERN_PROCESS

public static final String
STREAM_PROCESS

public static final String
TILING_PATTERN_PROCESS

public static final String
TRAILER_PROCESS

public static final String
XREF_PROCESS

Constructor Summary

AccessConstructor and Description
public
PreflightConfiguration()

Method Summary

Modifier and TypeMethod and Description
public static PreflightConfiguration
createPdfA1BConfiguration()

public ActionManagerFactory
getActionFact()

public AnnotationValidatorFactory
getAnnotFact()

public ColorSpaceHelperFactory
getColorSpaceHelperFact()

public ValidationProcess

Returns:

an instance of validationProcess, null if it doesn't exist and if the errorOnMissingProcess is false.
getInstanceOfProcess(String processName)

Return the validation process linked with the given name

public int
getMaxErrors()

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

public Collection<String>
getPageValidationProcessNames()

public Collection<String>
getProcessNames()

public boolean
isErrorOnMissingProcess()

public boolean
isLazyValidation()

public void
removePageProcess(String processName)

public void
removeProcess(String processName)

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

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

public void
setActionFact(ActionManagerFactory actionFact)

public void
setAnnotFact(AnnotationValidatorFactory annotFact)

public void
setColorSpaceHelperFact(ColorSpaceHelperFactory colorSpaceHelperFact)

public void
setErrorOnMissingProcess(boolean errorOnMissingProcess)

public void
setLazyValidation(boolean lazyValidation)

public void
setMaxErrors(int maxErrors)

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

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ACRO_FORM_PROCESSback to summary
public static final String ACRO_FORM_PROCESS
actionFactback to summary
private ActionManagerFactory actionFact

Define the ActionManagerFactory used by ValidationProcess

ACTIONS_PROCESSback to summary
public static final String ACTIONS_PROCESS
ANNOTATIONS_PROCESSback to summary
public static final String ANNOTATIONS_PROCESS
annotFactback to summary
private AnnotationValidatorFactory annotFact

Define the AnnotationFactory used by ValidationProcess

BOOKMARK_PROCESSback to summary
public static final String BOOKMARK_PROCESS
CATALOG_PROCESSback to summary
public static final String CATALOG_PROCESS
colorSpaceHelperFactback to summary
private ColorSpaceHelperFactory colorSpaceHelperFact

Define the ColorSpaceHelperFactory used by the validationProcess.

DESTINATION_PROCESSback to summary
public static final String DESTINATION_PROCESS
errorOnMissingProcessback to summary
private boolean errorOnMissingProcess

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

EXTGSTATE_PROCESSback to summary
public static final String EXTGSTATE_PROCESS
FILE_SPECIF_PROCESSback to summary
public static final String FILE_SPECIF_PROCESS
FONT_PROCESSback to summary
public static final String FONT_PROCESS
GRAPHIC_PROCESSback to summary
public static final String GRAPHIC_PROCESS
innerProcessesback to summary
private final Map<String, Class<? extends ValidationProcess>> innerProcesses
lazyValidationback to summary
private boolean lazyValidation

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

maxErrorsback to summary
private int maxErrors

Define the maximum number of errors.

META_DATA_PROCESSback to summary
public static final String META_DATA_PROCESS
PAGE_PROCESSback to summary
public static final String PAGE_PROCESS
PAGES_TREE_PROCESSback to summary
public static final String PAGES_TREE_PROCESS
processesback to summary
private final Map<String, Class<? extends ValidationProcess>> processes
RESOURCES_PROCESSback to summary
public static final String RESOURCES_PROCESS
SHADING_PATTERN_PROCESSback to summary
public static final String SHADING_PATTERN_PROCESS
STREAM_PROCESSback to summary
public static final String STREAM_PROCESS
TILING_PATTERN_PROCESSback to summary
public static final String TILING_PATTERN_PROCESS
TRAILER_PROCESSback to summary
public static final String TRAILER_PROCESS
XREF_PROCESSback to summary
public static final String XREF_PROCESS

Constructor Detail

PreflightConfigurationback to summary
public PreflightConfiguration()

Method Detail

createPdfA1BConfigurationback to summary
public static PreflightConfiguration createPdfA1BConfiguration()
getActionFactback to summary
public ActionManagerFactory getActionFact()
getAnnotFactback to summary
public AnnotationValidatorFactory getAnnotFact()
getColorSpaceHelperFactback to summary
public ColorSpaceHelperFactory getColorSpaceHelperFact()
getInstanceOfProcessback to summary
public ValidationProcess getInstanceOfProcess(String processName) throws ValidationException

Return the validation process linked with the given name

Returns:ValidationProcess

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

Exceptions
ValidationException:
if the process instance can't be created.
MissingValidationProcessException:
if the Process doesn't exist (errorOnMissingProcess is true).
getMaxErrorsback to summary
public int getMaxErrors()

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

getPageValidationProcessNamesback to summary
public Collection<String> getPageValidationProcessNames()
getProcessNamesback to summary
public Collection<String> getProcessNames()
isErrorOnMissingProcessback to summary
public boolean isErrorOnMissingProcess()
isLazyValidationback to summary
public boolean isLazyValidation()
removePageProcessback to summary
public void removePageProcess(String processName)
removeProcessback to summary
public void removeProcess(String processName)
replacePageProcessback to summary
public void replacePageProcess(String processName, Class<? extends ValidationProcess> process)
replaceProcessback to summary
public void replaceProcess(String processName, Class<? extends ValidationProcess> process)
setActionFactback to summary
public void setActionFact(ActionManagerFactory actionFact)
setAnnotFactback to summary
public void setAnnotFact(AnnotationValidatorFactory annotFact)
setColorSpaceHelperFactback to summary
public void setColorSpaceHelperFact(ColorSpaceHelperFactory colorSpaceHelperFact)
setErrorOnMissingProcessback to summary
public void setErrorOnMissingProcess(boolean errorOnMissingProcess)
setLazyValidationback to summary
public void setLazyValidation(boolean lazyValidation)
setMaxErrorsback to summary
public void setMaxErrors(int maxErrors)

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