com.spire.pdf.security
Class PdfSignature

java.lang.Object
  com.spire.pdf.security.PdfSignature

public class PdfSignature
extends java.lang.Object

Represents a digital signature used for signing a PDF document.

Constructor Summary

PdfSignature()
Initializes a new instance of the class.

PdfSignature(PdfDocumentBase document, PdfPageBase page, PdfCertificate certificate, java.lang.String signatureName)
Initializes a new instance of the class.

PdfSignature(PdfDocumentBase document, PdfPageBase page, PdfCertificate certificate, java.lang.String signatureName, PdfSignatureFieldWidget fieldWidget)
Initializes a new instance of the class.

PdfSignature(PdfDocumentBase document, PdfPageBase page, PdfCertificate certificate, java.lang.String signatureName, java.awt.geom.Rectangle2D bounds)
Initializes a new instance of the class.

PdfSignature(PdfDocument document, PdfPageBase page, PdfCertificate certificate, java.lang.String signatureName)
Initializes a new instance of the class.

PdfSignature(PdfDocument document, PdfPageBase page, PdfCertificate certificate, java.lang.String signatureName, PdfSignatureFieldWidget fieldWidget)
Initializes a new instance of the class.

PdfSignature(PdfDocument document, PdfPageBase page, PdfCertificate certificate, java.lang.String signatureName, java.awt.geom.Rectangle2D bounds)
Initializes a new instance of the class.

PdfSignature(PdfNewPage page, PdfCertificate cert, java.lang.String signatureName)
Initializes a new instance of the class.

Method Summary

void	addShowConfigureText(SignatureConfigureText config)
void	configureCustomOCSP(IOCSPResponseGenerate handler, com.spire.ms.System.Security.Cryptography.X509Certificates.X509Certificate2Collection extraCertificates) Configure OCSP which must conform to RFC 2560.
void	configureHttpOCSP(java.lang.String ocspUrl, com.spire.ms.System.Security.Cryptography.X509Certificates.X509Certificate2Collection extraCertificates) Configure OCSP which must conform to RFC 2560.
void	configureTimestamp(IGenerateTimestamp handler) Configure timestamp which must conform to RFC 3161.
void	configureTimestamp(java.lang.String tsaUrl) Configure timestamp which must conform to RFC 3161.
void	configureTimestamp(java.lang.String tsaUrl, java.lang.String tsaUserName, java.lang.String tsaPassword) Configure timestamp which must conform to RFC 3161.
java.awt.geom.Rectangle2D	getBounds() Gets or sets bounds of signature.
PdfCertificate	getCertificate() Gets signing certificate.
com.spire.ms.System.Security.Cryptography.X509Certificates.X509Certificate2Collection	getCertificates() Get all certificates.
ConfiguerGraphicType	getConfigGraphicType() Digital Signature Graphic Type
java.lang.String	getContactInfo() Gets or sets information provided by the signer to enable a recipient to contact the signer to verify the signature; for example, a phone number.
java.lang.String	getContactInfoLabel() Digital Signature ContactInfo Label
boolean	getCustomSignPosition()
java.util.Date	getDate() Get Signature Datetime
java.lang.String	getDigitalSigner() Deprecated.
java.lang.String	getDigitalSignerLable() Deprecated.
java.awt.geom.Point2D	getLocation() Gets or sets signature location on the page.
java.lang.String	getLocationInfo() Gets the physical location of the signing.
java.lang.String	getLocationInfoLabel() Digital Signature LocationInfo Label
java.lang.String	getName() Digital Signature Common name
java.lang.String	getNameLabel() Digital Signature Common name label
java.lang.String	getReason() Gets or sets reason of signing.
java.lang.String	getReasonLabel() Digital Signature Reason Label
java.util.EnumSet<SignatureConfigureText>	getShowConfigureText() Show Digital Signature,Configuer Text
java.lang.String	getSignatureName() get/set pdf signature name
java.util.HashMap	getSignInfoFont() get signature info font
SignTextAlignment	getSignTextAlignment() Sets the alignment of signature text
boolean	getVisible() Gets a value indicating whether signature visible or not.
boolean	isTag() Digital Signature Whether to display the label
void	isTag(boolean value) Digital Signature Whether to display the label
void	removeShowConfigureText(SignatureConfigureText config)
void	setBounds(java.awt.geom.Rectangle2D value) Gets or sets bounds of signature.
void	setCertificated(boolean value) Sets a value indicating certificate document or not.
void	setConfigGraphicType(ConfiguerGraphicType value) Deprecated.
void	setContactInfo(java.lang.String value) Sets information provided by the signer to enable a recipient to contact
void	setContactInfoLabel(java.lang.String value) Digital Signature ContactInfo Label
void	setCustomSignDetailPosition(float infoX, float infoY, float infoWidth, float infoHeight) Define sign anem ,unit is percent,for example,whole area0,0,1,1...
void	setCustomSignImagePosition(float imageX, float imageY, float imageWidth, float imageHeight) Define sign image area,unit is percent,for example,whole area0,0,1,1...
void	setCustomSignNamePosition(float nameX, float nameY, float nameWidth, float nameHeight) Define sign anem ,unit is percent,for example,whole area0,0,1,1...
void	setCustomSignPosition(boolean customSignPosition)
void	setDate(java.util.Date value) Set Signature Date
void	setDateLabel(java.lang.String value) Digital Signature Date Label
void	setDigitalSigner(java.lang.String value) Deprecated.
void	setDigitalSignerLable(java.lang.String value) Deprecated.
void	setDistinguishedName(java.lang.String value) Sets DistinguishedName values
void	setDistinguishedNameLabel(java.lang.String value) Set Digital Signature Distinguished Label
void	setDocumentPermissions(PdfCertificationFlags value) Sets the permission for certificated document.
void	setGraphicMode(GraphicMode value) Digital Signature Graphic Type
void	setLocation(java.awt.geom.Point2D value) sets signature location on the page.
void	setLocationInfo(java.lang.String value) Sets the physical location of the signing.
void	setLocationInfoLabel(java.lang.String value) Set digital Signature LocationInfo Label
void	setLock(boolean lock) A signature field lock dictionary that specifies a set of form fields to be locked when this signature field is signed.
void	setName(java.lang.String value) Set digital Signature Common name
void	setNameLabel(java.lang.String value) Set digital Signature Common name label
void	setReason(java.lang.String value) Sets reason of signing
void	setReasonLabel(java.lang.String value) Digital Signature Reason Label
void	setShowConfigureText(java.util.EnumSet<SignatureConfigureText> value)
void	setSignatureName(java.lang.String value)
void	setSignDetailsFont(PdfFontBase value) Set the SignDetails font.
void	setSignFontColor(com.spire.ms.System.Drawing.Color value) Set font color for the signature info if not set, the default is black
void	setSignImageLayout(SignImageLayout value) set the sign image layout.
void	setSignImageSource(PdfImage value) Digital Signature Configuer Graphic file Path
void	setSignInfoFont(java.util.HashMap value)
void	setSignNameFont(PdfFontBase value) Set the sign name font.
void	setSignTextAlignment(SignTextAlignment value) Sets the alignment of signature text
boolean	verifyDocModified() Check if the document was altered after signed.
boolean	verifySignature() check thie validity of the signature

Constructor Detail

PdfSignature

public PdfSignature()

Initializes a new instance of the class.

PdfSignature

public PdfSignature(PdfNewPage page,
                    PdfCertificate cert,
                    java.lang.String signatureName)

Initializes a new instance of the class.

Parameters:

page - The current pdf page where signature will be replaced.

cert - The pdf certificate.

signatureName - Name of the signature.

Throws:

com.spire.ms.System.Exception

PdfSignature

public PdfSignature(PdfDocumentBase document,
                    PdfPageBase page,
                    PdfCertificate certificate,
                    java.lang.String signatureName)

Initializes a new instance of the class.

Parameters:

document - The document, which has the page.

page - The current pdf page where signature will be replaced.

certificate - The pdf certificate.

signatureName - Name of the signature.

Throws:

com.spire.ms.System.Exception

PdfSignature

public PdfSignature(PdfDocumentBase document,
                    PdfPageBase page,
                    PdfCertificate certificate,
                    java.lang.String signatureName,
                    java.awt.geom.Rectangle2D bounds)

Initializes a new instance of the class.

Parameters:

document - The document, which has the page.

page - The page.

certificate - The certificate.

signatureName - The name of the signature.

bounds - The bounds

PdfSignature

public PdfSignature(PdfDocumentBase document,
                    PdfPageBase page,
                    PdfCertificate certificate,
                    java.lang.String signatureName,
                    PdfSignatureFieldWidget fieldWidget)

Initializes a new instance of the class.

Parameters:

document - The loaded document, which has the page.

page - The page.

certificate - The certificate.

signatureName - The name of the signature.

fieldWidget - The name of the loaded signature field.

Throws:

com.spire.ms.System.Exception

PdfSignature

public PdfSignature(PdfDocument document,
                    PdfPageBase page,
                    PdfCertificate certificate,
                    java.lang.String signatureName,
                    java.awt.geom.Rectangle2D bounds)

Initializes a new instance of the class.

Parameters:

document - The document or loaded document, which has the page.

page - The page.

certificate - The certificate.

signatureName - The name of the signature.

bounds - The bounds

Throws:

com.spire.ms.System.Exception

PdfSignature

public PdfSignature(PdfDocument document,
                    PdfPageBase page,
                    PdfCertificate certificate,
                    java.lang.String signatureName)

Initializes a new instance of the class.

Parameters:

document - The document or loaded document, which has the page.

page - The page.

certificate - The certificate.

signatureName - The name of the signature.

Throws:

com.spire.ms.System.Exception

PdfSignature

public PdfSignature(PdfDocument document,
                    PdfPageBase page,
                    PdfCertificate certificate,
                    java.lang.String signatureName,
                    PdfSignatureFieldWidget fieldWidget)

Initializes a new instance of the class.

Parameters:

document - The document or loaded document, which has the page.

page - The page.

certificate - The certificate.

signatureName - The name of the signature.

fieldWidget - The name of the loaded signature field.

Throws:

com.spire.ms.System.Exception

Method Detail

getCertificates

public com.spire.ms.System.Security.Cryptography.X509Certificates.X509Certificate2Collection getCertificates()

Get all certificates.

getLocation

public java.awt.geom.Point2D getLocation()

Gets or sets signature location on the page.

Returns:

setLocation

public void setLocation(java.awt.geom.Point2D value)

sets signature location on the page.

Parameters:

value -

getBounds

public java.awt.geom.Rectangle2D getBounds()

Gets or sets bounds of signature.

Returns:

setBounds

public void setBounds(java.awt.geom.Rectangle2D value)

Gets or sets bounds of signature.

getContactInfo

public java.lang.String getContactInfo()

Gets or sets information provided by the signer to enable a recipient to contact the signer to verify the signature; for example, a phone number.

Returns:

setContactInfo

public void setContactInfo(java.lang.String value)

Sets information provided by the signer to enable a recipient to contact

Parameters:

value - the signer to verify the signature; for example, a phone number

getReason

public java.lang.String getReason()

Gets or sets reason of signing.

Returns:

setReason

public void setReason(java.lang.String value)

Sets reason of signing

getLocationInfo

public java.lang.String getLocationInfo()

Gets the physical location of the signing.

Returns:

setLocationInfo

public void setLocationInfo(java.lang.String value)

Sets the physical location of the signing.

Parameters:

value - LocationInfo

setCertificated

public void setCertificated(boolean value)

Sets a value indicating certificate document or not.

Parameters:

value - certificate document if true.

setDocumentPermissions

public void setDocumentPermissions(PdfCertificationFlags value)

Sets the permission for certificated document.

Parameters:

value - The pdfCertificationFlags

getCertificate

public PdfCertificate getCertificate()

Gets signing certificate.

Throws:

com.spire.ms.System.Exception

getSignTextAlignment

public SignTextAlignment getSignTextAlignment()

Sets the alignment of signature text

Returns:

setSignTextAlignment

public void setSignTextAlignment(SignTextAlignment value)

Sets the alignment of signature text

getVisible

public boolean getVisible()

Gets a value indicating whether signature visible or not. Signature can be set as invisible when its size is set to empty.

Returns:

getDate

public java.util.Date getDate()

Get Signature Datetime

setDate

public void setDate(java.util.Date value)

Set Signature Date

getSignatureName

public java.lang.String getSignatureName()

get/set pdf signature name

setSignatureName

public void setSignatureName(java.lang.String value)

setSignNameFont

public void setSignNameFont(PdfFontBase value)

Set the sign name font. Note: This font applys to sign name when the GraphicMode is SignNameOnly or SignNameAndSignDetail. if not set, the default font will be applied.

Parameters:

value -

setSignFontColor

public void setSignFontColor(com.spire.ms.System.Drawing.Color value)

Set font color for the signature info if not set, the default is black

Parameters:

value -

setSignDetailsFont

public void setSignDetailsFont(PdfFontBase value)

Set the SignDetails font. Note: if not set, the default font will be applied.

Parameters:

value -

getSignInfoFont

public java.util.HashMap getSignInfoFont()

get signature info font

setSignInfoFont

public void setSignInfoFont(java.util.HashMap value)

getDigitalSigner

@Deprecated
public java.lang.String getDigitalSigner()

Deprecated.

The name of the person or authority signing the document, usually called signer.

Returns:

setDigitalSigner

@Deprecated
public void setDigitalSigner(java.lang.String value)

Deprecated.

The name of the person or authority signing the document, usually called signer.

getDigitalSignerLable

@Deprecated
public java.lang.String getDigitalSignerLable()

Deprecated.

Digital Signature Common name label

Returns:

setDigitalSignerLable

@Deprecated
public void setDigitalSignerLable(java.lang.String value)

Deprecated.

Digital Signature Common name label

getName

public java.lang.String getName()

Digital Signature Common name

setName

public void setName(java.lang.String value)

Set digital Signature Common name

getNameLabel

public java.lang.String getNameLabel()

Digital Signature Common name label

setNameLabel

public void setNameLabel(java.lang.String value)

Set digital Signature Common name label

setDistinguishedNameLabel

public void setDistinguishedNameLabel(java.lang.String value)

Set Digital Signature Distinguished Label

setDistinguishedName

public void setDistinguishedName(java.lang.String value)

Sets DistinguishedName values

Parameters:

value -

isTag

public boolean isTag()

Digital Signature Whether to display the label

isTag

public void isTag(boolean value)

Digital Signature Whether to display the label

getShowConfigureText

public java.util.EnumSet<SignatureConfigureText> getShowConfigureText()

Show Digital Signature,Configuer Text

setShowConfigureText

public void setShowConfigureText(java.util.EnumSet<SignatureConfigureText> value)

addShowConfigureText

public void addShowConfigureText(SignatureConfigureText config)

removeShowConfigureText

public void removeShowConfigureText(SignatureConfigureText config)

setGraphicMode

public void setGraphicMode(GraphicMode value)

Digital Signature Graphic Type

setCustomSignPosition

public void setCustomSignPosition(boolean customSignPosition)

getCustomSignPosition

public boolean getCustomSignPosition()

setCustomSignImagePosition

public void setCustomSignImagePosition(float imageX,
                                       float imageY,
                                       float imageWidth,
                                       float imageHeight)

Define sign image area,unit is percent,for example,whole area0,0,1,1...

setCustomSignNamePosition

public void setCustomSignNamePosition(float nameX,
                                      float nameY,
                                      float nameWidth,
                                      float nameHeight)

Define sign anem ,unit is percent,for example,whole area0,0,1,1...

setCustomSignDetailPosition

public void setCustomSignDetailPosition(float infoX,
                                        float infoY,
                                        float infoWidth,
                                        float infoHeight)

Define sign anem ,unit is percent,for example,whole area0,0,1,1...

getConfigGraphicType

public ConfiguerGraphicType getConfigGraphicType()

Digital Signature Graphic Type

Returns:

setConfigGraphicType

@Deprecated
public void setConfigGraphicType(ConfiguerGraphicType value)

Deprecated.

Digital Signature Graphic Type

setSignImageSource

public void setSignImageSource(PdfImage value)

Digital Signature Configuer Graphic file Path

setSignImageLayout

public void setSignImageLayout(SignImageLayout value)

set the sign image layout.

getReasonLabel

public java.lang.String getReasonLabel()

Digital Signature Reason Label

setReasonLabel

public void setReasonLabel(java.lang.String value)

Digital Signature Reason Label

setDateLabel

public void setDateLabel(java.lang.String value)

Digital Signature Date Label

getContactInfoLabel

public java.lang.String getContactInfoLabel()

Digital Signature ContactInfo Label

setContactInfoLabel

public void setContactInfoLabel(java.lang.String value)

Digital Signature ContactInfo Label

getLocationInfoLabel

public java.lang.String getLocationInfoLabel()

Digital Signature LocationInfo Label

setLocationInfoLabel

public void setLocationInfoLabel(java.lang.String value)

Set digital Signature LocationInfo Label

setLock

public void setLock(boolean lock)

A signature field lock dictionary that specifies a set of form fields to be locked when this signature field is signed. Table 8.82 lists the entries in this dictionary.

verifySignature

public boolean verifySignature()

check thie validity of the signature

verifyDocModified

public boolean verifyDocModified()

Check if the document was altered after signed. True if modified; otherwise false.

Returns:

Doc Modified

configureTimestamp

public void configureTimestamp(java.lang.String tsaUrl)

Configure timestamp which must conform to RFC 3161.

Parameters:

tsaUrl - TSA url

Throws:

com.spire.ms.System.Exception

configureTimestamp

public void configureTimestamp(java.lang.String tsaUrl,
                               java.lang.String tsaUserName,
                               java.lang.String tsaPassword)

Configure timestamp which must conform to RFC 3161.

Parameters:

tsaUrl - TSA url

tsaUserName - TSA username

tsaPassword - TSA password

Throws:

com.spire.ms.System.Exception

configureTimestamp

public void configureTimestamp(IGenerateTimestamp handler)

Configure timestamp which must conform to RFC 3161.

Parameters:

handler -

configureHttpOCSP

public void configureHttpOCSP(java.lang.String ocspUrl,
                              com.spire.ms.System.Security.Cryptography.X509Certificates.X509Certificate2Collection extraCertificates)

Configure OCSP which must conform to RFC 2560.

Parameters:

ocspUrl - OCSP url. It it's null it will be taken from the checked cert.

extraCertificates - Represents an additional collection of certificates that can be searched. if null,only use windows cert store.

Throws:

com.spire.ms.System.Exception

configureCustomOCSP

public void configureCustomOCSP(IOCSPResponseGenerate handler,
                                com.spire.ms.System.Security.Cryptography.X509Certificates.X509Certificate2Collection extraCertificates)

Configure OCSP which must conform to RFC 2560.

Parameters:

handler - the handler which generate OCSP response.

extraCertificates - Represents an additional collection of certificates that can be searched if null,only use windows cert store.