Information about a signature field returned by SignDocDocument.getSignature(). More...

Public Member Functions
String	getFieldName () throws SignDocException
	Get the name of the signature field.
int	getFieldPage () throws SignDocException
	Get the page number of the signature field.
synchronized int	getSignatureType () throws SignDocException
	Get the type of the signature.
synchronized int	getClearedIndex () throws SignDocException
	Get the index of the signature at which this signature has been removed.
synchronized int	getDocMDP () throws SignDocException
	Get the DocMDP P value of a certification signature.
synchronized int	getLockMDP () throws SignDocException
	Get the lock MDP value.
synchronized byte[]	getSigningCertificate () throws SignDocException
	Get the signing certificate as DER-encoded blob.
synchronized String	getSignerCommonName () throws SignDocException
	Get the common name from the signing certificate.
synchronized String	getSignerEmail () throws SignDocException
	Get the email address from the signing certificate.
synchronized String	getTimeStamp () throws SignDocException
	Get the time stamp of the signature.
synchronized int	getChangeCount () throws SignDocException
	Get the number of changes that have been made after this signature.
synchronized SignDocChange	getChange (int aIndex) throws SignDocException
	Get a SignDocChange object for a change.
synchronized int	getBiometricEncryption () throws SignDocException
	Get the encryption method used for biometric data of the signature field.
Protected Member Functions
void	finalize () throws Throwable
	Finalize this object.

Detailed Description

Information about a signature field returned by SignDocDocument.getSignature().

Member Function Documentation

void de.softpro.doc.SignDocSignature.finalize ( ) throws Throwable [protected]

Finalize this object.

Do not call this method unless you know what you are doing.

synchronized int de.softpro.doc.SignDocSignature.getBiometricEncryption ( ) throws SignDocException

Get the encryption method used for biometric data of the signature field.

Note:: SignDocVerificationResult.getBiometricEncryption() provides better reporting of errors.

Returns:: The encryption method: be_rsa, be_fixed, be_binary, be_passphrase, or (on error), be_dont_store.

See also:: getChange()

synchronized SignDocChange de.softpro.doc.SignDocSignature.getChange ( int aIndex ) throws SignDocException

Get a SignDocChange object for a change.

Parameters:

[in] aIndex Zero-based index of the change.

Returns:: A SignDocChange object for the change or null if aIndex is out of range.

See also:: getChangeCount()

synchronized int de.softpro.doc.SignDocSignature.getChangeCount ( ) throws SignDocException

Get the number of changes that have been made after this signature.

For PDF documents, you can find out what changes have been made to the document between this signature and the next one (or after the last signature if this is the last signature).

Computing the changes can be expensive.

Changes are not reported in any particular order; before presenting them to a user, you should group them.

Detecting and categorizing changes is work in progress. Moreover, it will never be bug-compatible with Adobe products.

Returns:: The number of changes.

See also:: getChange()

synchronized int de.softpro.doc.SignDocSignature.getClearedIndex ( ) throws SignDocException

Get the index of the signature at which this signature has been removed.

This function always returns -1 for TIFF document.

Returns:: -1 if the signature has not been removed, that is, the field is still signed; a non-negative value (greater than the index of gthis signature) indicating the index of the signature at which this signature was found to have been removed. If the return value equals the number of signatures (as returned by SignDocDocument.getSignatureCount()), this signature has been removed after performing the last signature.

See also:: SignDocDocument.clearSignature(), SignDocDocument.getSignature(), SignDocDocument.getSignatureCount()

synchronized int de.softpro.doc.SignDocSignature.getDocMDP ( ) throws SignDocException

Get the DocMDP P value of a certification signature.

The DocMDP P value specifies what modifications to the document are allowed by the certification signature.

Returns:: -1 if this signature is not a certification signature, 1 if no modifications are allowed, 2 if only filling in forms, instantiating page templates, and signing are permitted, 3 if only filling in forms, instantiating page templates, signing, creating annotations, deleting annotations, and modifying annotations are permitted. For TIFF documents, this function always returns -1.

See also:: getLockMDP()

String de.softpro.doc.SignDocSignature.getFieldName ( ) throws SignDocException

Get the name of the signature field.

Returns:: The name of the signature field.

int de.softpro.doc.SignDocSignature.getFieldPage ( ) throws SignDocException

Get the page number of the signature field.

Returns:: The 1-based page number or 0 if the page number is unknown.

synchronized int de.softpro.doc.SignDocSignature.getLockMDP ( ) throws SignDocException

Get the lock MDP value.

The lock MDP value specifies what modifications to the document are allowed by the signature lock dictionary.

Returns:: -1 if the signature does not have a lock MDP value, 1 if no modifications are allowed, 2 if only filling in forms, instantiating page templates, and signing are permitted, 3 if only filling in forms, instantiating page templates, signing, creating annotations, deleting annotations, and modifying annotations are permitted. For TIFF documents, this function always returns -1.

See also:: getDocMDP()

synchronized int de.softpro.doc.SignDocSignature.getSignatureType ( ) throws SignDocException

Get the type of the signature.

Returns:: SignDocField.st_approval, SignDocField.st_certification, or SignDocField.st_document_time_stamp.

synchronized String de.softpro.doc.SignDocSignature.getSignerCommonName ( ) throws SignDocException

Get the common name from the signing certificate.

Returns:: The common name from the signing certificate, empty on error.

synchronized String de.softpro.doc.SignDocSignature.getSignerEmail ( ) throws SignDocException

Get the email address from the signing certificate.

Returns:: The email address from the signing certificate, empty on error.

synchronized byte [] de.softpro.doc.SignDocSignature.getSigningCertificate ( ) throws SignDocException

Get the signing certificate as DER-encoded blob.

Returns:: The DER-encoded signing certificate, null on error.

synchronized String de.softpro.doc.SignDocSignature.getTimeStamp ( ) throws SignDocException

Get the time stamp of the signature.

You have to use SignDocDocument.verifySignature() to find out whether the time stamp can be trusted.

Returns:: The time stamp of the signature in ISO 8601 format: "yyyy-mm-ddThh:mm:ss" with optional timezone. Empty on error.

The documentation for this class was generated from the following file:

de/softpro/doc/SignDocSignature.java

de.softpro.doc.SignDocSignature Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation