visit Kofax web site

de.softpro.signware.SPSmartcard Class Reference

Inheritance diagram for de.softpro.signware.SPSmartcard:

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

Detailed Description

Smartcard object.

Access a smartcard. This class supports reading / writing template files on smartcard.

Operating Systems:
Windows (Win32)


Public Member Functions

void displayText (String strText) throws SPSignwareException
 Show some text on readers that integrate a display.
int getCardType () throws SPSignwareException
 Query the inserted smartcard.
String getInput (String strText, int iFlags) throws SPSignwareException
 Read some input from the card terminal.
int getStatus () throws SPSignwareException
 Query the status from the smartcard.
boolean isCardInserted () throws SPSignwareException
 Query the status from the smartcard.
byte[] loadTemplate () throws SPSignwareException
 Read a template from the smartcard.
int saveTemplate (byte[] baTemplate, String strPassword) throws SPSignwareException
 Write a template to the smartcard.
int saveTemplate (byte[] baTemplate) throws SPSignwareException
 Write a template to the smartcard.
 SPSmartcard (SPSmartcardDriver spSmartcardDriver) throws SPSignwareException
 Instantiate a ne Smartcard object. The Smartcard object is bound to the reader defined by SPSmartcardDriver.

Static Public Attributes

static final int SMARTCARD_CHANGED = 2
 Smartcard status: the Smartcard was changed.
static final int SMARTCARD_INSERTED = 1
 Smartcard status: a Smartcard is inserted.

Package Functions

native int jniFree ()


Constructor & Destructor Documentation

de.softpro.signware.SPSmartcard.SPSmartcard SPSmartcardDriver  spSmartcardDriver  )  throws SPSignwareException
 

Instantiate a ne Smartcard object. The Smartcard object is bound to the reader defined by SPSmartcardDriver.

Parameters:
spSmartcardDriver Smartcard reader
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPSmartcardCreate


Member Function Documentation

void de.softpro.signware.SPSmartcard.displayText String  strText  )  throws SPSignwareException
 

Show some text on readers that integrate a display.

Note:
Not all readers integrate a display, the function may return an error or ignore the call on these readers.
Parameters:
strText [i] the text to be displayed
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPSmartcardDisplayText

int de.softpro.signware.SPSmartcard.getCardType  )  throws SPSignwareException
 

Query the inserted smartcard.

Returns:
int smartcard identifyer
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SC_CARD_UNKNOWN, SC_CARD_TCOS, SC_CARD_STARCOS, SC_CARD_SMARTCAFE

SPSmartcardGetCardType

String de.softpro.signware.SPSmartcard.getInput String  strText,
int  iFlags
throws SPSignwareException
 

Read some input from the card terminal.

This implementation limits the input to 63 characters.

Note:
Not all readers integrate a keyboard, the function may return an error or ignore the call on these readers.
Parameters:
strText [i] optional text to be shown on the display, see displayText
iFlags [i] optional flags
  • SP_SUPRESS_INPUT display any input as asterisk (*) on the integrated terminal
Returns:
String the entered characters
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)

int de.softpro.signware.SPSmartcard.getStatus  )  throws SPSignwareException
 

Query the status from the smartcard.

Returns:
int status
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SMARTCARD_CHANGED, SMARTCARD_INSERTED

SPSmartcardGetStatus

boolean de.softpro.signware.SPSmartcard.isCardInserted  )  throws SPSignwareException
 

Query the status from the smartcard.

Returns:
boolean status, true: a smartcard is inserted
Exceptions:
SPSignwareException on error
See also:
getStatus, SMARTCARD_CHANGED, SMARTCARD_INSERTED
Operating Systems:
Windows (Win32)

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

Implements de.softpro.signware.SPSignwareObject.

byte [] de.softpro.signware.SPSmartcard.loadTemplate  )  throws SPSignwareException
 

Read a template from the smartcard.

Returns:
byte[] a template as FlatFile
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPSmartcardLoadTemplate

int de.softpro.signware.SPSmartcard.saveTemplate byte[]  baTemplate,
String  strPassword
throws SPSignwareException
 

Write a template to the smartcard.

Parameters:
baTemplate a template as FlatFile
strPassword Password to allow for writing on the smartcard, may be null (to disable passwords) or "" (smartcard password is empty)
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPSmartcardSaveTemplatePassword

int de.softpro.signware.SPSmartcard.saveTemplate byte[]  baTemplate  )  throws SPSignwareException
 

Write a template to the smartcard.

Parameters:
baTemplate a template as FlatFile
Returns:
int number of bytes written
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPSmartcardSaveTemplate


Member Data Documentation

final int de.softpro.signware.SPSmartcard.SMARTCARD_CHANGED = 2 [static]
 

Smartcard status: the Smartcard was changed.

final int de.softpro.signware.SPSmartcard.SMARTCARD_INSERTED = 1 [static]
 

Smartcard status: a Smartcard is inserted.


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