visit Kofax web site

de.softpro.signware.SPTicket Class Reference

Inheritance diagram for de.softpro.signware.SPTicket:

de.softpro.signware.SPSignwareObject List of all members.

Detailed Description

a representation of a license ticket


SPTickets are used in SPCompare, SPTablet, SPSignature, SPReference and SPImage objects. Tickets can be serialized, use SPTicket(byte []), SPFlatFile.createFromTicket. SPTicket also implements java.io.Serializable.

Deprecated:
SignWare now uses license keys, usage of license tickets is deprecated.
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)


Public Member Functions

void charge () throws SPSignwareException
 Fill a ticket with a license for the specified operation.
int getCount () throws SPSignwareException
 Query the requested / granted charge count for this object.
String getSession () throws SPSignwareException
 Query the session identifier for this ticket object.
int getUsage () throws SPSignwareException
 Query the usage for this ticket object.
void setCount (int iCount) throws SPSignwareException
 Set the requested charge count for this object.
void setSession (String strSession) throws SPSignwareException
 Set the session identifier for this ticket object.
void setUsage (int iUsage) throws SPSignwareException
 Set the usage for this ticket object.
 SPTicket (byte baFlatfile[]) throws SPSignwareException
 Create an instance of a license holder for a specific operation.
 SPTicket (int iUsage, int iNumTickets, String strSession) throws SPSignwareException
 Create an instance of a license holder for a specific operation.

Static Public Attributes

static final int ticket_capture = 9
 License operation: signature capture.
static final int ticket_clean = 7
 License operation: clean static images.
static final int ticket_compare_dynamic = 6
 License operation: dynamic signature verification.
static final int ticket_compare_static = 5
 License operation: static signature verification.
static final int ticket_load_dynamic = 3
 License operation: load dynamic signature verification engine.
static final int ticket_load_signware = 1
 License operation: load signware core modules.
static final int ticket_load_static = 2
 License operation: load static signature verification engine.
static final int ticket_render = 10
 License operation: render a dynamic signature.

Package Functions

native final int jniFree ()


Constructor & Destructor Documentation

de.softpro.signware.SPTicket.SPTicket int  iUsage,
int  iNumTickets,
String  strSession
throws SPSignwareException
 

Create an instance of a license holder for a specific operation.

Call charge() to charge the ticket and then pass it to the ticket consumer.

Exceptions:
SPSignwareException on errors (SP_MEMERR)
Deprecated:
Please use a license key.
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPCompare.setTicket, SPGuiAcqu.setTicket, SPSignware.setTicket

de.softpro.signware.SPTicket.SPTicket byte  baFlatfile[]  )  throws SPSignwareException
 

Create an instance of a license holder for a specific operation.

Deprecated:
Please use a license key.
Parameters:
baFlatfile [i] a ticket in flatfile representation
Exceptions:
SPSignwareException on errors (SP_MEMERR)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPCompare.setTicket, SPGuiAcqu.setTicket, SPSignware.setTicket

SPFlatFile.createFromTicket


Member Function Documentation

void de.softpro.signware.SPTicket.charge  )  throws SPSignwareException
 

Fill a ticket with a license for the specified operation.

Use getCount() to query the charge count received.

Deprecated:
Please use a license key.
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
Exceptions:
SPSignwareException on errors (SP_MEMERR)
See also:
SPTicket(int, int, String)

int de.softpro.signware.SPTicket.getCount  )  throws SPSignwareException
 

Query the requested / granted charge count for this object.

Deprecated:
Please use a license key.
Returns:
int the requested / granted charge count
Exceptions:
SPSignwareException on errors (SP_MEMERR)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPTicketGetCount, setCount

String de.softpro.signware.SPTicket.getSession  )  throws SPSignwareException
 

Query the session identifier for this ticket object.

Deprecated:
Please use a license key.
Returns:
String the session identifier for this ticket
Exceptions:
SPSignwareException on errors (SP_MEMERR)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPTicketGetSession, setSession

int de.softpro.signware.SPTicket.getUsage  )  throws SPSignwareException
 

Query the usage for this ticket object.

Deprecated:
Please use a license key.
Returns:
int the usage for this ticket
Exceptions:
SPSignwareException on errors (SP_MEMERR)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPTicketGetUsage, setUsage

native final int de.softpro.signware.SPTicket.jniFree  )  [package, virtual]
 

Implements de.softpro.signware.SPSignwareObject.

void de.softpro.signware.SPTicket.setCount int  iCount  )  throws SPSignwareException
 

Set the requested charge count for this object.

Deprecated:
Please use a license key.
Parameters:
iCount [i] the charge count
Exceptions:
SPSignwareException on errors (SP_MEMERR)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPTicketSetCount, getCount

void de.softpro.signware.SPTicket.setSession String  strSession  )  throws SPSignwareException
 

Set the session identifier for this ticket object.

Deprecated:
Please use a license key.
Parameters:
strSession [i] the session identifier for this ticket
Exceptions:
SPSignwareException on errors (SP_MEMERR)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPTicketSetSession, getSession

void de.softpro.signware.SPTicket.setUsage int  iUsage  )  throws SPSignwareException
 

Set the usage for this ticket object.

Deprecated:
Please use a license key.
Parameters:
iUsage [i] the usage for this ticket
Exceptions:
SPSignwareException on errors (SP_MEMERR)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPTicketSetUsage, getUsage


Member Data Documentation

final int de.softpro.signware.SPTicket.ticket_capture = 9 [static]
 

License operation: signature capture.

final int de.softpro.signware.SPTicket.ticket_clean = 7 [static]
 

License operation: clean static images.

final int de.softpro.signware.SPTicket.ticket_compare_dynamic = 6 [static]
 

License operation: dynamic signature verification.

final int de.softpro.signware.SPTicket.ticket_compare_static = 5 [static]
 

License operation: static signature verification.

final int de.softpro.signware.SPTicket.ticket_load_dynamic = 3 [static]
 

License operation: load dynamic signature verification engine.

final int de.softpro.signware.SPTicket.ticket_load_signware = 1 [static]
 

License operation: load signware core modules.

final int de.softpro.signware.SPTicket.ticket_load_static = 2 [static]
 

License operation: load static signature verification engine.

final int de.softpro.signware.SPTicket.ticket_render = 10 [static]
 

License operation: render a dynamic signature.


The documentation for this class was generated from the following file: