com.foxit.sdk.pdf.Signature Class Reference
Inheritance diagram for com.foxit.sdk.pdf.Signature:
com.foxit.sdk.pdf.interform.Field com.foxit.sdk.common.Base

Public Member Functions

 Signature (Field field)
 Constructor, with parent class object. More...
 
 Signature (PDFDoc document, PDFDictionary sig_field_dict)
 Constructor, from signature field dictionary. More...
 
boolean clearSignedData () throws com.foxit.sdk.PDFException
 Clear the data and appearance if current signature is singed and verified valid. More...
 
int getAppearanceFlags () throws com.foxit.sdk.PDFException
 Get signature appearance flags. More...
 
Bitmap getBitmap () throws com.foxit.sdk.PDFException
 Get a bitmap which is used for the signature appearance. More...
 
boolean getByteRangeArray (int[] out_byte_range_array) throws com.foxit.sdk.PDFException
 Get the byte ranges data, including 4 elements. More...
 
String getCert (int index) throws com.foxit.sdk.PDFException
 Get a certificate from current signature's certificate chain by index. More...
 
int getCertCount () throws com.foxit.sdk.PDFException
 Get the count of certificates in current signature's certificate chain. More...
 
String getCertificateInfo (String key) throws com.foxit.sdk.PDFException
 Get certificate information. More...
 
PDFDoc getDocument () throws com.foxit.sdk.PDFException
 Get the PDF document, which current signature belongs to. More...
 
String getFilter () throws com.foxit.sdk.PDFException
 Get filter. More...
 
String getKeyValue (int key) throws com.foxit.sdk.PDFException
 Get the string value for specified key name. More...
 
PDFDictionary getSignatureDict () throws com.foxit.sdk.PDFException
 Get signature dictionary. More...
 
DateTime getSignTime () throws com.foxit.sdk.PDFException
 Get time of signing. More...
 
int getState () throws com.foxit.sdk.PDFException
 Get current state. More...
 
String getSubFilter () throws com.foxit.sdk.PDFException
 Get sub filter. More...
 
boolean isEmpty ()
 Check whether current object is empty or not. More...
 
boolean isSigned () throws com.foxit.sdk.PDFException
 Check whether current signature is signed or not. More...
 
void setAppearanceContent (String appearance_content) throws com.foxit.sdk.PDFException
 Set customized appearance content (as low level drawing operation commands) for signed signature appearance. More...
 
void setAppearanceFlags (int appearance_flags) throws com.foxit.sdk.PDFException
 Set signature appearance flags. More...
 
void setBitmap (Bitmap bitmap) throws com.foxit.sdk.PDFException
 Set a bitmap for the signature appearance. More...
 
void setCertChain (WStringArray cert_chain) throws com.foxit.sdk.PDFException
 Set a certificate chain. More...
 
void setDefaultContentsLength (int default_length) throws com.foxit.sdk.PDFException
 Set the default length of signature contents which represents signature value (known as signed data). More...
 
void setFilter (String filter) throws com.foxit.sdk.PDFException
 Set filter. More...
 
void setImage (Image image, int frame_index) throws com.foxit.sdk.PDFException
 Set an image for the signature appearance, with a specified frame index. More...
 
void setImage (String file_path, int frame_index) throws com.foxit.sdk.PDFException
 Set an image for the signature appearance, with a specified frame index. More...
 
void setKeyValue (int key, String value) throws com.foxit.sdk.PDFException
 Set the string value for specified key name. More...
 
void setSignTime (DateTime sign_time) throws com.foxit.sdk.PDFException
 Set time of signing. More...
 
void setSubFilter (String sub_filter) throws com.foxit.sdk.PDFException
 Set sub filter. More...
 
Progressive startSign (String cert_path, byte[] cert_password, int digest_algorithm, String save_path, java.lang.Object client_data, PauseCallback pause) throws com.foxit.sdk.PDFException
 Start signing current signature if current signature is unsigned. More...
 
Progressive startVerify (java.lang.Object client_data, PauseCallback pause) throws com.foxit.sdk.PDFException
 Start verifying current signature if current signature is signed. More...
 
- Public Member Functions inherited from com.foxit.sdk.pdf.interform.Field
 Field (PDFDoc document, PDFDictionary field_dict)
 Constructor, from field dictionary. More...
 
 Field (Field field)
 Constructor, with another Field object. More...
 
int getAlignment () throws com.foxit.sdk.PDFException
 Get the alignment value. More...
 
String getAlternateName () throws com.foxit.sdk.PDFException
 Get alternate name. More...
 
Control getControl (int index) throws com.foxit.sdk.PDFException
 Get a form control by index. More...
 
Control getControl (PDFPage page, int index) throws com.foxit.sdk.PDFException
 Get a form control by index, in a specified PDF page. More...
 
int getControlCount () throws com.foxit.sdk.PDFException
 Get count of form controls. More...
 
int getControlCount (PDFPage page) throws com.foxit.sdk.PDFException
 Get count of form controls in a specified PDF page. More...
 
DefaultAppearance getDefaultAppearance () throws com.foxit.sdk.PDFException
 Get the default appearance data. More...
 
String getDefaultValue () throws com.foxit.sdk.PDFException
 Get default value. More...
 
PDFObject getDefaultValueObj () throws com.foxit.sdk.PDFException
 Get the PDF object of field's default value. More...
 
PDFDictionary getDict () throws com.foxit.sdk.PDFException
 Get the PDF dictionary of current object. More...
 
int getFlags () throws com.foxit.sdk.PDFException
 Get field flags. More...
 
PDFObject getInheritedAttribute (String attribute_name) throws com.foxit.sdk.PDFException
 Get the PDF object for specified attribute which may be inherited from the ancestor node in the field tree. More...
 
String getMappingName () throws com.foxit.sdk.PDFException
 Get mapping name. More...
 
int getMaxLength () throws com.foxit.sdk.PDFException
 Get maximum length of the field's text, in characters. More...
 
String getName () throws com.foxit.sdk.PDFException
 Get field name. More...
 
ChoiceOptionArray getOptions () throws com.foxit.sdk.PDFException
 Get options of list box or combo box. More...
 
int getTopVisibleIndex () throws com.foxit.sdk.PDFException
 Get top index of option for scrollable list boxes. More...
 
int getType () throws com.foxit.sdk.PDFException
 Get field type. More...
 
String getValue () throws com.foxit.sdk.PDFException
 Get value. More...
 
PDFObject getValueObj () throws com.foxit.sdk.PDFException
 Get the PDF object of field's value. More...
 
boolean isEmpty ()
 Check whether current object is empty or not. More...
 
boolean reset () throws com.foxit.sdk.PDFException
 Reset data in current field to its default value. (Not support signature field) More...
 
void setAlignment (int alignment) throws com.foxit.sdk.PDFException
 Set alignment property of a form, as a document-wide default value. (Not support signature field) More...
 
void setAlternateName (String alternate_name) throws com.foxit.sdk.PDFException
 Set alternate name. (Not support signature field) More...
 
void setDefaultAppearance (DefaultAppearance default_ap) throws com.foxit.sdk.PDFException
 Set default appearance data. More...
 
void setDefualtValue (String value) throws com.foxit.sdk.PDFException
 Set default value. More...
 
void setFlags (int flags) throws com.foxit.sdk.PDFException
 Set field flags. More...
 
void setMappingName (String name) throws com.foxit.sdk.PDFException
 Set mapping name. (Not support signature field) More...
 
void setMaxLength (int max_length) throws com.foxit.sdk.PDFException
 Set maximum length of the field's text, in characters. More...
 
void setOptions (ChoiceOptionArray option_array) throws com.foxit.sdk.PDFException
 Set options of list box or combo box. More...
 
void setTopVisibleIndex (int index) throws com.foxit.sdk.PDFException
 Set top index for scrollable list boxes. More...
 
void setValue (String value) throws com.foxit.sdk.PDFException
 Set value. More...
 

Static Public Attributes

static final int e_APFlagBitmap = 0x0080
 If set, show bitmap on signature appearance.
 
static final int e_APFlagDN = 0x0010
 If set, show distinguish name on signature appearance.
 
static final int e_APFlagFoxitFlag = 0x0001
 If set, show Foxit flag on signature appearance.
 
static final int e_APFlagLabel = 0x0002
 If set, show label on signature appearance.
 
static final int e_APFlagLocation = 0x0020
 If set, show location on signature appearance.
 
static final int e_APFlagReason = 0x0004
 If set, show reason on signature appearance.
 
static final int e_APFlagSigner = 0x0040
 If set, show signer on signature appearance.
 
static final int e_APFlagSigningTime = 0x0008
 If set, show signing time on signature appearance.
 
static final int e_APFlagText = 0x0100
 If set, show text content on signature appearance.
 
static final int e_DigestSHA1 = 0
 Signature digest algorithm: sha1 algorithm.
 
static final int e_DigestSHA256 = 1
 Signature digest algorithm: sha256 algorithm.
 
static final int e_DigestSHA384 = 2
 Signature digest algorithm: sha384 algorithm.
 
static final int e_DigestSHA512 = 3
 Signature digest algorithm: sha512 algorithm.
 
static final int e_KeyNameContactInfo = 3
 Signature key name: contact information.
 
static final int e_KeyNameDN = 4
 Signature key name: distinguish name.
 
static final int e_KeyNameLocation = 1
 Signature key name: location.
 
static final int e_KeyNameReason = 2
 Signature key name: reason.
 
static final int e_KeyNameSigner = 0
 Signature key name: signer.
 
static final int e_KeyNameText = 5
 Signature key name: text content.
 
static final int e_StateNoSignData = 0x00000200
 Signature does not have any data for signing.
 
static final int e_StateSigned = 0x00000002
 Signed signature.
 
static final int e_StateUnknown = 0x00000000
 Unknown signature.
 
static final int e_StateUnsigned = 0x00000001
 Unsigned signature.
 
static final int e_StateVerifyChange = 0x00000080
 The document has been changed within the scope of the signature.
 
static final int e_StateVerifyErrorByteRange = 0x00000040
 Non expected byte range.
 
static final int e_StateVerifyErrorData = 0x00000010
 Signature data is destroyed (that means the signature data cannot be parsed properly).
 
static final int e_StateVerifyIncredible = 0x00000100
 Signature cannot be trusted (containing aggression).
 
static final int e_StateVerifyInvalid = 0x00000008
 Verification state of a signature is invalid.
 
static final int e_StateVerifyIssueCurrent = 0x00020000
 The verified issue is current issuer.
 
static final int e_StateVerifyIssueExpire = 0x00008000
 Certificate for verifying issuer is expired.
 
static final int e_StateVerifyIssueRevoke = 0x00004000
 Certificate for verifying issuer is revoked.
 
static final int e_StateVerifyIssueUncheck = 0x00010000
 Not check the issuer.
 
static final int e_StateVerifyIssueUnknown = 0x00002000
 Verification state of the issuer is unknown.
 
static final int e_StateVerifyIssueValid = 0x00001000
 Verification state of the issuer is valid.
 
static final int e_StateVerifyNoChange = 0x00000400
 The document has not been changed within the scope of the signature.
 
static final int e_StateVerifyNoSupportWay = 0x00000020
 Unsupported signature.
 
static final int e_StateVerifyTimestampDoc = 0x00080000
 The signature is a timestamp signature.
 
static final int e_StateVerifyTimestampExpire = 0x00400000
 Verification state of the timestamp is expired.
 
static final int e_StateVerifyTimestampInvalid = 0x00200000
 Verification state of the timestamp is invalid.
 
static final int e_StateVerifyTimestampIssueUnknown = 0x00800000
 Verification state of the timestamp issuer is unknown.
 
static final int e_StateVerifyTimestampIssueValid = 0x01000000
 Verification state of the timestamp issuer is valid.
 
static final int e_StateVerifyTimestampNone = 0x00040000
 No timestamp or not check timestamp.
 
static final int e_StateVerifyTimestampTimeBefore = 0x02000000
 Verification state of the timestamp time is valid, since the times is before the expiration date.
 
static final int e_StateVerifyTimestampValid = 0x00100000
 Verification state of the timestamp is valid.
 
static final int e_StateVerifyValid = 0x00000004
 Verification state of a signature is valid.
 
- Static Public Attributes inherited from com.foxit.sdk.pdf.interform.Field
static final int e_FlagButtonNoToggleToOff = 0x100
 (Only useful for radio button) If set, exactly one radio button must be selected at all times; clicking the currently selected button has no effect. If clear, clicking the selected button deselects it, leaving no button selected.
 
static final int e_FlagButtonRadiosInUnison = 0x200
 (Only useful for radio button) If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually exclusive.
 
static final int e_FlagChoiseMultiSelect = 0x100
 (Only useful for combo box and list box) If set, more than one items may be selected simultaneously; if clear, no more than one item at a time may be selected.
 
static final int e_FlagComboEdit = 0x100
 (Only useful for combo box) If set, the combo box includes an editable text control with a drop-down list, if clear, it includes only a drop-down list.
 
static final int e_FlagNoExport = 0x04
 if set, the field must not be exported by a submit-form action.
 
static final int e_FlagReadOnly = 0x01
 If set, the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions. This flag is useful for fields whose values are computed or imported from a database.
 
static final int e_FlagRequired = 0x02
 If set, the field must have a value at the time it is exported by a submit-form action.
 
static final int e_FlagTextComb = 0x800
 (Only useful for text field) If set, use combs. More...
 
static final int e_FlagTextDoNotScroll = 0x400
 (Only useful for text field) If set, the field does not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation rectangle. Once the field is full, no further text is accepted.
 
static final int e_FlagTextMultiline = 0x100
 (Only useful for text field) If set, the text field can contain multiple lines of text; if clear, the field's text is restricted to a single line.
 
static final int e_FlagTextPassword = 0x200
 (Only useful for text field) If set, the field is intended for entering a secure password that should not be echoed visibly to the screen. Characters typed from the keyboard should instead be echoed in some unreadable form, such as asterisks or bullet characters. More...
 
static final int e_TypeCheckBox = 2
 Form field type: check box.
 
static final int e_TypeComboBox = 4
 Form field type: combo box.
 
static final int e_TypeListBox = 5
 Form field type: list box.
 
static final int e_TypePushButton = 1
 Form field type: push button.
 
static final int e_TypeRadioButton = 3
 Form field type: radio button.
 
static final int e_TypeSignature = 7
 Form field type: signature field.
 
static final int e_TypeTextField = 6
 Form field type: text field.
 
static final int e_TypeUnknown = 0
 Form field type: unknown.
 

Detailed Description

A digital signature (PDF 1.3) can be used to authenticate the identity of a user and the document's contents. It stores information about the signer and the state of the document when it was signed. The signature is contained in a signature field, as a type of form field, so class Signature is derived from class Field. A Signature object can be retrieved/added by following functions:


To be counted and retrieved as a signature object directly from PDF document, please use functions pdf::PDFDoc::getSignatureCount and pdf::PDFDoc::getSignature.
To be counted and retrieved as a signature field, please use functions interform::Form::getFieldCount and interform::Form::getField when field type is interform::e_TypeSignature.
To add a new signature, please use function PDFPage::addSignature.
To remove a signature, please use function pdf::PDFDoc::removeSignature.
In a signature, filter and sub filter keys are used to specify the filter and sub filter of signature callback object which will be used to sign and verify the signature. Foxit PDF SDK has default signature callbacks for following filter and sub filter:


filter: "Adobe.PPKLite" and sub filter: "adbe.pkcs7.detached"
filter: "Adobe.PPKLite" and sub filter: "adbe.pkcs7.sha1"
If user wants to use customized signature callback, please refer to function common::Library::registerSignatureCallback.
This class offers functions to get/set signature information/properties, sign or verify a signature, and so on. For example:


To sign an unsigned signature, please use functions Signature::startSign. When signing a signature successfully, user is strongly recommended to close current document and then open the signed PDF document and then do following operation.
To verify a signed signature, please use functions Signature::startVerify.
To retrieve signature dictionary directly, please use function Signature::getSignatureDict.
Before signing an unsigned signature, user can call following functions to set information for signing and signed appearance:


For using default Foxit appearance template, following functions can be used to set related information: Signature::setAppearanceFlags, Signature::setSignTime, Signature::setKeyValue, Signature::setBitmap, Signature::setImage.
For using customized appearance, please set appearance stream content by function Signature::setAppearanceContent.
If an unsigned signature has been set some information for signing, but the document is saved directly or closed without signing the signature, these data (including filter and sub filter) will be lost in the saved document or in the closed document. When the document is opened again, the unsigned signature needs to be specified at least filter and sub filter for signing; otherwise, this signature cannot be signed.

See also
interform::Field
interform::Form
pdf::PDFDoc
pdf::PDFPage

Constructor & Destructor Documentation

◆ Signature() [1/2]

com.foxit.sdk.pdf.Signature.Signature ( Field  field)

Constructor, with parent class object.

Parameters
fieldParent class object.

◆ Signature() [2/2]

com.foxit.sdk.pdf.Signature.Signature ( PDFDoc  document,
PDFDictionary  sig_field_dict 
)

Constructor, from signature field dictionary.

Parameters
documentA valid PDF document.
sig_field_dictA PDF dictionary which represents a signature field. It should belong to the PDF document specified by parameter document;

Member Function Documentation

◆ clearSignedData()

boolean com.foxit.sdk.pdf.Signature.clearSignedData ( ) throws com.foxit.sdk.PDFException

Clear the data and appearance if current signature is singed and verified valid.

This function is used for a signed and valid signature.

Returns
true means clear the data and appearance successfully, while false means no need to clear data and appearance or any error.

◆ getAppearanceFlags()

int com.foxit.sdk.pdf.Signature.getAppearanceFlags ( ) throws com.foxit.sdk.PDFException

Get signature appearance flags.

Signature appearance flags indicate which information will be shown. Currently, this is only useful after Signature::setAppearanceFlags is called successfully. For a signature gotten from PDF document, the return value of this function would be useless.

Returns
Signature appearance flags. Please refer to values starting from e_APFlagFoxitFlag and this would be one or a combination of these values.

◆ getBitmap()

Bitmap com.foxit.sdk.pdf.Signature.getBitmap ( ) throws com.foxit.sdk.PDFException

Get a bitmap which is used for the signature appearance.

Returns
The bitmap used in appearance. If the return value of function common::Bitmap::isEmpty for the returned bitmap object is true, that means no bitmap is used in appearance or there is any error.

◆ getByteRangeArray()

boolean com.foxit.sdk.pdf.Signature.getByteRangeArray ( int []  out_byte_range_array) throws com.foxit.sdk.PDFException

Get the byte ranges data, including 4 elements.

This function is used for a signed signature to retrieve its byte range for digest calculation. The array of byte ranges contains 4 elements. These 4 elements are always in pairs of integers (starting byte offset, length in bytes), describing the exact byte range for the digest calculation.
Please refer to <PDF Reference 1.7> Section 8.7 Digital Signatures for more details.

Parameters
out_byte_range_arrayOutput parameter that receives data of byte ranges. Please ensure this array can contain 4 elements.
Returns
true means success, while false means failure.

◆ getCert()

String com.foxit.sdk.pdf.Signature.getCert ( int  index) throws com.foxit.sdk.PDFException

Get a certificate from current signature's certificate chain by index.

This function is recommended to be used before verifying a signature. When sub filter of current signature is "adbe.x509.rsa_sha1", application needs to call this function to get verified public certificate before verifying signature. The first certificate in certificate chain is the signing certificate, and it can be used to verify the signature.

Parameters
indexThe index of certificate to be gotten. Valid range: from 0 to (count-1). count is returned by function Signature::getCertCount.
Returns
A certificate.

◆ getCertCount()

int com.foxit.sdk.pdf.Signature.getCertCount ( ) throws com.foxit.sdk.PDFException

Get the count of certificates in current signature's certificate chain.

This function is recommended to be used before verifying a signature. When sub filter of current signature is "adbe.x509.rsa_sha1", application needs to call this function to get the count of certificates in certificate chain and then call function Signature::getCert to get verified public certificate before verifying signature.

Returns
The count of certificates.

◆ getCertificateInfo()

String com.foxit.sdk.pdf.Signature.getCertificateInfo ( String  key) throws com.foxit.sdk.PDFException

Get certificate information.

This function is used for a signed signature. Currently, this function only supports for iOS and android platform.

Parameters
keyCertificate key string. Currently it can be one of the following keys:

"SerialNumber"
"Issuer"
"Subject"
"ValidPeriodFrom"
"ValidPeriodTo"

Returns
Certificate information string.
Note
For "ValidPeriodFrom" or "ValidPeriodTo" key, timezone value will not be computed in.

◆ getDocument()

PDFDoc com.foxit.sdk.pdf.Signature.getDocument ( ) throws com.foxit.sdk.PDFException

Get the PDF document, which current signature belongs to.

Returns
A PDF document object.

◆ getFilter()

String com.foxit.sdk.pdf.Signature.getFilter ( ) throws com.foxit.sdk.PDFException

Get filter.

Filter and sub filter are used to specify which registered signature callback object will be used to sign/verify current signature.

Returns
Filter string.

◆ getKeyValue()

String com.foxit.sdk.pdf.Signature.getKeyValue ( int  key) throws com.foxit.sdk.PDFException

Get the string value for specified key name.

This function is used to get string value of some key in signature dictionary, such as "Reason", "Location" and so on. Specially,

Parameters
keyKey name. Please refer to values starting from e_KeyNameSigner and this should be one of these values.
Returns
The string value.

◆ getSignatureDict()

PDFDictionary com.foxit.sdk.pdf.Signature.getSignatureDict ( ) throws com.foxit.sdk.PDFException

Get signature dictionary.

Signature dictionary is a part of signature field dictionary.

Returns
The signature dictionary.

◆ getSignTime()

DateTime com.foxit.sdk.pdf.Signature.getSignTime ( ) throws com.foxit.sdk.PDFException

Get time of signing.

Returns
A DateTime object that receives the signing time. If no signing time is found, this function will return a DateTime with all values 0.

◆ getState()

int com.foxit.sdk.pdf.Signature.getState ( ) throws com.foxit.sdk.PDFException

Get current state.


Before verifying a signature, this function is to get the state about if current signature is signed or if current signature is lack of data for signing.
After verifying a signature, this function is to get the verified state – which indicates that the verified signature is signed; if the verified signature is still unsigned, this function will get the unsigned state instead.

Returns
The value of signature state. Please refer to values starting from e_StateUnknown and this would be one or combination of them.
Specially, if the returned state is e_StateNoSignData, that means current signature has no data for signing, and please at least call function Signature::setKeyValue to set necessary filter and sub filter to current signature. Use can also call following functions to set other data for signing and signed appearance before calling function Signature::startSign:

For using default Foxit appearance template, following functions can be used to set related information: Signature::setAppearanceFlags, Signature::setSignTime, Signature::setKeyValue, Signature::setBitmap, Signature::setImage.
For using customized appearance, please set appearance stream content by function Signature::setAppearanceContent.

◆ getSubFilter()

String com.foxit.sdk.pdf.Signature.getSubFilter ( ) throws com.foxit.sdk.PDFException

Get sub filter.

Filter and sub filter are used to specify which registered signature callback object will be used to sign/verify current signature.

Returns
Sub filter string.

◆ isEmpty()

boolean com.foxit.sdk.pdf.Signature.isEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ isSigned()

boolean com.foxit.sdk.pdf.Signature.isSigned ( ) throws com.foxit.sdk.PDFException

Check whether current signature is signed or not.

Returns
true means current signature is signed, and false means not.

◆ setAppearanceContent()

void com.foxit.sdk.pdf.Signature.setAppearanceContent ( String  appearance_content) throws com.foxit.sdk.PDFException

Set customized appearance content (as low level drawing operation commands) for signed signature appearance.

This function can only be used for an unsigned signature before calling function Signature::startSign for the unsigned signature.
Once customized appearance content is set, it will be used as the signed appearance. In this case, appearance flags set by function Signature::setAppearanceFlags will be ignored and related informations will not be used in appearance – these information are set by following functions: Signature::setSignTime, Signature::setKeyValue (except filter and sub- filter), Signature::setBitmap, Signature::setImage.

Parameters
appearance_contentCustomized appearance content. This should be sequence of drawing operation commands to be used for the appearance, for example "10 10 m 20 10 l S". Please refer to <PDF Reference 1.7> P196 for more details.
Returns
None.

◆ setAppearanceFlags()

void com.foxit.sdk.pdf.Signature.setAppearanceFlags ( int  appearance_flags) throws com.foxit.sdk.PDFException

Set signature appearance flags.

This function is recommended to be used before calling function Signature::startSign for an unsigned signature. Signature appearance flags indicate which information will be shown in the signed appearance. If customized appearance content has been set by function Signature::setAppearanceContent, appearance flags will be ignored.

Parameters
appearance_flagsSignature appearance flags. Please refer to values starting from e_APFlagFoxitFlag and this should be one or a combination of these values.
Returns
None.

◆ setBitmap()

void com.foxit.sdk.pdf.Signature.setBitmap ( Bitmap  bitmap) throws com.foxit.sdk.PDFException

Set a bitmap for the signature appearance.

This function is recommended to be used before calling function Signature::startSign for an unsigned signature. If customized appearance content has been set by function Signature::setAppearanceContent, the bitmap will not be used in signed appearance.

Parameters
bitmapA bitmap to be set to the appearance. It should be valid.
Returns
None.

◆ setCertChain()

void com.foxit.sdk.pdf.Signature.setCertChain ( WStringArray  cert_chain) throws com.foxit.sdk.PDFException

Set a certificate chain.

This function is recommended to be used before signing an unsigned signature. When the signature sub filter is "adbe.x509.rsa_sha1", users need to call this function to set the cert chain to the signature. For other sub filter, this function will return directly without doing anything.

Parameters
cert_chainA string array that represents the certificate chain.
Returns
None.

◆ setDefaultContentsLength()

void com.foxit.sdk.pdf.Signature.setDefaultContentsLength ( int  default_length) throws com.foxit.sdk.PDFException

Set the default length of signature contents which represents signature value (known as signed data).

This function can only be used before function Signature::startSign for an unsigned signature. Signature contents represent the signature value (known as signed data). When initializing the signature field, the signature contents will be initialized with the default length 7942. When using custom signature callback to sign and verify an unsigned signature, user can call this function to change the default length of signature contents. In this case, user should also ensure that the length of returned signed data in callback function SignatureCallback::startSign should not be larger than the default length set by this function.

Parameters
default_lengthThe default length of the signature value (known as signed data), in bytes. It should not be less than 4098.
Returns
None.

◆ setFilter()

void com.foxit.sdk.pdf.Signature.setFilter ( String  filter) throws com.foxit.sdk.PDFException

Set filter.

Filter and sub filter are used to specify which registered signature callback object will be used to sign/verify current signature. User could should set filter and sub filter to use default signature callback in Foxit PDF SDK, or use other filter and sub fitler but please ensure that a signature callback object with non-default filter and sub filter should has been registered in Foxit PDF SDK before signing or verifying current signature. Filter and sub filter for default signature callback are:


filter: "Adobe.PPKLite" and sub filter: "adbe.pkcs7.detached"
filter: "Adobe.PPKLite" and sub filter: "adbe.pkcs7.sha1"

Parameters
filterString for filter. It cannot be an empty string.
Returns
None.

◆ setImage() [1/2]

void com.foxit.sdk.pdf.Signature.setImage ( Image  image,
int  frame_index 
) throws com.foxit.sdk.PDFException

Set an image for the signature appearance, with a specified frame index.

This function is recommended to be used before calling function Signature::startSign for an unsigned signature. If customized appearance content has been set by function Signature::setAppearanceContent, the image will not be used in signed appearance.
Input image may contain multiple frames, and only one frame of the image can be set to current signature.

Parameters
imageAn image. One of its frames will be set to current signature. This image contains at least one frame and the image type should not be common::e_Unknown.
frame_indexFrame index. Valid range: from 0 to (count-1). count is returned by function common::Image::getFrameCount.
Returns
None.

◆ setImage() [2/2]

void com.foxit.sdk.pdf.Signature.setImage ( String  file_path,
int  frame_index 
) throws com.foxit.sdk.PDFException

Set an image for the signature appearance, with a specified frame index.

This function is recommended to be used before calling function Signature::startSign for an unsigned signature. If customized appearance content has been set by function Signature::setAppearanceContent, the image will not be used in signed appearance.
Input image may contain multiple frames, and only one frame of the image can be set to current signature.

Parameters
file_pathA full path of an existing image file. It should not be an empty string.
frame_indexFrame index. Valid range: from 0 to (count-1). count is returned by function common::Image::getFrameCount of input image file.
Returns
None.

◆ setKeyValue()

void com.foxit.sdk.pdf.Signature.setKeyValue ( int  key,
String  value 
) throws com.foxit.sdk.PDFException

Set the string value for specified key name.

This function is recommended to be used before calling function Signature::startSign for an unsigned signature.
This function is used to set string value of some key in signature dictionary, such as signer, reason, location and so on.

Parameters
keyKey name. Please refer to values starting from e_KeyNameSigner and this should be one of these values.
valueNew string value.
Returns
None.

◆ setSignTime()

void com.foxit.sdk.pdf.Signature.setSignTime ( DateTime  sign_time) throws com.foxit.sdk.PDFException

Set time of signing.

This function is recommended to be used before calling function Signature::startSign for an unsigned signature.

Parameters
sign_timeThe signing time.
Returns
None.

◆ setSubFilter()

void com.foxit.sdk.pdf.Signature.setSubFilter ( String  sub_filter) throws com.foxit.sdk.PDFException

Set sub filter.

Filter and sub filter are used to specify which registered signature callback object will be used to sign/verify current signature. User could should set filter and sub filter to use default signature callback in Foxit PDF SDK, or use other filter and sub fitler but please ensure that a signature callback object with non-default filter and sub filter should has been registered in Foxit PDF SDK before signing or verifying current signature. Filter and sub filter for default signature callback are:


filter: "Adobe.PPKLite" and sub filter: "adbe.pkcs7.detached"
filter: "Adobe.PPKLite" and sub filter: "adbe.pkcs7.sha1"

Parameters
sub_filterString for sub filter.
Returns
None.

◆ startSign()

Progressive com.foxit.sdk.pdf.Signature.startSign ( String  cert_path,
byte []  cert_password,
int  digest_algorithm,
String  save_path,
java.lang.Object  client_data,
PauseCallback  pause 
) throws com.foxit.sdk.PDFException

Start signing current signature if current signature is unsigned.

This function is used for an unsigned signature. Filter and sub filter keys of current signature specify the name of signature callback object which will be used to sign current signature. So before signing, please ensure current signature has valid filter and sub filter string values. If the filter and sub filter are one of following strings that means to use the default signature callback in Foxit PDF SDK:


filter: "Adobe.PPKLite" and sub filter: "adbe.pkcs7.detached"
filter: "Adobe.PPKLite" and sub filter: "adbe.pkcs7.sha1"
For other filter and sub filter, please ensure a customized signature callback with them has been registered to Foxit PDF SDK by function common::Library::registerSignatureCallback.
It may take a long time to sign a signature, so Foxit PDF SDK uses a progressive process to do this.

Parameters
cert_pathA full path of a PFX certificate file (including file name and extension), which will be used for signing. This can be an empty string if not necessary in custom signature callback. When this file path is not empty, it should be a valid path.
cert_passwordA password string used to open the cert file. If this is an empty string, that means no password is required.
digest_algorithmThe algorithm of message digest for signed data. Please refer to values starting from e_DigestSHA1 and this should be one of these values.
save_pathA full PDF file path for saving the signing result. The signed document would be saved to another PDF file.
client_dataA user-defined object, which will be passed to call back functions in SignatureCallback. This is useless if the default callback object will be used to sign current signature.
pausePause object which decides if the signing process needs to be paused. This can be null which means not to pause during the signing process. If this is not null, it should be a valid pause object implemented by user.
Returns
A Progressive object. Please check the rate of current progress by function common::Progressive::getRateOfProgress. If the rate is not 100 yet, call function common::Progressive::resume to coninue the progress until the progress is finished.
Note
This function does not support to save signed PDF document directly to the PDF file which is used to construct the related PDF document of current signature. In order to do so, user is recommended to do as following steps:
Assume that the related PDF document object is constructed from a PDF file named "org.pdf".

Use current function to save the signed result to an temporary file. Here, this temporary file is named as "temp.tmp".
Ensure that the related PDF document object has destructed – which is equal to "close document".
Remove "org.pdf" and rename "temp.tmp" to "org.pdf".
Then user can open the signed PDF document to do other operation.

◆ startVerify()

Progressive com.foxit.sdk.pdf.Signature.startVerify ( java.lang.Object  client_data,
PauseCallback  pause 
) throws com.foxit.sdk.PDFException

Start verifying current signature if current signature is signed.

This function is used for a signed signature. Filter and sub filter keys of current signature specify the name of signature callback object which will be used to verify current signature. So before verifying, please ensure: the necessary signature callback object has been registered by function common::Library::registerSignatureCallback. If the filter and sub filter of current signed signature are one of following strings that means to use the default signature callback in Foxit PDF SDK and user does not need to register one for them:


filter: "Adobe.PPKLite" and sub filter: "adbe.pkcs7.detached"
filter: "Adobe.PPKLite" and sub filter: "adbe.pkcs7.sha1"
It may take a long time to verify a signature, so Foxit PDF SDK uses a progressive process to do this.

Parameters
client_dataA user-defined object, which will be passed to call back functions in SignatureCallback. This is useless if the default callback object will be used to verify current signature.
pausePause object which decides if the verifying process needs to be paused. This can be null which means not to pause during the verifying process. If this is not null, it should be a valid pause object implemented by user.
Returns
A Progressive object. Please check the rate of current progress by function common::Progressive::getRateOfProgress. If the rate is not 100 yet, call function common::Progressive::resume to coninue the progress until the progress is finished.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.