public class

EmbeddedTimestampVerificationResult

extends Object
implements AutoCloseable
java.lang.Object
   ↳ com.pdftron.pdf.EmbeddedTimestampVerificationResult

Class Overview

This class represents the result of verifying a secure embedded timestamp digital signature.

Summary

Public Constructors
EmbeddedTimestampVerificationResult(long impl_ptr)
Public Methods
long __GetHandle()
void close()
Frees the native memory of the object.
void destroy()
Frees the native memory of the object.
VerificationResult.DigestStatus getCMSDigestStatus()
Retrieves the result condition associated with the CMS signed digest verification step.
String getCMSDigestStatusAsString()
Retrieves the result condition associated with the CMS signed digest verification step, as a descriptive string.
DigestAlgorithm getCMSSignatureDigestAlgorithm()
Retrieves an enumeration value representing the digest algorithm used to sign the timestamp token.
DigestAlgorithm getMessageImprintDigestAlgorithm()
Retrieves an enumeration value representing the digest algorithm used inside the message imprint field of the timestamp to digest the main signature value.
VerificationResult.DigestStatus getMessageImprintDigestStatus()
Retrieves the result condition associated with the message imprint digest verification step.
String getMessageImprintDigestStatusAsString()
Retrieves the result condition associated with the message imprint digest verification step, as a descriptive string.
VerificationResult.TrustStatus getTrustStatus()
Retrieves the result condition associated with the trust verification step.
String getTrustStatusAsString()
Retrieves the result condition associated with the trust verification step, as a descriptive string.
TrustVerificationResult getTrustVerificationResult()
Retrieves the detailed result associated with the trust step of the verification operation that returned this EmbeddedTimestampVerificationResult, if such a detailed trust result is available.
String[] getUnsupportedFeatures()
Retrieves reports about unsupported features encountered during verification of the timestamp.
boolean getVerificationStatus()
Retrieves the main verification status.
boolean hasTrustVerificationResult()
Returns whether there is a detailed TrustVerificationResult in this EmbeddedTimestampVerificationResult.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.lang.AutoCloseable

Public Constructors

public EmbeddedTimestampVerificationResult (long impl_ptr)

Public Methods

public long __GetHandle ()

public void close ()

Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

Throws
PDFNetException

public void destroy ()

Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

Throws
PDFNetException

public VerificationResult.DigestStatus getCMSDigestStatus ()

Retrieves the result condition associated with the CMS signed digest verification step.

Returns
  • A DigestStatus-type enumeration value
Throws
PDFNetException

public String getCMSDigestStatusAsString ()

Retrieves the result condition associated with the CMS signed digest verification step, as a descriptive string. Output may change in future versions.

Returns
  • a string.
Throws
PDFNetException

public DigestAlgorithm getCMSSignatureDigestAlgorithm ()

Retrieves an enumeration value representing the digest algorithm used to sign the timestamp token.

Returns
  • A DigestAlgorithm enumeration value
Throws
PDFNetException

public DigestAlgorithm getMessageImprintDigestAlgorithm ()

Retrieves an enumeration value representing the digest algorithm used inside the message imprint field of the timestamp to digest the main signature value.

Returns
  • A DigestAlgorithm enumeration value
Throws
PDFNetException

public VerificationResult.DigestStatus getMessageImprintDigestStatus ()

Retrieves the result condition associated with the message imprint digest verification step.

Returns
  • A DigestStatus-type enumeration value
Throws
PDFNetException

public String getMessageImprintDigestStatusAsString ()

Retrieves the result condition associated with the message imprint digest verification step, as a descriptive string. Output may change in future versions.

Returns
  • a string.
Throws
PDFNetException

public VerificationResult.TrustStatus getTrustStatus ()

Retrieves the result condition associated with the trust verification step.

Returns
  • A TrustStatus-type enumeration value
Throws
PDFNetException

public String getTrustStatusAsString ()

Retrieves the result condition associated with the trust verification step, as a descriptive string. Output may change in future versions.

Returns
  • a string.
Throws
PDFNetException

public TrustVerificationResult getTrustVerificationResult ()

Retrieves the detailed result associated with the trust step of the verification operation that returned this EmbeddedTimestampVerificationResult, if such a detailed trust result is available. Must call HasTrustVerificationResult first and check for a true result. This function will throw if there is no trust result available.

Returns
  • A TrustVerificationResult object
Throws
PDFNetException

public String[] getUnsupportedFeatures ()

Retrieves reports about unsupported features encountered during verification of the timestamp. Current possible values: "GeneralizedTime format with length ", "unsupported digest algorithm" Output may change in future versions.

Returns
  • a container of strings representing unsupported features encountered during verification of the timestamp
Throws
PDFNetException

public boolean getVerificationStatus ()

Retrieves the main verification status. The main status is determined based on the other statuses.

Returns
  • A boolean representing whether or not the verification operation was completely successful
Throws
PDFNetException

public boolean hasTrustVerificationResult ()

Returns whether there is a detailed TrustVerificationResult in this EmbeddedTimestampVerificationResult.

Returns
  • A boolean
Throws
PDFNetException