Method Details

• getSignatureImage

  byte[] getSignatureImage()

  Gets the signature image used to sign the document.

  Use this method to read the persisted signature image bytes from the signature metadata returned by ISignature.getDetails(). The returned value represents the image that was used when signing the document and may be null if the signature does not contain an image.

  
   workbook.open(getSignedImageWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   byte[] signatureImage = details.getSignatureImage();
   

  Returns:

  The image bytes used to sign the document, or null if the signature does not contain an image.

• getSignatureText

  String getSignatureText()

  Gets the signature text used to sign this document.

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   String signatureText = details.getSignatureText();
   

  Returns:

  The signature text used to sign this document.

• getSignatureCertificate

  X509Certificate getSignatureCertificate()

  Gets the certificate (private key removed) that was used to sign this workbook.

  Use this method to read the public certificate stored in the signature metadata returned by ISignature.getDetails(). The returned certificate does not include the private key material.

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   X509Certificate certificate = details.getSignatureCertificate();
   

  Returns:

  The certificate used to sign this workbook, with the private key removed, or null if the signature details do not contain certificate information.

• getAddress1

  String getAddress1()

  Gets the "address1" field in the signature details dialog.

  This value is part of the signature metadata exposed by ISignature.getDetails().

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   String address1 = details.getAddress1();
   

  Returns:

  The value of the "address1" field, or null if this field is not stored in the signature details.

• getAddress2

  String getAddress2()

  Gets the "address2" field in the signature details dialog.

  Use this method to read the second address line stored in the signature metadata returned by ISignature.getDetails().

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   String address2 = details.getAddress2();
   

  Returns:

  The value of the "address2" field in the signature details dialog.

• getApplicationVersion

  String getApplicationVersion()

  Gets the "application version" field in the additional information dialog.

  Use this method to read the application version stored in the signature metadata returned by ISignature.getDetails().

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   String applicationVersion = details.getApplicationVersion();
   

  Returns:

  The value of the "application version" field in the additional information dialog.

• getCity

  String getCity()

  Gets the "city" field in the signature details dialog.

  Returns the city value stored in the signature details.

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   String city = details.getCity();
   

  Returns:

  The city field value in the signature details dialog.

• getClaimedRole

  String getClaimedRole()

  Gets the "claimed role" field in the signature details dialog.

  Use this method to read the signer role stored in the signature metadata returned by ISignature.getDetails().

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   String claimedRole = details.getClaimedRole();
   

  Returns:

  The value of the "claimed role" field, or null if this field is not stored in the signature details.

• getColorDepth

  int getColorDepth()

  Gets the "color depth" field in the additional information dialog.

  This value is part of the signature details metadata shown in the additional information dialog for a digital signature.

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   int colorDepth = details.getColorDepth();
   

  Returns:

  The "color depth" value in the additional information dialog.

• getCommitmentTypeQualifier

  String getCommitmentTypeQualifier()

  Gets the "commitment type qualifier" field in the "sign" dialog.

  This value corresponds to the commitment type qualifier stored in the signature details.

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   String commitmentTypeQualifier = details.getCommitmentTypeQualifier();
   

  Returns:

  The commitment type qualifier field value.

• getCountryName

  String getCountryName()

  Gets the "country name" field in the signature details dialog.

  Use this method to read the country name stored in the signature metadata returned by ISignature.getDetails().

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   String countryName = details.getCountryName();
   

  Returns:

  The value of the "country name" field, or null if this field is not stored in the signature details.

• getCommitmentTypeDescription

  String getCommitmentTypeDescription()

  Gets the "commitment type description" field in the "sign" dialog.

  Use this method to read the commitment type description stored in the signature metadata returned by ISignature.getDetails().

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   String commitmentTypeDescription = details.getCommitmentTypeDescription();
   

  Returns:

  The value of the "commitment type description" field in the "sign" dialog.

• getHorizontalResolution

  int getHorizontalResolution()

  Gets the "horizontal resolution" field in the additional information dialog.

  Use this method to read the horizontal display resolution stored in the signature metadata returned by ISignature.getDetails().

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   int horizontalResolution = details.getHorizontalResolution();
   

  Returns:

  The "horizontal resolution" value in the additional information dialog.

• getMonitors

  int getMonitors()

  Gets the "monitors" field in the additional information dialog.

  Use this method to read the number of monitors recorded in the signature metadata returned by ISignature.getDetails().

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   int monitors = details.getMonitors();
   

  Returns:

  The "monitors" value in the additional information dialog.

• getOfficeVersion

  String getOfficeVersion()

  Gets the "office version" field in the additional information dialog.

  Use this method to read the Office version stored in the signature metadata returned by ISignature.getDetails().

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   String officeVersion = details.getOfficeVersion();
   

  Returns:

  The value of the "office version" field in the additional information dialog.

• getPostalCode

  String getPostalCode()

  Gets the "PostalCode" field in the signature details dialog.

  Use this method to read the postal code stored in the signature metadata returned by ISignature.getDetails().

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   String postalCode = details.getPostalCode();
   

  Returns:

  The value of the "PostalCode" field, or null if this field is not stored in the signature details.

• getSignatureComments

  String getSignatureComments()

  Gets the "signature comments" field in the signature details dialog.

  Use this method to read the signature comments stored in the signature metadata returned by ISignature.getDetails().

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   String signatureComments = details.getSignatureComments();
   

  Returns:

  The value of the "signature comments" field, or null if this field is not stored in the signature details.

• getStateOrProvince

  String getStateOrProvince()

  Gets the "state or province" field in the signature details dialog.

  Use this method to read the state or province stored in the signature metadata returned by ISignature.getDetails().

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   String stateOrProvince = details.getStateOrProvince();
   

  Returns:

  The value of the "state or province" field, or null if this field is not stored in the signature details.

• getVerticalResolution

  int getVerticalResolution()

  Gets the "vertical resolution" field in the additional information dialog.

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   int verticalResolution = details.getVerticalResolution();
   

  Returns:

  The vertical resolution value in the additional information dialog.

• getWindowsVersion

  String getWindowsVersion()

  Gets the "windows version" field in the additional information dialog.

  Use this method to read the Windows version metadata stored in the signature details returned by ISignature.getDetails().

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   String windowsVersion = details.getWindowsVersion();
   

  Returns:

  The value of the "windows version" field, or null if this field is not stored in the signature details.

• getCertificateDigestMethod

  String getCertificateDigestMethod()

  Gets the hash method of the checksum of the certificate.

  Use this method to read the digest algorithm name stored with the certificate checksum in the signature details returned by ISignature.getDetails().

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   String certificateDigestMethod = details.getCertificateDigestMethod();
   

  Returns:

  The digest algorithm name used for the certificate checksum.

• getCertificateDigestValue

  byte[] getCertificateDigestValue()

  Gets the checksum of the certificate.

  Use this method to read the certificate checksum bytes stored in the signature details returned by ISignature.getDetails(). Use getCertificateDigestMethod() to determine the digest algorithm associated with this checksum.

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   byte[] certificateDigestValue = details.getCertificateDigestValue();
   

  Returns:

  The certificate checksum bytes.

• getCertificateIssuerName

  String getCertificateIssuerName()

  Gets the issuer name of the certificate.

  Returns the issuer name from the certificate associated with this signature's read-only details.

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   String issuerName = details.getCertificateIssuerName();
   

  Returns:

  The issuer name of the certificate.

• getCertificateSerialNumber

  String getCertificateSerialNumber()

  Gets the serial number (in decimal format) of the certificate.

  This method returns the serial number from the certificate associated with the signature details.

  
   workbook.open(getSignedWorkbookStream());
   ISignature signature = workbook.getSignatures().get(0);
   IReadOnlySignatureDetails details = signature.getDetails();
   String certificateSerialNumber = details.getCertificateSerialNumber();
   

  Returns:

  The certificate serial number in decimal format.