DigitalSignOptions Leave feedback
On this page
Inheritance: java.lang.Object, com.groupdocs.signature.options.sign.SignOptions, com.groupdocs.signature.options.sign.ImageSignOptions
public class DigitalSignOptions extends ImageSignOptions
Represents the Digital signature options.
| Constructor | Description |
|---|---|
| DigitalSignOptions() | Initializes a new instance of the DigitalSignOptions class with default values. |
| DigitalSignOptions(String certificateFilePath) | Initializes a new instance of the DigitalSignOptions class with certificate file. |
| DigitalSignOptions(InputStream certificateStream) | Initializes a new instance of the DigitalSignOptions class with certificate stream. |
| DigitalSignOptions(String certificateFilePath, String imageFilePath) | Initializes a new instance of the DigitalSignOptions class with certificate file and image file. |
| DigitalSignOptions(String certificateFilePath, InputStream appearenceImageStream) | Initializes a new instance of the DigitalSignOptions class with certificate file and image stream. |
| DigitalSignOptions(InputStream certificateStream, String imageFilePath) | Initializes a new instance of the DigitalSignOptions class with certificate stream and image file. |
| DigitalSignOptions(InputStream certificateStream, InputStream appearenceImageStream) | Initializes a new instance of the DigitalSignOptions class with certificate stream and image stream. |
| Method | Description |
|---|---|
| getReason() | Gets or sets the reason of signature. |
| setReason(String value) | Gets or sets the reason of signature. |
| getContact() | Gets or sets the signature contact. |
| setContact(String value) | Gets or sets the signature contact. |
| getLocation() | Gets or sets the signature location. |
| setLocation(String value) | Gets or sets the signature location. |
| getPassword() | Gets or sets the password of digital certificate. |
| setPassword(String value) | Gets or sets the password of digital certificate. |
| getSignature() | Gets or sets properties of document digital signature. |
| setSignature(DigitalSignature value) | Gets or sets properties of document digital signature. |
| getCertificateFilePath() | Gets or sets the digital certificate file path. |
| setCertificateFilePath(String value) | Gets or sets the digital certificate file GUID. |
| getCertificateStream() | Gets or sets digital certificate stream. |
| setCertificateStream(InputStream value) | Gets or sets digital certificate stream. |
| getVisible() | Gets or sets the visibility of signature. |
| setVisible(boolean value) | Gets or sets the visibility of signature. |
| getUseLtv() | Gets/sets LTV (Long Term Validation) validation flag. |
| setUseLtv(boolean value) | Gets/sets LTV (Long Term Validation) validation flag. |
| getAllowExpired() | Gets or sets a flag that allows signing with a certificate whose validity period has ended. |
| setAllowExpired(boolean value) | Gets or sets a flag that allows signing with a certificate whose validity period has ended. |
| getAllowNotYetValid() | Gets or sets a flag that allows signing with a certificate whose validity period has not started yet. |
| setAllowNotYetValid(boolean value) | Gets or sets a flag that allows signing with a certificate whose validity period has not started yet. |
| getCustomSignHash() | Gets or sets a custom hash-signing implementation, allowing callers to plug in their own |
| digital signing logic (HSM, remote signer, software keystore, etc.). | |
| setCustomSignHash(ICustomSignHash value) | Sets a custom hash-signing implementation, allowing callers to plug in their own |
| digital signing logic. | |
| getXAdESType() | XAdES type |
| XAdESType | |
| . | |
| setXAdESType(int value) | XAdES type |
| XAdESType | |
| . | |
| getSignatureLineId() | |
| setSignatureLineId(UUID value) | |
| toString() | Override string conversion. |
public DigitalSignOptions()
Initializes a new instance of the DigitalSignOptions class with default values.
public DigitalSignOptions(String certificateFilePath)
Initializes a new instance of the DigitalSignOptions class with certificate file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| certificateFilePath | java.lang.String | Digital certificate file path |
public DigitalSignOptions(InputStream certificateStream)
Initializes a new instance of the DigitalSignOptions class with certificate stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| certificateStream | java.io.InputStream | Digital Certificate stream |
public DigitalSignOptions(String certificateFilePath, String imageFilePath)
Initializes a new instance of the DigitalSignOptions class with certificate file and image file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| certificateFilePath | java.lang.String | Digital certificate file path |
| imageFilePath | java.lang.String | Signature Appearance image file path |
public DigitalSignOptions(String certificateFilePath, InputStream appearenceImageStream)
Initializes a new instance of the DigitalSignOptions class with certificate file and image stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| certificateFilePath | java.lang.String | Digital certificate file path |
| appearenceImageStream | java.io.InputStream | Signature Appearance image stream |
public DigitalSignOptions(InputStream certificateStream, String imageFilePath)
Initializes a new instance of the DigitalSignOptions class with certificate stream and image file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| certificateStream | java.io.InputStream | Digital Certificate stream |
| imageFilePath | java.lang.String | Signature Appearance image file path |
public DigitalSignOptions(InputStream certificateStream, InputStream appearenceImageStream)
Initializes a new instance of the DigitalSignOptions class with certificate stream and image stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| certificateStream | java.io.InputStream | Digital Certificate stream |
| appearenceImageStream | java.io.InputStream | Signature Appearance image stream |
public final String getReason()
Gets or sets the reason of signature.
Returns: java.lang.String
public final void setReason(String value)
Gets or sets the reason of signature.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
public final String getContact()
Gets or sets the signature contact.
Returns: java.lang.String
public final void setContact(String value)
Gets or sets the signature contact.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
public final String getLocation()
Gets or sets the signature location.
Returns: java.lang.String
public final void setLocation(String value)
Gets or sets the signature location.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
public final String getPassword()
Gets or sets the password of digital certificate.
Returns: java.lang.String
public final void setPassword(String value)
Gets or sets the password of digital certificate.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
public final DigitalSignature getSignature()
Gets or sets properties of document digital signature.
Returns: DigitalSignature
public final void setSignature(DigitalSignature value)
Gets or sets properties of document digital signature.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DigitalSignature |
public final String getCertificateFilePath()
Gets or sets the digital certificate file path. This property is used only if CertificateStream is not specified.
Returns: java.lang.String
public void setCertificateFilePath(String value)
Gets or sets the digital certificate file GUID. This property is used only if CertificateStream is not specified.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
public final InputStream getCertificateStream()
Gets or sets digital certificate stream. If this property is specified it is always used instead CertificateGuid.
Returns: java.io.InputStream
public final void setCertificateStream(InputStream value)
Gets or sets digital certificate stream. If this property is specified it is always used instead CertificateGuid.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.io.InputStream |
public final boolean getVisible()
Gets or sets the visibility of signature.
Returns: boolean
public final void setVisible(boolean value)
Gets or sets the visibility of signature.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final boolean getUseLtv()
Gets/sets LTV (Long Term Validation) validation flag.
Returns: boolean
public final void setUseLtv(boolean value)
Gets/sets LTV (Long Term Validation) validation flag.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final boolean getAllowExpired()
Gets or sets a flag that allows signing with a certificate whose validity period has ended. The default value is false: signing with an expired certificate throws GroupDocsSignatureException , and the document is not signed.
Validators report a signature made with an expired certificate as not valid. Set this property to true only when you need such a signature anyway, for example to test with an old certificate. The document is then signed, and a warning is written to the logger set in SignatureSettings .
The certificate is compared with the current time in UTC, not with DigitalSignature.SignTime . The flag applies to the certificate given by CertificateFilePath , CertificateStream or Signature , and, when a spreadsheet is signed, to the certificate of the first DigitalVBA extension. Digital signatures of images do not use a certificate and are not checked. A certificate whose validity period has not started yet is controlled by AllowNotYetValid .
Returns: boolean
public final void setAllowExpired(boolean value)
Gets or sets a flag that allows signing with a certificate whose validity period has ended. The default value is false. See #getAllowExpired().getAllowExpired().
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final boolean getAllowNotYetValid()
Gets or sets a flag that allows signing with a certificate whose validity period has not started yet. The default value is false: signing with such a certificate throws GroupDocsSignatureException , and the document is not signed.
Validators report a signature made before the certificate becomes valid as not valid. Such a certificate was usually issued for a later date, or the computer’s clock is wrong. When this property is true, the document is signed, and a warning is written to the logger set in SignatureSettings .
The certificate is compared with the current time in UTC. The flag applies to the same certificates as
AllowExpired , which controls certificates whose validity period has ended.
Returns: boolean
public final void setAllowNotYetValid(boolean value)
Gets or sets a flag that allows signing with a certificate whose validity period has not started yet. The default value is false. See #getAllowNotYetValid().getAllowNotYetValid().
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final ICustomSignHash getCustomSignHash()
Gets or sets a custom hash-signing implementation, allowing callers to plug in their own digital signing logic (HSM, remote signer, software keystore, etc.).
Returns: ICustomSignHash
public final void setCustomSignHash(ICustomSignHash value)
Sets a custom hash-signing implementation, allowing callers to plug in their own digital signing logic.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ICustomSignHash |
public final int getXAdESType()
XAdES type XAdESType . Default value is None (XAdES is off). At this moment XAdES signature type is supported only for Spreadsheet documents under .NET Framework only (not under .NET Standard)
Returns: int
public final void setXAdESType(int value)
XAdES type XAdESType . Default value is None (XAdES is off). At this moment XAdES signature type is supported only for Spreadsheet documents under .NET Framework only (not under .NET Standard)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public final UUID getSignatureLineId()
Returns: java.util.UUID
public final void setSignatureLineId(UUID value)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.util.UUID |
public String toString()
Override string conversion.
Returns: java.lang.String -
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
