com.aspose.words

Class DigitalSignatureCollection

  • java.lang.Object
    • com.aspose.words.DigitalSignatureCollection
  • All Implemented Interfaces:
    java.lang.Iterable
    public class DigitalSignatureCollection 
    extends java.lang.Object

Provides a read-only collection of digital signatures attached to a document.
Document.DigitalSignatures

Example:

Shows how to validate all signatures in a document.
// Load the signed document.
Document doc = new Document(getMyDir() + "Document.DigitalSignature.docx");
DigitalSignatureCollection digitalSignatureCollection = doc.getDigitalSignatures();

if (digitalSignatureCollection.isValid()) {
    System.out.println("Signatures belonging to this document are valid");
    System.out.println(digitalSignatureCollection.getCount());
    System.out.println(digitalSignatureCollection.get(0).getSignatureType());
} else {
    System.out.println("Signatures belonging to this document are NOT valid");
}

Example:

Shows how to validate each signature in a document and display basic information about the signature.
// Load the document which contains signature.
Document doc = new Document(getMyDir() + "Document.DigitalSignature.docx");

for (DigitalSignature signature : doc.getDigitalSignatures()) {
    System.out.println("*** Signature Found ***");
    System.out.println("Is valid: " + signature.isValid());
    System.out.println("Reason for signing: " + signature.getComments()); // This property is available in MS Word documents only.
    System.out.println("Signature type: " + DigitalSignatureType.toString(signature.getSignatureType()));
    System.out.println("Time of signing: " + signature.getSignTime());
    System.out.println("Subject name: " + signature.getSubjectName());
    System.out.println("Issuer name: " + signature.getIssuerName());
    System.out.println("Certificate type: " + signature.getCertificateHolder().getCertificate().getClass().getName());
    System.out.println();
}

Constructor Summary
 
Property Getters/Setters Summary
intgetCount()
Gets the number of elements contained in the collection.
booleanisValid()
Returns true if all digital signatures in this collection are valid and the document has not been tampered with Also returns true if there are no digital signatures. Returns false if at least one digital signature is invalid.
DigitalSignatureget(int index)
Gets a document signature at the specified index.
 
Method Summary
java.util.Iterator<DigitalSignature>iterator()
Returns a dictionary iterator object that can be used to iterate over all items in the collection.
 

    • Constructor Detail

      • DigitalSignatureCollection

        public DigitalSignatureCollection()
    • Property Getters/Setters Detail

      • getCount

        public int getCount()
        
        Gets the number of elements contained in the collection.

        Example:

        Shows how to validate all signatures in a document.
        // Load the signed document.
        Document doc = new Document(getMyDir() + "Document.DigitalSignature.docx");
        DigitalSignatureCollection digitalSignatureCollection = doc.getDigitalSignatures();
        
        if (digitalSignatureCollection.isValid()) {
            System.out.println("Signatures belonging to this document are valid");
            System.out.println(digitalSignatureCollection.getCount());
            System.out.println(digitalSignatureCollection.get(0).getSignatureType());
        } else {
            System.out.println("Signatures belonging to this document are NOT valid");
        }
      • isValid

        public boolean isValid()
        
        Returns true if all digital signatures in this collection are valid and the document has not been tampered with Also returns true if there are no digital signatures. Returns false if at least one digital signature is invalid.

        Example:

        Shows how to validate all signatures in a document.
        // Load the signed document.
        Document doc = new Document(getMyDir() + "Document.DigitalSignature.docx");
        DigitalSignatureCollection digitalSignatureCollection = doc.getDigitalSignatures();
        
        if (digitalSignatureCollection.isValid()) {
            System.out.println("Signatures belonging to this document are valid");
            System.out.println(digitalSignatureCollection.getCount());
            System.out.println(digitalSignatureCollection.get(0).getSignatureType());
        } else {
            System.out.println("Signatures belonging to this document are NOT valid");
        }
      • get

        public DigitalSignature get(int index)
        
        Gets a document signature at the specified index.
        Parameters:
        index - Zero-based index of the signature.

        Example:

        Shows how to validate all signatures in a document.
        // Load the signed document.
        Document doc = new Document(getMyDir() + "Document.DigitalSignature.docx");
        DigitalSignatureCollection digitalSignatureCollection = doc.getDigitalSignatures();
        
        if (digitalSignatureCollection.isValid()) {
            System.out.println("Signatures belonging to this document are valid");
            System.out.println(digitalSignatureCollection.getCount());
            System.out.println(digitalSignatureCollection.get(0).getSignatureType());
        } else {
            System.out.println("Signatures belonging to this document are NOT valid");
        }
    • Method Detail

      • iterator

        public java.util.Iterator<DigitalSignature> iterator()
        Returns a dictionary iterator object that can be used to iterate over all items in the collection.

        Example:

        Shows how to load and enumerate all digital signatures of a document.
        DigitalSignatureCollection digitalSignatures = DigitalSignatureUtil.loadSignatures(getMyDir() + "Document.DigitalSignature.docx");
        
        Iterator<DigitalSignature> enumerator = digitalSignatures.iterator();
        while (enumerator.hasNext()) {
            // Do something useful
            DigitalSignature ds = enumerator.next();
        
            if (ds != null)
                System.out.println(ds.toString());
        }