CkSCard Java Reference Documentation

CkSCard

Current Version: 10.0.0

Requires Chilkat Bundle License

A wrapper around the Resource Manager API of the PC/SC architecture for smart cards. On Windows it is a wrapper around the WinSCard functions implemented in the winscard.dll. On other systems (such as Linux) it is a wrapper around the same API implemented in pcsc-lite.so.

This class is introduced in Chilkat v9.5.0.87.

Object Creation

CkSCard obj = new CkSCard();

Properties

ActiveProtocol

void get_ActiveProtocol(CkString str);
String activeProtocol();

Introduced in version 9.50.87

The name of the active protocol if connected smart card reader, or an empty string if not connected. Possible values are "T0", "T1", "raw", "undefined", or "" if not connected to a reader.

CardAtr

void get_CardAtr(CkString str);
String cardAtr();

Introduced in version 9.50.87

This is the Current ATR of a card in the connected reader.

ConnectedReader

void get_ConnectedReader(CkString str);
String connectedReader();

Introduced in version 9.50.87

The name of the currently connected smart card reader, or an empty string if not connected.

Context

void get_Context(CkString str);
String context();

Introduced in version 9.50.87

Contains the string "user" or "system" if this object has established a context (by calling EstablishContext). Contains the empty string if no context is established.

DebugLogFilePath

void get_DebugLogFilePath(CkString str);
String debugLogFilePath();
void put_DebugLogFilePath(String newVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
there is an internal problem (bug) in the Chilkat code that causes the hang.

More Information and Examples

(Android™) Example showing how to use DebugLogFilePath.(Java) Example showing how to use DebugLogFilePath.

LastErrorHtml

void get_LastErrorHtml(CkString str);
String lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastErrorText

void get_LastErrorText(CkString str);
String lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void get_LastErrorXml(CkString str);
String lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastMethodSuccess

boolean get_LastMethodSuccess();
void put_LastMethodSuccess(boolean newVal);

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

Any method that returns a string.
Any method returning a Chilkat object, binary bytes, or a date/time.
Any method returning a standard boolean status value where success = true and failure = false.
Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

PcscLibPath

void get_PcscLibPath(CkString str);
String pcscLibPath();
void put_PcscLibPath(String newVal);

Introduced in version 9.50.87

For Linux systems only. Specifies the full path of the libpcsclite.so shared lib. This property should only be used if the libpcsclite.so is in a non-standard location or if Chilkat cannot automatically located it.

ReaderStatus

void get_ReaderStatus(CkString str);
String readerStatus();

Introduced in version 9.50.87

The current status of the connected reader. Possible values are:

"absent" - There is no card in the reader.
"present" - There is a card in the reader, but it has not been moved into position for use.
"swallowed" - There is a card in the reader in position for use. The card is not powered.
"powered" - Power is being provided to the card, but the reader driver is unaware of the mode of the card.
"negotiable" - The card has been reset and is awaiting PTS negotiation.
"specific" - The card has been reset and specific communication protocols have been established.

ScardError

void get_ScardError(CkString str);
String scardError();

Introduced in version 9.50.87

The last error returned by an underlying PC/SC function. Can be one of the following:

"SCARD_W_REMOVED_CARD" - The smart card has been removed, so that further communication is not possible.
"SCARD_W_RESET_CARD" - The smart card has been reset, so any shared state information is invalid.

VerboseLogging

boolean get_VerboseLogging();
void put_VerboseLogging(boolean newVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

void get_Version(CkString str);
String version();

Version of the component/library, such as "9.5.0.94"

More Information and Examples

(Android™) How to get the Chilkat version at runtime.(Java) How to get the Chilkat version at runtime.

Methods

BeginTransaction

boolean BeginTransaction();

Introduced in version 9.50.87

Establishes a temporary exclusive access mode for doing a series of commands in a transaction.

Returns true for success, false for failure.

CheckStatus

boolean CheckStatus();

Introduced in version 9.50.87

Check the current status of the currently connected reader. Calling this method updates the ReaderStatus, ActiveProtocol, and CardAtr properties. If this method returns false, none of the properties are updated.

Returns true for success, false for failure.

More Information and Examples

(Android™) PC/SC Check the Status of each Smart Card Reader (and USB token)(Java) PC/SC Check the Status of each Smart Card Reader (and USB token)

Connect

boolean Connect(String reader, String shareMode, String preferredProtocol);

Introduced in version 9.50.87

Establish a connection to a reader. The reader is the name of a reader returned from ListReaders. The shareMode can be "shared", "exclusive", or "direct". The preferredProtocol can be "0" (valid only if the shareMode = "direct"), "T0", "T1", "raw", or "no_preference". (No preference is effectively T0 or T1.)

If successful, the state of this object instance is that it's connected to the reader.

Returns true for success, false for failure.

More Information and Examples

(Android™) PC/SC Check the Status of each Smart Card Reader (and USB token)(Java) PC/SC Check the Status of each Smart Card Reader (and USB token)

Disconnect

boolean Disconnect(String disposition);

Introduced in version 9.50.87

Terminates a connection with a reader. The disposition can be one of the following values:

"leave": Do nothing.
"reset": Reset the card (warm reset).
"unpower": Power down the card (cold reset).
"eject": Eject the card.

Returns true for success, false for failure.

More Information and Examples

(Android™) PC/SC Check the Status of each Smart Card Reader (and USB token)(Java) PC/SC Check the Status of each Smart Card Reader (and USB token)

EndTransaction

boolean EndTransaction(String disposition);

Introduced in version 9.50.87

Ends a previously begun transaction. The disposition is the action to be taken on the reader, and can be "leave" which is to do nothing, "reset", "unpower", or "eject".

Returns true for success, false for failure.

EstablishContext

boolean EstablishContext(String scope);

Introduced in version 9.5.0.87

Creates an Application Context to the PC/SC Resource Manager. This must be the first WinSCard function called in a PC/SC application. The scope can be "user" or "system". After calling, this object will have context and all other methods will use the established context. The "Context" property will hold the value "user" or "system" if context was established, or will be empty if no context was established.

Returns true for success, false for failure.

FindSmartcards

boolean FindSmartcards(CkJsonObject json);

Introduced in version 9.50.87

Returns JSON containing information about the smartcards currently inserted into readers.

Returns true for success, false for failure.

More Information and Examples

(Android™) PC/SC Find Inserted Smart Cards (Java) PC/SC Find Inserted Smart Cards

GetAttrib

boolean GetAttrib(String attr, CkBinData bd);

Introduced in version 9.50.87

Get an attribute from the IFD Handler (reader driver).

The attr can be one of the following:

The attribute data is returned in bd.

Returns true for success, false for failure.

GetAttribStr

boolean GetAttribStr(String attr, CkString outStr);
String getAttribStr(String attr);

Introduced in version 9.50.87

Get a string typed attribute from the IFD Handler (reader driver).

The attr can be one of the following, but should be limited to the particular attributes that return string values.

Returns true for success, false for failure.

GetAttribUint

int GetAttribUint(String attr);

Introduced in version 9.50.87

Get an unsigned integer typed attribute from the IFD Handler (reader driver).

The attr can be one of the following, but should be limited to the particular attributes that return unsigned integer values.

Returns 0xFFFFFFFF on failure.

GetStatusChange

boolean GetStatusChange(int maxWaitMs, CkStringTable stReaderNames, CkJsonObject json);

Introduced in version 9.50.87

Blocks execution until the current availability of the cards in a specific set of readers changes.

This function receives a list of reader names in stReaderNames. It then blocks waiting for a change in state to occur for a maximum blocking time of maxWaitMs (in milliseconds) or forever if 0 is used.

Information about the current reader states and which reader(s) changed is returned in json. See the example below for more information.

To wait for a reader event (reader added or removed) you may use the special reader name "\\?PnP?\Notification".

To cancel the ongoing call, call Cancel().

The stReaderNames contains the reader names to check. The json is empty on input, and if the call returns success contains information about the state (after the event change) of each reader.

Returns true for success, false for failure.

More Information and Examples

(Android™) PC/SC Wait for Smart Card Status Change (Inserted, Removed from Reader, etc.)(Java) PC/SC Wait for Smart Card Status Change (Inserted, Removed from Reader, etc.)

GetStatusChangeAsync ^{(Android™) (Java)}

CkTask GetStatusChangeAsync(int maxWaitMs, CkStringTable stReaderNames, CkJsonObject json);

Introduced in version 9.50.87

Creates an asynchronous task to call the GetStatusChange method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

More Information and Examples

(Android™) PC/SC Async Wait for Smart Card Status Change (Inserted, Removed from Reader, etc.)(Java) PC/SC Async Wait for Smart Card Status Change (Inserted, Removed from Reader, etc.)

GetStatusChangeCancel

boolean GetStatusChangeCancel();

Introduced in version 9.50.87

Cancels an ongoing GetStatusChange method call. This would be called from a separate thread in your application if GetStatusChange was called synchronously.

Returns true for success, false for failure.

ListReaderGroups

boolean ListReaderGroups(CkStringTable readerGroups);

Introduced in version 9.50.87

Returns a list of currently available reader groups on the system. The reader groups are returned in readerGroups.

Returns true for success, false for failure.

ListReaders

boolean ListReaders(CkStringTable st);

Introduced in version 9.50.87

Returns a list of currently available readers on the system.

Returns true for success, false for failure.

More Information and Examples

(Android™) PC/SC List Smart Card Readers (and USB Tokens)(Java) PC/SC List Smart Card Readers (and USB Tokens)

Reconnect

boolean Reconnect(String shareMode, String preferredProtocol, String action);

Introduced in version 9.50.87

Reestablishes a connection to a reader that was previously connected to using Connect().

In a multi application environment it is possible for an application to reset the card in shared mode. When this occurs any other application trying to access certain commands will be returned the value SCARD_W_RESET_CARD. When this occurs Reconnect() must be called in order to acknowledge that the card was reset and allow it to change its state accordingly.

The shareMode can be "shared", "exclusive", or "direct". The preferredProtocol can be "0" (valid only if the shareMode = "direct"), "T0", "T1", "raw", or "no_preference". (No preference is effectively T0 or T1.) The action is the desired action taken on the card/reader. It can be "leave", "reset", "unpower", or "eject".

If successful, the state of this object instance is that it's connected to the reader.

Returns true for success, false for failure.

ReleaseContext

boolean ReleaseContext();

Introduced in version 9.50.87

Destroys a communication context to the PC/SC Resource Manager. This must be the last function called in a PC/SC application.

Returns true for success, false for failure.

SendControl

boolean SendControl(int controlCode, CkBinData bdSend, CkBinData bdRecv);

Introduced in version 9.50.87

Sends a command directly to the IFD Handler (reader driver) to be processed by the reader.

This is useful for creating client side reader drivers for functions like PIN pads, biometrics, or other extensions to the normal smart card reader that are not normally handled by PC/SC.

The command data is sent in bdSend. The response is written to bdRecv.

Returns true for success, false for failure.

SendControlHex

boolean SendControlHex(int controlCode, String sendData, CkBinData bdRecv);

Introduced in version 9.50.87

Sends a command directly to the IFD Handler (reader driver) to be processed by the reader.

This is useful for creating client side reader drivers for functions like PIN pads, biometrics, or other extensions to the normal smart card reader that are not normally handled by PC/SC.

The command data is provided as a hex string in sendData. The response is written to bdRecv.

Returns true for success, false for failure.

Transmit

boolean Transmit(String protocol, CkBinData bdSend, CkBinData bdRecv, int maxRecvLen);

Introduced in version 9.50.87

Sends an APDU to the smart card contained in the currently connected reader. The protocol can be "T0", "T1", or "raw". The APDU to be sent is contained in bdSend. The response from the card is contained in bdRecv. The maxRecvLen is the maximum response size (in bytes) willing to be accepted.

Returns true for success, false for failure.

TransmitHex

boolean TransmitHex(String protocol, String apduHex, CkBinData bdRecv, int maxRecvLen);

Introduced in version 9.50.87

Sends an APDU to the smart card contained in the currently connected reader. The protocol can be "T0", "T1", or "raw". The APDU (in hexadecimal) to be sent is passed in apduHex. The response from the card is contained in bdRecv. The maxRecvLen is the maximum response size (in bytes) willing to be accepted.

Returns true for success, false for failure.

Events

Chilkat supports event callbacks in Java (including Android) starting in version 9.5.0.52. To implement an event callback, your application would define and implement a class that derives from CkBaseProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkBaseProgress base class.

For example:

// Install an event callback handler to get progress events.
MyBaseProgress scardProgress = new MyBaseProgress();
http.put_EventCallbackObject(scardProgress);

MyBaseProgress example:

import com.chilkatsoft.CkBaseProgress;
import com.chilkatsoft.CkTask;

public class MyBaseProgress extends CkBaseProgress 
{	
  public boolean AbortCheck()
  {
    System.out.println("AbortCheck");
    // Return true to abort, false to allow the method to continue.
    return false;
  }
  	
  // pctDone is a value from 0 to 100
  // (it is actually value from 0 to the PercentDoneScale property setting)
  public boolean PercentDone(int pctDone)
  {
    System.out.println(pctDone);
    // Return true to abort, false to allow the method to continue.
    // Note: A PercentDone event is the equivalent of an AbortCheck.  
    // When PercentDone events are frequently firing, AbortCheck events are suppressed.
    // AbortCheck events will fire when the time between PercentDone events is longer 
    // than the HeartbeatMs property setting.
    return false;
  }
  
  public void ProgressInfo(String name, String value)
  {
    System.out.println(name + ": " + value);
  }
  
  public void TaskCompleted(CkTask task)
  {
     System.out.println("task completed!");
  }
  
}

AbortCheck

public boolean AbortCheck();

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200. Return true to abort; return false to continue (not abort)

PercentDone

public boolean PercentDone(int pctDone);

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

Return true to abort; return false to continue (not abort)

ProgressInfo

public void ProgressInfo(String name, String value);

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

TaskCompleted

public void TaskCompleted(CkTask task);

Called in the background thread when an asynchronous task completes.

top