Foxit PDF SDK
FoxitPDFSDKPython3.TimeStampServerMgr Class Reference

Inherits FoxitPDFSDKPython3._object.

Static Public Attributes

 AddServer = _fsdk.TimeStampServerMgr_AddServer
 Add a time stamp server to the manager. More...
 
 GetDefaultServer = _fsdk.TimeStampServerMgr_GetDefaultServer
 Get default time stamp server object. More...
 
 GetServer = _fsdk.TimeStampServerMgr_GetServer
 Get time stamp server with specified index. More...
 
 GetServerCount = _fsdk.TimeStampServerMgr_GetServerCount
 Get time stamp server count. More...
 
 GetServerIndex = _fsdk.TimeStampServerMgr_GetServerIndex
 Get the index of a speicified time stamp server object. More...
 
 Initialize = _fsdk.TimeStampServerMgr_Initialize
 Initialize time stamp server manager. More...
 
 Release = _fsdk.TimeStampServerMgr_Release
 Release time stamp server manager. More...
 
 RemoveServer = _fsdk.TimeStampServerMgr_RemoveServer
 Remove a time stamp server from the manager, by index. More...
 
 SetDefaultServer = _fsdk.TimeStampServerMgr_SetDefaultServer
 Set default time stamp server object by index. More...
 

Detailed Description

Time stamp server manager is used to manage some time stamp servers. The default time stamp server in this manager will be used in default signature callback for filter "Adobe.PPKLite" with sub filter "ETSI.CAdES.detached" and filter "Adobe.PPKLite" with sub filter "ETSI.RFC3161". So before signing or verifying signatures in these filter-subfitler pair by using default signature callback in Foxit PDF SDK, please ensure that a valid FoxitPDFSDKPython3.TimeStampCallback object has been set through FoxitPDFSDKPython3.Library.SetTimeStampCallback or the time stamp server manager has been initialized and the default server is set, if both are set, Foxit PDF SDK will use the FoxitPDFSDKPython3.TimeStampCallback .

Member Data Documentation

◆ AddServer

FoxitPDFSDKPython3.TimeStampServerMgr.AddServer = _fsdk.TimeStampServerMgr_AddServer
static

Add a time stamp server to the manager.

Parameters
[in]server_nameName of time stamp server. It should not be an empty string.
[in]server_urlURL of time stamp server. It should not be an empty string.
[in]user_nameUser name for the time stamp server. If no need, please pass an empty string.
[in]passwordPassword for the time stamp server. If no need, please pass an empty string.
Returns
The newly added time stamp server object.

◆ GetDefaultServer

FoxitPDFSDKPython3.TimeStampServerMgr.GetDefaultServer = _fsdk.TimeStampServerMgr_GetDefaultServer
static

Get default time stamp server object.

Returns
A time stamp server object which is the default one.

◆ GetServer

FoxitPDFSDKPython3.TimeStampServerMgr.GetServer = _fsdk.TimeStampServerMgr_GetServer
static

Get time stamp server with specified index.

Parameters
[in]indexTime stamp server index. Valid range: from 0 to (count-1). count is returned by function FoxitPDFSDKPython3.TimeStampServerMgr.GetServerCount .
Returns
A time stamp server object.

◆ GetServerCount

FoxitPDFSDKPython3.TimeStampServerMgr.GetServerCount = _fsdk.TimeStampServerMgr_GetServerCount
static

Get time stamp server count.

Returns
Server count.

◆ GetServerIndex

FoxitPDFSDKPython3.TimeStampServerMgr.GetServerIndex = _fsdk.TimeStampServerMgr_GetServerIndex
static

Get the index of a speicified time stamp server object.

Parameters
[in]serverA time stamp server object.
Returns
Index of specified time stamp server object.

◆ Initialize

FoxitPDFSDKPython3.TimeStampServerMgr.Initialize = _fsdk.TimeStampServerMgr_Initialize
static

Initialize time stamp server manager.

This function should be called first before any other functions in TimeStampServerMgr can be called.

Returns
FoxitPDFSDKPython3.e_ErrSuccess means success.
For more information about error code values, please refer to values starting from FoxitPDFSDKPython3.e_ErrSuccess .

◆ Release

FoxitPDFSDKPython3.TimeStampServerMgr.Release = _fsdk.TimeStampServerMgr_Release
static

Release time stamp server manager.

User can call this function to release time stamp server manager when no need to use it any more. After this function is called, if user wants to use time stamp server manager again, please call function FoxitPDFSDKPython3.TimeStampServerMgr.Initialize again.

Returns
None.

◆ RemoveServer

FoxitPDFSDKPython3.TimeStampServerMgr.RemoveServer = _fsdk.TimeStampServerMgr_RemoveServer
static

Remove a time stamp server from the manager, by index.

Parameters
[in]indexIndex of the time stamp server which is to be removed from the manager.
Returns
None.
Parameters
[in]serverA time stamp server object to be removed from the manager. If input server object is invalid, this function will do nothing and return directly.
Returns
None.

◆ SetDefaultServer

FoxitPDFSDKPython3.TimeStampServerMgr.SetDefaultServer = _fsdk.TimeStampServerMgr_SetDefaultServer
static

Set default time stamp server object by index.

Parameters
[in]indexIndex of a time stamp server to be set as default one.Valid range: from 0 to (count-1). count is returned by function FoxitPDFSDKPython3.TimeStampServerMgr.GetServerCount .
Returns
None.
Parameters
[in]serverA time stamp server object to be set as default server. If input server object is invalid, this function wil throw exception FoxitPDFSDKPython3.e_ErrNotFound .
Returns
None.