SignDocSignature Class Reference

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

Inheritance diagram for SignDocSignature:

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

Protected Member Functions
void	finalize () throws Throwable
	Finalize this object. More...

Detailed Description

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

If the SignDocDocument object is closed or destroyed before the SignDocSignature objects returned by its getSignature() function, some functions may fail.

Member Function Documentation

synchronized void close

(

)

Destroy the underlying native object (for java.lang.AutoCloseable).

After calling this method, all methods but close() will throw SignDocUnexpectedErrorException.

void finalize ( ) throws Throwable

protected

Finalize this object.

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

synchronized int 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: SignDocSignatureParameters.be_rsa, SignDocSignatureParameters.be_fixed, SignDocSignatureParameters.be_binary, SignDocSignatureParameters.be_passphrase, or (on error), SignDocSignatureParameters.be_dont_store.

See also

getChange()

synchronized SignDocChange 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 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 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 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 getFieldName

(

)

throws SignDocException

Get the name of the signature field.

Returns

The name of the signature field.

int 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 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 getMethod

(

)

throws SignDocException

Get the signing method.

If the output is SignDocSignatureParameters.m_digsig_cades_rfc3161, the signature is a document time stamp.

Returns

The signing method (SignDocSignatureParameters.m_digsig_pkcs7_detached etc., including SignDocSignatureParameters.m_digsig_cades_rfc3161, excluding SignDocSignatureParameters.m_default).

synchronized int getSignatureType

(

)

throws SignDocException

Get the type of the signature.

Returns

SignDocField.st_approval, SignDocField.st_certification, or SignDocField.st_document_time_stamp.

synchronized String getSignerCommonName

(

)

throws SignDocException

Get the common name from the signing certificate.

Returns

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

synchronized String getSignerEmail

(

)

throws SignDocException

Get the email address from the signing certificate.

Returns

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

synchronized byte [] getSigningCertificate

(

)

throws SignDocException

Get the signing certificate as DER-encoded blob.

Returns

The DER-encoded signing certificate, null on error.

synchronized String 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