com.aspose.words

Class SignOptions

java.lang.Object

com.aspose.words.SignOptions

public class SignOptions
extends java.lang.Object

Allows to specify options for document signing.

To learn more, visit the Work with Digital Signatures documentation article.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getComments() Specifies comments on the digital signature.
java.lang.String	getDecryptionPassword() The password to decrypt source document.
java.util.UUID	getProviderId() Specifies the class ID of the signature provider.
java.util.UUID	getSignatureLineId() Signature line identifier.
byte[]	getSignatureLineImage() The image that will be shown in associated SignatureLine.
java.util.Date	getSignTime() The date of signing.
void	setComments(java.lang.String value) Specifies comments on the digital signature.
void	setDecryptionPassword(java.lang.String value) The password to decrypt source document.
void	setProviderId(java.util.UUID value) Specifies the class ID of the signature provider.
void	setSignatureLineId(java.util.UUID value) Signature line identifier.
void	setSignatureLineImage(byte[] value) The image that will be shown in associated SignatureLine.
void	setSignTime(java.util.Date value) The date of signing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getComments

public java.lang.String getComments()

Specifies comments on the digital signature. Default value is empty string.

Returns:

The corresponding String value.

setComments

public void setComments(java.lang.String value)

Specifies comments on the digital signature. Default value is empty string.

Parameters:

value - The corresponding String value.

getSignTime

public java.util.Date getSignTime()

The date of signing. Default value is current time.

Returns:

The corresponding Date value.

setSignTime

public void setSignTime(java.util.Date value)

The date of signing. Default value is current time.

Parameters:

value - The corresponding Date value.

getSignatureLineId

public java.util.UUID getSignatureLineId()

Signature line identifier. Default value is Empty (all zeroes) Guid. When set, it associates SignatureLine with corresponding DigitalSignature.

Returns:

The corresponding UUID value.

setSignatureLineId

public void setSignatureLineId(java.util.UUID value)

Signature line identifier. Default value is Empty (all zeroes) Guid. When set, it associates SignatureLine with corresponding DigitalSignature.

Parameters:

value - The corresponding UUID value.

getSignatureLineImage

public byte[] getSignatureLineImage()

The image that will be shown in associated SignatureLine. Default value is null.

Returns:

The corresponding byte[] value.

setSignatureLineImage

public void setSignatureLineImage(byte[] value)

The image that will be shown in associated SignatureLine. Default value is null.

Parameters:

value - The corresponding byte[] value.

getDecryptionPassword

public java.lang.String getDecryptionPassword()

The password to decrypt source document. Default value is empty string. If OOXML document is encrypted, you should provide decryption password to decrypt source document before it will be signed. This is not required for documents in binary DOC format.

Returns:

The corresponding String value.

setDecryptionPassword

public void setDecryptionPassword(java.lang.String value)

The password to decrypt source document. Default value is empty string. If OOXML document is encrypted, you should provide decryption password to decrypt source document before it will be signed. This is not required for documents in binary DOC format.

Parameters:

value - The corresponding String value.

getProviderId

public java.util.UUID getProviderId()

Specifies the class ID of the signature provider. Default value is Empty (all zeroes) Guid.

The cryptographic service provider (CSP) is an independent software module that actually performs cryptography algorithms for authentication, encoding, and encryption. MS Office reserves the value of {00000000-0000-0000-0000-000000000000} for its default signature provider.

The GUID of the additionally installed provider should be obtained from the documentation shipped with the provider.

In addition, all the installed cryptographic providers are enumerated in windows registry. It can be found in the following path: HKLM\SOFTWARE\Microsoft\Cryptography\Defaults\Provider. There is a key name "CP Service UUID" which corresponds to a GUID of signature provider.

Returns:

The corresponding UUID value.

setProviderId

public void setProviderId(java.util.UUID value)

Specifies the class ID of the signature provider. Default value is Empty (all zeroes) Guid.

The cryptographic service provider (CSP) is an independent software module that actually performs cryptography algorithms for authentication, encoding, and encryption. MS Office reserves the value of {00000000-0000-0000-0000-000000000000} for its default signature provider.

The GUID of the additionally installed provider should be obtained from the documentation shipped with the provider.

In addition, all the installed cryptographic providers are enumerated in windows registry. It can be found in the following path: HKLM\SOFTWARE\Microsoft\Cryptography\Defaults\Provider. There is a key name "CP Service UUID" which corresponds to a GUID of signature provider.

Parameters:

value - The corresponding UUID value.