com.groupdocs.signature.domain.signatures

Class DigitalSignature

java.lang.Object

com.groupdocs.signature.domain.signatures.BaseSignature

com.groupdocs.signature.domain.signatures.DigitalSignature

Direct Known Subclasses:

PdfDigitalSignature

public class DigitalSignature
extends BaseSignature

Contains Digital signature properties.

Constructor Summary

Constructors

Constructor and Description
DigitalSignature() Initialize Digital signature with default parameters.
DigitalSignature(KeyStore certificate) Create Digital signature with specified certificate.
DigitalSignature(String signatureId) Initialize Digital signature with known SignatureId.
DigitalSignature(X509Certificate cert, PrivateKey key) Create Digital signature based on X509Certificate certificate and PrivateKey.

Method Summary

Modifier and Type	Method and Description
Object	deepClone() Clone Barcode Signature instance.
boolean	equals(Object signature) Overwrites Equals method to compare signature properties
KeyStore	getCertificate() Gets or sets the KeyStore certificate.
String	getCertificateName() Gets or sets the X509 certificate name.
String	getComments() Gets or sets the signing purpose comment.
PrivateKey	getPrivateKey() Gets or sets the PrivateKey of certificate.
Date	getSignTime() Gets or sets the time the document was signed.
String	getThumbprint() Gets the thumbprint of a certificate.
X509Certificate	getX509Certificate() Gets or sets the X509 certificate.
int	getXAdESType() XAdES type XAdESType.
int	hashCode() Overrides GetHashCode method
boolean	isValid() Keeps true if this digital signature is valid and the document has not been tampered with.
static List<DigitalSignature>	loadDigitalSignatures() Load Digital signature from all system X509 Certificates Stores.
static List<DigitalSignature>	loadDigitalSignatures(com.groupdocs.signature.domain.signatures.StoreName storeName) Load Digital signature from passed X509 Certificates Store.
void	setCertificate(KeyStore value) Gets or sets the KeyStore certificate.
void	setCertificateName(String value) Gets or sets the X509 certificate name.
void	setComments(String value) Gets or sets the signing purpose comment.
void	setPrivateKey(PrivateKey value) Gets or sets the PrivateKey of certificate.
void	setSignTime(Date value) Gets or sets the time the document was signed.
void	setValid(boolean value) Keeps true if this digital signature is valid and the document has not been tampered with.
void	setX509Certificate(X509Certificate value) Gets or sets the X509 certificate.
void	setXAdESType(int value) XAdES type XAdESType.

Methods inherited from class com.groupdocs.signature.domain.signatures.BaseSignature

getCreatedOn, getDeleted, getHeight, getLeft, getModifiedOn, getPageNumber, getSignatureId, getSignatureType, getTop, getWidth, isSignature, setCreatedOn, setHeight, setLeft, setModifiedOn, setPageNumber, setSignature, setTop, setWidth, supportMetaInfoLayer, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DigitalSignature

public DigitalSignature()

Initialize Digital signature with default parameters.

DigitalSignature

public DigitalSignature(KeyStore certificate)

Create Digital signature with specified certificate.

Parameters:

certificate - X509 certificate.

DigitalSignature

public DigitalSignature(String signatureId)

Initialize Digital signature with known SignatureId.

DigitalSignature

public DigitalSignature(X509Certificate cert,
                        PrivateKey key)
                 throws Exception

Create Digital signature based on X509Certificate certificate and PrivateKey.

Parameters:

cert - X509Certificate certificate.

key - PrivateKey of certificate.

Throws:

Exception

Method Detail

deepClone

public Object deepClone()

Clone Barcode Signature instance.

Overrides:

deepClone in class BaseSignature

Returns:

Returns cloned Barcode Signature instance.

equals

public boolean equals(Object signature)

Overwrites Equals method to compare signature properties

Overrides:

equals in class BaseSignature

Parameters:

signature - Signature object to compare with.

Returns:

Returns true if passed signature object has same type and all its properties are equal to this instance properties.

getCertificate

public final KeyStore getCertificate()

Gets or sets the KeyStore certificate.

getCertificateName

public final String getCertificateName()

Gets or sets the X509 certificate name.

getComments

public final String getComments()

Gets or sets the signing purpose comment.

getPrivateKey

public final PrivateKey getPrivateKey()

Gets or sets the PrivateKey of certificate.

getSignTime

public final Date getSignTime()

Gets or sets the time the document was signed.

getThumbprint

public final String getThumbprint()

Gets the thumbprint of a certificate.

getX509Certificate

public final X509Certificate getX509Certificate()

Gets or sets the X509 certificate.

getXAdESType

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.

hashCode

public int hashCode()

Overrides GetHashCode method

Overrides:

hashCode in class BaseSignature

Returns:

Signature hash code

isValid

public final boolean isValid()

Keeps true if this digital signature is valid and the document has not been tampered with.

loadDigitalSignatures

public static List<DigitalSignature> loadDigitalSignatures()
                                                    throws Exception

Load Digital signature from all system X509 Certificates Stores.

Returns:

Returns list of DigitalSignature Digital Signatures.

Throws:

Exception

loadDigitalSignatures

public static List<DigitalSignature> loadDigitalSignatures(com.groupdocs.signature.domain.signatures.StoreName storeName)
                                                    throws Exception

Load Digital signature from passed X509 Certificates Store.

Returns:

Returns list of DigitalSignature Digital Signatures.

Throws:

Exception

setCertificate

public final void setCertificate(KeyStore value)

Gets or sets the KeyStore certificate.

setCertificateName

public final void setCertificateName(String value)

Gets or sets the X509 certificate name.

setComments

public final void setComments(String value)

Gets or sets the signing purpose comment.

setPrivateKey

public final void setPrivateKey(PrivateKey value)

Gets or sets the PrivateKey of certificate.

setSignTime

public final void setSignTime(Date value)

Gets or sets the time the document was signed.

setValid

public final void setValid(boolean value)

Keeps true if this digital signature is valid and the document has not been tampered with.

setX509Certificate

public final void setX509Certificate(X509Certificate value)

Gets or sets the X509 certificate.

setXAdESType

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.