Foxit PDF SDK
FoxitPDFSDKPython2.TimeStampServerMgr Class Reference

Inherits FoxitPDFSDKPython2._object.

Static Public Member Functions

def AddServer (server_name, server_url, user_name, password)
 Add a time stamp server to the manager.
More...
 
def GetDefaultServer ()
 Get default time stamp server object.
More...
 
def GetServer (index)
 Get time stamp server with specified index.
More...
 
def GetServerCount ()
 Get time stamp server count.
More...
 
def GetServerIndex (server)
 Get the index of a speicified time stamp server object.
More...
 
def Initialize ()
 Initialize time stamp server manager.
More...
 
def Release ()
 Release time stamp server manager.
More...
 
def RemoveServer (server)
 Remove a time stamp server from the manager, by index.
More...
 
def SetDefaultServer (server)
 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 FoxitPDFSDKPython2.TimeStampCallback object has been set through FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.TimeStampCallback .

Member Function Documentation

◆ AddServer()

FoxitPDFSDKPython2.TimeStampServerMgr.AddServer (   server_name,
  server_url,
  user_name,
  password 
)
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()

FoxitPDFSDKPython2.TimeStampServerMgr.GetDefaultServer ( )
static

Get default time stamp server object.

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

◆ GetServer()

FoxitPDFSDKPython2.TimeStampServerMgr.GetServer (   index)
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 FoxitPDFSDKPython2.TimeStampServerMgr.GetServerCount .
Returns
A time stamp server object.

◆ GetServerCount()

FoxitPDFSDKPython2.TimeStampServerMgr.GetServerCount ( )
static

Get time stamp server count.

Returns
Server count.

◆ GetServerIndex()

FoxitPDFSDKPython2.TimeStampServerMgr.GetServerIndex (   server)
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()

FoxitPDFSDKPython2.TimeStampServerMgr.Initialize ( )
static

Initialize time stamp server manager.

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

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

◆ Release()

FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.TimeStampServerMgr.Initialize again.

Returns
None.

◆ RemoveServer()

FoxitPDFSDKPython2.TimeStampServerMgr.RemoveServer (   server)
static

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

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.
Parameters
[in]indexIndex of the time stamp server which is to be removed from the manager.
Returns
None.

◆ SetDefaultServer()

FoxitPDFSDKPython2.TimeStampServerMgr.SetDefaultServer (   server)
static

Set default time stamp server object by index.

Parameters
[in]serverA time stamp server object to be set as default server. If input server object is invalid, this function wil throw exception FoxitPDFSDKPython2.e_ErrNotFound .
Returns
None.
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 FoxitPDFSDKPython2.TimeStampServerMgr.GetServerCount .
Returns
None.