iaik.pdf.signature

Interface PdfSignatureDetails

All Known Subinterfaces:

ApprovalSignature, CertificationSignature, DocumentTimestamp

All Known Implementing Classes:

ApprovalSignatureItext, ApprovalSignaturePdfBox, CertificationSignatureItext, CertificationSignaturePdfBox, DocumentTimestampItext, DocumentTimestampPdfBox, PdfSignatureDetailsItext, PdfSignatureDetailsPdfBox

public interface PdfSignatureDetails

Extracts details of a PDF signature.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name of this signature.
void	getRevision(java.io.OutputStream pdfOutStream) Write only the signed parts of this document signed by this signature and the signature itself to the given output stream.
void	getRevision(java.io.OutputStream pdfOutStream, int offset) Write only the signed parts of this document signed by this signature and the signature itself to the given output stream starting at index offset.
void	getRevision(java.lang.String filename) Save only the signed parts of this document signed by this signature and the signature itself to the given path and filename.
java.util.Calendar	getSignatureDictionaryDate() Returns the signing date, as set in the PDF signature dictionary (with dictionary key name "M").
java.util.Calendar	getSigningTime() Get the time of signature creation.
java.lang.String	getSubfilter() Returns the subfilter of this signature.
boolean	isModified() Check whether the document has been modified after the signature was applied by verifying that the document ends after the last byte of the signed version.

Method Detail

isModified

boolean isModified()

Check whether the document has been modified after the signature was applied by verifying that the document ends after the last byte of the signed version.

Returns:

true, if the document has been modified

getSigningTime

java.util.Calendar getSigningTime()

Get the time of signature creation. If included the time given by the signature timestamp is used. Otherwise the time given in the PDF signature dictionary is returned.

Returns:

time of signature creation

getRevision

void getRevision(java.lang.String filename)
          throws java.io.IOException

Save only the signed parts of this document signed by this signature and the signature itself to the given path and filename.

Parameters:

filename - The path and file name where to save the signed version

Throws:

java.io.IOException - if the signed version can't be extracted or written

getRevision

void getRevision(java.io.OutputStream pdfOutStream)
          throws java.io.IOException

Write only the signed parts of this document signed by this signature and the signature itself to the given output stream.

Parameters:

pdfOutStream - the output stream to write the signed version to

Throws:

java.io.IOException - if the signed version can't be extracted or written

getRevision

void getRevision(java.io.OutputStream pdfOutStream,
                 int offset)
          throws java.io.IOException

Write only the signed parts of this document signed by this signature and the signature itself to the given output stream starting at index offset.

Parameters:

pdfOutStream - the output stream to write the signed version to

offset - offset where to start writing the signed version

Throws:

java.io.IOException - if the signed version can't be extracted or written

getName

java.lang.String getName()

Returns the name of this signature.

Returns:

the signature's name

getSubfilter

java.lang.String getSubfilter()

Returns the subfilter of this signature. Typical subfilters are "adbe.pkcs7.detached" for PAdES-basic signatures, "ETSI.CAdES.detached" for PAdES-BES signatures and "ETSI.RFC3161" for PAdES LTV Document Timestamps.

Returns:

the signature's subfilter

getSignatureDictionaryDate

java.util.Calendar getSignatureDictionaryDate()

Returns the signing date, as set in the PDF signature dictionary (with dictionary key name "M"). Does not return the date embedded in the CMS signature.

Returns:

the signing date specified in the PDF signature dictionary