Groupdocs API References – com.groupdocs.signature.options.verify

Nodejs-Java: BarcodeVerifyOptions

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, com.groupdocs.signature.options.verify.VerifyOptions, com.groupdocs.signature.options.verify.TextVerifyOptions

public class BarcodeVerifyOptions extends TextVerifyOptions

Represents the Barcode verify options.

Learn more Learn more

Basic usage of verification for Barcode electronic signature by GroupDocs.Signature: How to eVerification Barcode signatures in a document
Advanced usage of settings of verification for Barcode electronic signature with GroupDocs.Signature: Advanced usage of eVerification Barcode signatures in a document and additional settings

Constructors

Constructor	Description
BarcodeVerifyOptions()	Creates default Verification Option for Barcode Signature.
BarcodeVerifyOptions(String text)	Creates default Verification Option with verification text
BarcodeVerifyOptions(BarcodeType encodeType)	Creates default Verification Option with Barcode Type verification
BarcodeVerifyOptions(String text, BarcodeType encodeType)	Creates default Verification Option with Barcode Type verification and text

Methods

Method	Description
getEncodeType()	Gets or sets Barcode Type verification.
setEncodeType(BarcodeType value)	Gets or sets Barcode Type verification.
toString()	Overrides conversion to string.

BarcodeVerifyOptions()

public BarcodeVerifyOptions()

Creates default Verification Option for Barcode Signature.

BarcodeVerifyOptions(String text)

public BarcodeVerifyOptions(String text)

Creates default Verification Option with verification text

Parameters:

Parameter	Type	Description
text	java.lang.String	Barcode text to verify

BarcodeVerifyOptions(BarcodeType encodeType)

public BarcodeVerifyOptions(BarcodeType encodeType)

Creates default Verification Option with Barcode Type verification

Parameters:

Parameter	Type	Description
encodeType	BarcodeType	Barcode Type verification

BarcodeVerifyOptions(String text, BarcodeType encodeType)

public BarcodeVerifyOptions(String text, BarcodeType encodeType)

Creates default Verification Option with Barcode Type verification and text

Parameters:

Parameter	Type	Description
text	java.lang.String	Barcode text to verify
encodeType	BarcodeType	Barcode Type verification

getEncodeType()

public final BarcodeType getEncodeType()

Gets or sets Barcode Type verification.

Returns: BarcodeType

setEncodeType(BarcodeType value)

public final void setEncodeType(BarcodeType value)

Gets or sets Barcode Type verification.

Parameters:

Parameter	Type	Description
value	BarcodeType

toString()

public String toString()

Overrides conversion to string.

Returns: java.lang.String -

Nodejs-Java: CertificateVerifyOptions

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, com.groupdocs.signature.options.verify.VerifyOptions

public class CertificateVerifyOptions extends VerifyOptions

Keeps options to verify certificate documents.

Learn more

Constructor	Description
CertificateVerifyOptions()	Initializes a new instance of the TextVerifyOptions with default values.
CertificateVerifyOptions(String subject)	Initializes a new instance of the CertificateVerifyOptions with subject to verify.

Methods

Method	Description
getIssuer()	Specify Certificate Issuer if it should be verified.
setIssuer(String value)	Specify Certificate Issuer if it should be verified.
getSerialNumber()	Specify Certificate Serial Number if it should be verified.
setSerialNumber(String value)	Specify Certificate Serial Number if it should be verified.
getSubject()	Specify Certificate subject if it should be verified.
setSubject(String value)	Specify Certificate subject if it should be verified.
getThumbprint()	Specify Certificate Thumbprint if it should be verified.
setThumbprint(String value)	Specify Certificate Thumbprint if it should be verified.
getMatchType()	Gets or sets Text Match Type verification.
setMatchType(int value)	Gets or sets Text Match Type verification.
getExpired()	Indicates if certificate is expired date due validation result.
setExpired(boolean value)	Indicates if certificate is expired date due validation result.
getPerformChainValidation()	Get or set if verification process should provide X.509 chain validation using basic validation policy.
setPerformChainValidation(boolean value)	Get or set if verification process should provide X.509 chain validation using basic validation policy.
toString()	Overrides conversion to string.

CertificateVerifyOptions()

public CertificateVerifyOptions()

Initializes a new instance of the TextVerifyOptions with default values.

CertificateVerifyOptions(String subject)

public CertificateVerifyOptions(String subject)

Initializes a new instance of the CertificateVerifyOptions with subject to verify.

Parameters:

Parameter	Type	Description
subject	java.lang.String	Subject to be verified

getIssuer()

public final String getIssuer()

Specify Certificate Issuer if it should be verified.

Returns: java.lang.String

setIssuer(String value)

public final void setIssuer(String value)

Specify Certificate Issuer if it should be verified.

Parameters:

Parameter	Type	Description
value	java.lang.String

getSerialNumber()

public final String getSerialNumber()

Specify Certificate Serial Number if it should be verified.

Returns: java.lang.String

setSerialNumber(String value)

public final void setSerialNumber(String value)

Specify Certificate Serial Number if it should be verified.

Parameters:

Parameter	Type	Description
value	java.lang.String

getSubject()

public final String getSubject()

Specify Certificate subject if it should be verified.

Returns: java.lang.String

setSubject(String value)

public final void setSubject(String value)

Specify Certificate subject if it should be verified.

Parameters:

Parameter	Type	Description
value	java.lang.String

getThumbprint()

public final String getThumbprint()

Specify Certificate Thumbprint if it should be verified.

Returns: java.lang.String

setThumbprint(String value)

public final void setThumbprint(String value)

Specify Certificate Thumbprint if it should be verified.

Parameters:

Parameter	Type	Description
value	java.lang.String

getMatchType()

public final int getMatchType()

Gets or sets Text Match Type verification.

Returns: int

setMatchType(int value)

public final void setMatchType(int value)

Gets or sets Text Match Type verification.

Parameters:

Parameter	Type	Description
value	int

getExpired()

public final boolean getExpired()

Indicates if certificate is expired date due validation result. Property is read-only.

Returns: boolean

setExpired(boolean value)

public final void setExpired(boolean value)

Indicates if certificate is expired date due validation result. Property is read-only.

Parameters:

Parameter	Type	Description
value	boolean

getPerformChainValidation()

public final boolean getPerformChainValidation()

Get or set if verification process should provide X.509 chain validation using basic validation policy. By default this value is true.

Returns: boolean

setPerformChainValidation(boolean value)

public final void setPerformChainValidation(boolean value)

Get or set if verification process should provide X.509 chain validation using basic validation policy. By default this value is true.

Parameters:

Parameter	Type	Description
value	boolean

toString()

public String toString()

Overrides conversion to string.

Returns: java.lang.String -

Nodejs-Java: DigitalVerifyOptions

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, com.groupdocs.signature.options.verify.VerifyOptions

public class DigitalVerifyOptions extends VerifyOptions

Keeps options to verify document Digital signature.

Learn more

Basic usage of verification for Digital electronic signature by GroupDocs.Signature: How to eVerification Digital signatures in a document
Advanced usage of settings of verification for Digital electronic signature with GroupDocs.Signature: Advanced usage of eVerification Digital signatures in a document and additional settings

Constructors

Constructor	Description
DigitalVerifyOptions()	Creates Digital Verification Option with default values.
DigitalVerifyOptions(String certificateGuid)	Creates Digital Verification Option with given digital certificate guid.
DigitalVerifyOptions(InputStream certificateStream)	Creates Digital Verification Option with given certificate stream.

Methods

Method	Description
getCertificate()	Get X509Certificate2 Certificate from Certificate Guid or Stream.
getPassword()	Password of Digital Certificate if required.
setPassword(String value)	Password of Digital Certificate if required.
getCertificateFilePath()	File Guid of Digital Certificate.
setCertificateFilePath(String value)	File Guid of Digital Certificate.
getCertificateStream()	Stream of Digital Certificate.
setCertificateStream(InputStream value)	Stream of Digital Certificate.
getComments()	Comments of Digital Signature to validate.
setComments(String value)	Comments of Digital Signature to validate.
getSignDateTimeFrom()	Date and time range of Digital Signature to validate.
setSignDateTimeFrom(Date value)	Date and time range of Digital Signature to validate.
getSignDateTimeTo()	Date and time range of Digital Signature to validate.
setSignDateTimeTo(Date value)	Date and time range of Digital Signature to validate.
getReason()	Reason of Digital Signature to validate.
setReason(String value)	Reason of Digital Signature to validate.
getContact()	Signature Contact to validate.
setContact(String value)	Signature Contact to validate.
getLocation()	Signature Location to validate.
setLocation(String value)	Signature Location to validate.
getSubjectName()	Subject distinguished name of the certificate to validate.
setSubjectName(String value)	Subject distinguished name of the certificate to validate.
getIssuerName()	Issuer name of the certificate to validate.
setIssuerName(String value)	Issuer name of the certificate to validate.

DigitalVerifyOptions()

public DigitalVerifyOptions()

Creates Digital Verification Option with default values.

DigitalVerifyOptions(String certificateGuid)

public DigitalVerifyOptions(String certificateGuid)

Creates Digital Verification Option with given digital certificate guid.

Parameters:

Parameter	Type	Description
certificateGuid	java.lang.String	File path to digital certificate.

DigitalVerifyOptions(InputStream certificateStream)

public DigitalVerifyOptions(InputStream certificateStream)

Creates Digital Verification Option with given certificate stream.

Parameters:

Parameter	Type	Description
certificateStream	java.io.InputStream	Certificate’s stream.

getCertificate()

public KeyStore getCertificate()

Get X509Certificate2 Certificate from Certificate Guid or Stream.

Returns: java.security.KeyStore

getPassword()

public final String getPassword()

Password of Digital Certificate if required.

Returns: java.lang.String

setPassword(String value)

public final void setPassword(String value)

Password of Digital Certificate if required.

Parameters:

Parameter	Type	Description
value	java.lang.String

getCertificateFilePath()

public final String getCertificateFilePath()

File Guid of Digital Certificate.

Returns: java.lang.String

setCertificateFilePath(String value)

public final void setCertificateFilePath(String value)

File Guid of Digital Certificate.

Parameters:

Parameter	Type	Description
value	java.lang.String

getCertificateStream()

public final InputStream getCertificateStream()

Stream of Digital Certificate.

Returns: java.io.InputStream

setCertificateStream(InputStream value)

public final void setCertificateStream(InputStream value)

Stream of Digital Certificate.

Parameters:

Parameter	Type	Description
value	java.io.InputStream

getComments()

public final String getComments()

Comments of Digital Signature to validate.

Returns: java.lang.String

setComments(String value)

public final void setComments(String value)

Comments of Digital Signature to validate.

Parameters:

Parameter	Type	Description
value	java.lang.String

getSignDateTimeFrom()

public Date getSignDateTimeFrom()

Date and time range of Digital Signature to validate. Nullable value will be ignored.

Returns: java.util.Date

setSignDateTimeFrom(Date value)

public void setSignDateTimeFrom(Date value)

Date and time range of Digital Signature to validate. Nullable value will be ignored.

Parameters:

Parameter	Type	Description
value	java.util.Date

getSignDateTimeTo()

public Date getSignDateTimeTo()

Date and time range of Digital Signature to validate. Nullable value will be ignored.

Returns: java.util.Date

setSignDateTimeTo(Date value)

public void setSignDateTimeTo(Date value)

Date and time range of Digital Signature to validate. Nullable value will be ignored.

Parameters:

Parameter	Type	Description
value	java.util.Date

getReason()

public final String getReason()

Reason of Digital Signature to validate.

Returns: java.lang.String

setReason(String value)

public final void setReason(String value)

Reason of Digital Signature to validate.

Parameters:

Parameter	Type	Description
value	java.lang.String

getContact()

public final String getContact()

Signature Contact to validate.

Returns: java.lang.String

setContact(String value)

public final void setContact(String value)

Signature Contact to validate.

Parameters:

Parameter	Type	Description
value	java.lang.String

getLocation()

public final String getLocation()

Signature Location to validate.

Returns: java.lang.String

setLocation(String value)

public final void setLocation(String value)

Signature Location to validate.

Parameters:

Parameter	Type	Description
value	java.lang.String

getSubjectName()

public final String getSubjectName()

Subject distinguished name of the certificate to validate. Value is case sensitive. If this property is set verification will check if Signature subject name contains or equals passed value

Returns: java.lang.String

setSubjectName(String value)

public final void setSubjectName(String value)

Subject distinguished name of the certificate to validate. Value is case sensitive. If this property is set verification will check if Signature subject name contains or equals passed value

Parameters:

Parameter	Type	Description
value	java.lang.String

getIssuerName()

public final String getIssuerName()

Issuer name of the certificate to validate. Value is case sensitive. If this property is set verification will check if Signature’s issuer name contains or equals passed value

Returns: java.lang.String

setIssuerName(String value)

public final void setIssuerName(String value)

Issuer name of the certificate to validate. Value is case sensitive. If this property is set verification will check if Signature’s issuer name contains or equals passed value

Parameters:

Parameter	Type	Description
value	java.lang.String

Nodejs-Java: QrCodeVerifyOptions

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, com.groupdocs.signature.options.verify.VerifyOptions, com.groupdocs.signature.options.verify.TextVerifyOptions

public class QrCodeVerifyOptions extends TextVerifyOptions

Keeps options to verify document QR-code signature.

Learn more

Basic usage of verification for QR-code electronic signature by GroupDocs.Signature: How to eVerification QR-code signatures in a document
Advanced usage of settings of verification for QR-code electronic signature with GroupDocs.Signature: Advanced usage of eVerification QR-code signatures in a document and additional settings

Constructors

Constructor	Description
QrCodeVerifyOptions()	Creates verification option QRCodeVerifyOptions for QR-Code Signatures.
QrCodeVerifyOptions(String text)	Creates verification option QRCodeVerifyOptions for QR-Code Signatures with QR-Code text to verify.
QrCodeVerifyOptions(String text, QrCodeType encodeType)	Creates verification option QRCodeVerifyOptions for QR-Code Signatures with text and QR-Code encode type to verify.

Methods

Method	Description
getEncodeType()	Gets or sets QR-code Type verification.
setEncodeType(QrCodeType value)	Gets or sets QR-code Type verification.
getDataEncryption()	Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text properties.
setDataEncryption(IDataEncryption value)	Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text properties.
toString()	Overrides conversion to string.

QrCodeVerifyOptions()

public QrCodeVerifyOptions()

Creates verification option QRCodeVerifyOptions for QR-Code Signatures.

QrCodeVerifyOptions(String text)

public QrCodeVerifyOptions(String text)

Creates verification option QRCodeVerifyOptions for QR-Code Signatures with QR-Code text to verify.

Parameters:

Parameter	Type	Description
text	java.lang.String	QR-code Text to verify

QrCodeVerifyOptions(String text, QrCodeType encodeType)

public QrCodeVerifyOptions(String text, QrCodeType encodeType)

Creates verification option QRCodeVerifyOptions for QR-Code Signatures with text and QR-Code encode type to verify.

Parameters:

Parameter	Type	Description
text	java.lang.String	Text to be verified
encodeType	QrCodeType	Type of encoding

getEncodeType()

public final QrCodeType getEncodeType()

Gets or sets QR-code Type verification. This property is optional.

Returns: QrCodeType

setEncodeType(QrCodeType value)

public final void setEncodeType(QrCodeType value)

Gets or sets QR-code Type verification. This property is optional.

Parameters:

Parameter	Type	Description
value	QrCodeType

getDataEncryption()

public final IDataEncryption getDataEncryption()

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text properties.

Returns: IDataEncryption

setDataEncryption(IDataEncryption value)

public final void setDataEncryption(IDataEncryption value)

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text properties.

Parameters:

Parameter	Type	Description
value	IDataEncryption

toString()

public String toString()

Overrides conversion to string.

Returns: java.lang.String -

Nodejs-Java: TextVerifyOptions

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, com.groupdocs.signature.options.verify.VerifyOptions

public class TextVerifyOptions extends VerifyOptions

Keeps options to verify document Text signature.

Learn more

Basic usage of verification for Text signature by GroupDocs.Signature: How to eVerification QR-code signatures in a document
Advanced usage of settings of verification for Text signature with GroupDocs.Signature: /// Advanced usage of eVerification Barcode signatures in a document and additional settings

Constructors

Constructor	Description
TextVerifyOptions()	Initializes a new instance of the TextVerifyOptions with default values.
TextVerifyOptions(String text)	Initializes a new instance of the TextVerifyOptions with verification text.
TextVerifyOptions(String text, int implementation)	Initializes a new instance of the TextVerifyOptions with Text property to verify and signature implementation.

Methods

Method	Description
getText()	Specify Signature Text if it should be verified.
setText(String value)	Specify Signature Text if it should be verified.
getMatchType()	Gets or sets Text Match Type verification.
setMatchType(int value)	Gets or sets Text Match Type verification.
getSignatureImplementation()	Type of Signature to be verified.
setSignatureImplementation(int value)	Type of Signature to be verified.
getFormTextFieldTitle()	Gets or sets the title of form field to verify it.
setFormTextFieldTitle(String value)	Gets or sets the title of form field to verify it.
getFormTextFieldType()	Gets or sets the type of form field to verify it.
setFormTextFieldType(Integer value)	Gets or sets the type of form field to verify it.
getSignatureID()	Specify Text Signature ID more than zero if it should be verified.
setSignatureID(int value)	Specify Text Signature ID more than zero if it should be verified.
toString()	Overrides conversion to string.

TextVerifyOptions()

public TextVerifyOptions()

Initializes a new instance of the TextVerifyOptions with default values.

TextVerifyOptions(String text)

public TextVerifyOptions(String text)

Initializes a new instance of the TextVerifyOptions with verification text.

Parameters:

Parameter	Type	Description
text	java.lang.String	Text to be verified

TextVerifyOptions(String text, int implementation)

public TextVerifyOptions(String text, int implementation)

Initializes a new instance of the TextVerifyOptions with Text property to verify and signature implementation.

Parameters:

Parameter	Type	Description
text	java.lang.String	Text to be verified.
implementation	int	Signature Implementation type.

getText()

public final String getText()

Specify Signature Text if it should be verified.

Returns: java.lang.String

setText(String value)

public final void setText(String value)

Specify Signature Text if it should be verified.

Parameters:

Parameter	Type	Description
value	java.lang.String

getMatchType()

public final int getMatchType()

Gets or sets Text Match Type verification.

Returns: int

setMatchType(int value)

public final void setMatchType(int value)

Gets or sets Text Match Type verification.

Parameters:

Parameter	Type	Description
value	int

getSignatureImplementation()

public final int getSignatureImplementation()

Type of Signature to be verified.

Returns: int

setSignatureImplementation(int value)

public final void setSignatureImplementation(int value)

Type of Signature to be verified.

Parameters:

Parameter	Type	Description
value	int

getFormTextFieldTitle()

public final String getFormTextFieldTitle()

Gets or sets the title of form field to verify it. If this property set text will be found only in text form fields.

Returns: java.lang.String

setFormTextFieldTitle(String value)

public final void setFormTextFieldTitle(String value)

Gets or sets the title of form field to verify it. If this property set text will be found only in text form fields.

Parameters:

Parameter	Type	Description
value	java.lang.String

getFormTextFieldType()

public final Integer getFormTextFieldType()

Gets or sets the type of form field to verify it. If this property set text will be found only in text form fields.

Returns: java.lang.Integer

setFormTextFieldType(Integer value)

public final void setFormTextFieldType(Integer value)

Gets or sets the type of form field to verify it. If this property set text will be found only in text form fields.

Parameters:

Parameter	Type	Description
value	java.lang.Integer

getSignatureID()

public final int getSignatureID()

Specify Text Signature ID more than zero if it should be verified. This property is supported only for Pdf documents

Returns: int

setSignatureID(int value)

public final void setSignatureID(int value)

Specify Text Signature ID more than zero if it should be verified. This property is supported only for Pdf documents

Parameters:

Parameter	Type	Description
value	int

toString()

public String toString()

Overrides conversion to string.

Returns: java.lang.String -

Nodejs-Java: VerifyOptions

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public abstract class VerifyOptions

Keeps options to verify document.

Methods

Method	Description
isValid()	Valid property flag.
setValid(boolean value)	Valid property flag.
getPageNumber()	Document Page Number to be verified.
setPageNumber(Integer value)	Document Page Number to be verified.
getPagesSetup()	Page Options to specify pages to be verified.
setPagesSetup(PagesSetup value)	Page Options to specify pages to be verified.
getAllPages()	Flag to verify each document page.
setAllPages(boolean value)	Flag to verify each document page.
getExtensions()	Additional extensions for alternative signature options verification.
setExtensions(VerifyExtensions value)	Additional extensions for alternative signature options verification.
toString()	Override string conversion.

isValid()

public final boolean isValid()

Valid property flag.

Returns: boolean

setValid(boolean value)

public final void setValid(boolean value)

Valid property flag.

Parameters:

Parameter	Type	Description
value	boolean

getPageNumber()

public Integer getPageNumber()

Document Page Number to be verified. If property is not set - all Pages of Document will be verified for first occurrence. Minimal value is 1.

Returns: java.lang.Integer

setPageNumber(Integer value)

public void setPageNumber(Integer value)

Document Page Number to be verified. If property is not set - all Pages of Document will be verified for first occurrence. Minimal value is 1.

Parameters:

Parameter	Type	Description
value	java.lang.Integer

getPagesSetup()

public PagesSetup getPagesSetup()

Page Options to specify pages to be verified.

Returns: PagesSetup

setPagesSetup(PagesSetup value)

public void setPagesSetup(PagesSetup value)

Page Options to specify pages to be verified.

Parameters:

Parameter	Type	Description
value	PagesSetup

getAllPages()

public final boolean getAllPages()

Flag to verify each document page. By default value is true.

Returns: boolean

setAllPages(boolean value)

public final void setAllPages(boolean value)

Flag to verify each document page. By default value is true.

Parameters:

Parameter	Type	Description
value	boolean

getExtensions()

public final VerifyExtensions getExtensions()

Additional extensions for alternative signature options verification.

Returns: VerifyExtensions

setExtensions(VerifyExtensions value)

public final void setExtensions(VerifyExtensions value)

Additional extensions for alternative signature options verification.

Parameters:

Parameter	Type	Description
value	VerifyExtensions

toString()

public String toString()

Override string conversion.

Returns: java.lang.String -