Package eu.europa.esig.dss.diagnostic

Class PDFRevisionWrapper

java.lang.Object

eu.europa.esig.dss.diagnostic.PDFRevisionWrapper

public class PDFRevisionWrapper
extends Object

Contains user-friendly methods to extract information from an eu.europa.esig.dss.diagnostic.jaxb.XmlPDFRevision

Constructor Summary

Constructors

Constructor	Description
PDFRevisionWrapper(XmlPDFRevision pdfRevision)	Default constructor

Method Summary

Modifier and Type	Method	Description
boolean	arePdfModificationsDetected()	Checks if any visual modifications detected in the PDF
boolean	arePdfObjectModificationsDetected()	This method checks whether object modifications are present after the current PDF revisions
String	getContactInfo()	Returns the PDF signature dictionary /ContactInfo value
CertificationPermission	getDocMDPPermissions()	Returns a CertificationPermission value of a /DocMDP dictionary, when present
XmlPDFLockDictionary	getFieldMDP()	Returns a /FieldMDP dictionary content, when present
String	getFilter()	Returns the PDF signature dictionary /Filter value
String	getFirstFieldName()	Returns the first signature field name
String	getLocation()	Returns the PDF signature dictionary /Location value
List<String>	getModifiedFieldNames()	This method returns a list of field names modified after the current signature's revision
List<XmlObjectModification>	getPdfAnnotationChanges()	Returns a list of changes occurred in a PDF after the current signature's revision associated with annotation(s) modification
List<BigInteger>	getPdfAnnotationsOverlapConcernedPages()	Returns a list of PDF annotation overlap concerned pages
List<XmlObjectModification>	getPdfExtensionChanges()	Returns a list of changes occurred in a PDF after the current signature's revision associated with a signature/document extension
List<BigInteger>	getPdfPageDifferenceConcernedPages()	Returns a list of pages missing/added to the final revision in a comparison with a signed one
List<XmlObjectModification>	getPdfSignatureOrFormFillChanges()	Returns a list of changes occurred in a PDF after the current signature's revision associated with a signature creation, form filling
List<XmlObjectModification>	getPdfUndefinedChanges()	Returns a list of undefined changes occurred in a PDF after the current signature's revision
List<BigInteger>	getPdfVisualDifferenceConcernedPages()	Returns a list of PDF visual difference concerned pages
String	getReason()	Returns the PDF signature dictionary /Reason value
XmlPDFLockDictionary	getSigFieldLock()	Returns a /SigFieldLock dictionary, when present
List<BigInteger>	getSignatureByteRange()	Returns the PDF signature dictionary /ByteRange value
String	getSignatureDictionaryType()	Returns the PDF signature dictionary /Type value
List<String>	getSignatureFieldNames()	Returns a list of signature field names, where the signature is referenced from
String	getSignerName()	Returns the signer's name
String	getSubFilter()	Returns the PDF signature dictionary /SubFilter value
boolean	isPdfSignatureDictionaryConsistent()	This method returns whether the PDF signature dictionary is consistent across PDF revisions.
boolean	isSignatureByteRangeValid()	This method returns whether the PDF signature dictionary /ByteRange is found and valid

Methods inherited from class java.lang.Object

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

Constructor Details

PDFRevisionWrapper

public PDFRevisionWrapper(XmlPDFRevision pdfRevision)

Default constructor

Parameters:

pdfRevision - XmlPDFRevision

Method Details

arePdfModificationsDetected

public boolean arePdfModificationsDetected()

Checks if any visual modifications detected in the PDF

Returns:

TRUE if modifications detected in a PDF, FALSE otherwise

getPdfAnnotationsOverlapConcernedPages

public List<BigInteger> getPdfAnnotationsOverlapConcernedPages()

Returns a list of PDF annotation overlap concerned pages

Returns:

a list of page numbers

getPdfVisualDifferenceConcernedPages

public List<BigInteger> getPdfVisualDifferenceConcernedPages()

Returns a list of PDF visual difference concerned pages

Returns:

a list of page numbers

getPdfPageDifferenceConcernedPages

public List<BigInteger> getPdfPageDifferenceConcernedPages()

Returns a list of pages missing/added to the final revision in a comparison with a signed one

Returns:

a list of page numbers

arePdfObjectModificationsDetected

public boolean arePdfObjectModificationsDetected()

This method checks whether object modifications are present after the current PDF revisions

Returns:

TRUE if PDF has been modified, FALSE otherwise

getPdfExtensionChanges

public List<XmlObjectModification> getPdfExtensionChanges()

Returns a list of changes occurred in a PDF after the current signature's revision associated with a signature/document extension

Returns:

a list of XmlObjectModifications

getPdfSignatureOrFormFillChanges

public List<XmlObjectModification> getPdfSignatureOrFormFillChanges()

Returns a list of changes occurred in a PDF after the current signature's revision associated with a signature creation, form filling

Returns:

a list of XmlObjectModifications

getPdfAnnotationChanges

public List<XmlObjectModification> getPdfAnnotationChanges()

Returns a list of changes occurred in a PDF after the current signature's revision associated with annotation(s) modification

Returns:

a list of XmlObjectModifications

getPdfUndefinedChanges

public List<XmlObjectModification> getPdfUndefinedChanges()

Returns a list of undefined changes occurred in a PDF after the current signature's revision

Returns:

a list of XmlObjectModifications

getModifiedFieldNames

public List<String> getModifiedFieldNames()

This method returns a list of field names modified after the current signature's revision

Returns:

a list of Strings

getFirstFieldName

public String getFirstFieldName()

Returns the first signature field name

Returns:

String field name

getSignatureFieldNames

public List<String> getSignatureFieldNames()

Returns a list of signature field names, where the signature is referenced from

Returns:

a list of String signature field names

getSignerName

public String getSignerName()

Returns the signer's name

Returns:

String

getSignatureDictionaryType

public String getSignatureDictionaryType()

Returns the PDF signature dictionary /Type value

Returns:

String

getFilter

public String getFilter()

Returns the PDF signature dictionary /Filter value

Returns:

String

getSubFilter

public String getSubFilter()

Returns the PDF signature dictionary /SubFilter value

Returns:

String

getContactInfo

public String getContactInfo()

Returns the PDF signature dictionary /ContactInfo value

Returns:

String

getLocation

public String getLocation()

Returns the PDF signature dictionary /Location value

Returns:

String

getReason

public String getReason()

Returns the PDF signature dictionary /Reason value

Returns:

String

getSignatureByteRange

public List<BigInteger> getSignatureByteRange()

Returns the PDF signature dictionary /ByteRange value

Returns:

byte range

isSignatureByteRangeValid

public boolean isSignatureByteRangeValid()

This method returns whether the PDF signature dictionary /ByteRange is found and valid

Returns:

TRUE if the /ByteRange is valid, FALSE otherwise

isPdfSignatureDictionaryConsistent

public boolean isPdfSignatureDictionaryConsistent()

This method returns whether the PDF signature dictionary is consistent across PDF revisions.

Returns:

TRUE if the signature dictionary is consistent, FALSE otherwise

getDocMDPPermissions

public CertificationPermission getDocMDPPermissions()

Returns a CertificationPermission value of a /DocMDP dictionary, when present

Returns:

CertificationPermission

getFieldMDP

public XmlPDFLockDictionary getFieldMDP()

Returns a /FieldMDP dictionary content, when present

Returns:

XmlPDFLockDictionary

getSigFieldLock

public XmlPDFLockDictionary getSigFieldLock()

Returns a /SigFieldLock dictionary, when present

Returns:

XmlPDFLockDictionary