VerificationResult
extends Objectimplements AutoCloseable
| java.lang.Object | |
| ↳ | com.pdftron.pdf.VerificationResult |
Class Overview
The result of a verification operation performed on a digital signature.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| enum | VerificationResult.DigestStatus | ||||||||||
| enum | VerificationResult.DocumentStatus | ||||||||||
| enum | VerificationResult.ModificationPermissionsStatus | ||||||||||
| enum | VerificationResult.TrustStatus | ||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| VerificationResult(long impl_ptr, Object ref) | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| long | __GetHandle() | ||||||||||
| Object | __GetRefHandle() | ||||||||||
| void |
close()
Frees the native memory of the object.
| ||||||||||
| void |
destroy()
Frees the native memory of the object.
| ||||||||||
| DigestAlgorithm |
getDigestAlgorithm()
Retrieves an enumeration value representing the digest algorithm used to sign the signature that is associated with this verification result.
| ||||||||||
| VerificationResult.DigestStatus |
getDigestStatus()
Retrieves the digest-related result condition associated with a digital signature verification operation.
| ||||||||||
| String |
getDigestStatusAsString()
Retrieves the digest-related result condition associated with a digital signature verification operation, as a descriptive string.
| ||||||||||
| DigitalSignatureField |
getDigitalSignatureField()
Retrieves the digital signature field associated with the digital signature verification operation that returned this result.
| ||||||||||
| DisallowedChange[] |
getDisallowedChanges()
Retrieves a list of informational structures regarding any disallowed changes that have been made to the document since the signature associated with this verification result was signed.
| ||||||||||
| VerificationResult.DocumentStatus |
getDocumentStatus()
Retrieves the document-related result condition associated with a digital signature verification operation.
| ||||||||||
| String |
getDocumentStatusAsString()
Retrieves the document-related result condition associated with a digital signature verification operation, as a descriptive string.
| ||||||||||
| VerificationResult.ModificationPermissionsStatus |
getPermissionsStatus()
Retrieves the result condition about permissions checks performed on any unsigned modifications associated with a digital signature verification operation.
| ||||||||||
| String |
getPermissionsStatusAsString()
Retrieves the result condition about permissions checks performed on any unsigned modifications associated with a digital signature verification operation, as a descriptive string.
| ||||||||||
| VerificationResult.TrustStatus |
getTrustStatus()
Retrieves the trust-related result condition associated with a digital signature verification operation.
| ||||||||||
| String |
getTrustStatusAsString()
Retrieves the trust-related result condition associated with a digital signature verification operation, as a descriptive string.
| ||||||||||
| TrustVerificationResult |
getTrustVerificationResult()
Retrieves the detailed result associated with the trust step of the verification operation that returned this VerificationResult, if such a detailed trust result is available.
| ||||||||||
| String[] |
getUnsupportedFeatures()
Retrieves reports about unsupported features encountered during verification.
| ||||||||||
| boolean |
getVerificationStatus()
Retrieves the main verification status.
| ||||||||||
| boolean |
hasTrustVerificationResult()
Returns whether there is a detailed TrustVerificationResult in this VerificationResult or not.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
|
From interface
java.lang.AutoCloseable
| |||||||||||
Public Constructors
public VerificationResult (long impl_ptr, Object ref)
Public Methods
public long __GetHandle ()
public Object __GetRefHandle ()
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 DigestAlgorithm getDigestAlgorithm ()
Retrieves an enumeration value representing the digest algorithm used to sign the signature that is associated with this verification result. For DocTimeStamp signatures, returns the weakest algorithm found (between the CMS and message imprint digests).
Returns
- A DigestAlgorithm enumeration value
Throws
| PDFNetException |
|---|
public VerificationResult.DigestStatus getDigestStatus ()
Retrieves the digest-related result condition associated with a digital signature verification operation.
Returns
- A DigestStatus-type enumeration value
Throws
| PDFNetException |
|---|
public String getDigestStatusAsString ()
Retrieves the digest-related result condition associated with a digital signature verification operation, as a descriptive string.
Returns
- a string
Throws
| PDFNetException |
|---|
public DigitalSignatureField getDigitalSignatureField ()
Retrieves the digital signature field associated with the digital signature verification operation that returned this result.
Returns
- A DigitalSignatureField object
Throws
| PDFNetException |
|---|
public DisallowedChange[] getDisallowedChanges ()
Retrieves a list of informational structures regarding any disallowed changes that have been made to the document since the signature associated with this verification result was signed.
Returns
- a collection of DisallowedChange objects.
Throws
| PDFNetException |
|---|
public VerificationResult.DocumentStatus getDocumentStatus ()
Retrieves the document-related result condition associated with a digital signature verification operation.
Returns
- A DocumentStatus-type enumeration value
Throws
| PDFNetException |
|---|
public String getDocumentStatusAsString ()
Retrieves the document-related result condition associated with a digital signature verification operation, as a descriptive string.
Returns
- a string
Throws
| PDFNetException |
|---|
public VerificationResult.ModificationPermissionsStatus getPermissionsStatus ()
Retrieves the result condition about permissions checks performed on any unsigned modifications associated with a digital signature verification operation.
Returns
- A ModificationPermissionsStatus-type enumeration value
Throws
| PDFNetException |
|---|
public String getPermissionsStatusAsString ()
Retrieves the result condition about permissions checks performed on any unsigned modifications associated with a digital signature verification operation, as a descriptive string.
Returns
- a string
Throws
| PDFNetException |
|---|
public VerificationResult.TrustStatus getTrustStatus ()
Retrieves the trust-related result condition associated with a digital signature verification operation.
Returns
- A TrustStatus-type enumeration value
Throws
| PDFNetException |
|---|
public String getTrustStatusAsString ()
Retrieves the trust-related result condition associated with a digital signature verification operation, as a descriptive string.
Returns
- a string
Throws
| PDFNetException |
|---|
public TrustVerificationResult getTrustVerificationResult ()
Retrieves the detailed result associated with the trust step of the verification operation that returned this VerificationResult, if such a detailed trust result is available. Must call HasTrustVerificationResult first and check for a true result.
Returns
- An optional TrustVerificationResult
Throws
| PDFNetException |
|---|
public String[] getUnsupportedFeatures ()
Retrieves reports about unsupported features encountered during verification. This function is the canonical source of information about all unsupported features encountered. Current possible values: "unsupported signature encoding", "usage rights signature", "legal content attestations", "unsupported digest algorithm" Output may change in future versions.
Returns
- a container of strings representing unsupported features encountered during verification
Throws
| PDFNetException |
|---|
public boolean getVerificationStatus ()
Retrieves the main verification status. The main status is determined based on the other statuses. Verification may fail for many reasons; some of these reasons are the presence of features that are not supported yet. It may be desirable for you to report unsupported signatures differently (for example, using a question mark rather than an X mark). Any unsupported features encountered can be retrieved by the use of the function GetUnsupportedFeatures on this class.
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 VerificationResult or not.
Returns
- A boolean
Throws
| PDFNetException |
|---|