SCard Java Reference Documentation
CkSCard
Current Version: 11.1.0
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
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
This is the Current ATR of a card in the connected reader.
topConnectedReader
The name of the currently connected smart card reader, or an empty string if not connected.
topContext
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
String debugLogFilePath();
void put_DebugLogFilePath(String newVal);
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
LastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
void put_LastMethodSuccess(boolean newVal);
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.
PcscLibPath
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.
topReaderStatus
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
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
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
Methods
BeginTransaction
Establishes a temporary exclusive access mode for doing a series of commands in a transaction.
Returns true for success, false for failure.
topCheckStatus
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.
Connect
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.
Disconnect
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.
EndTransaction
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.
topEstablishContext
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.
topFindSmartcards
Returns JSON containing information about the smartcards currently inserted into readers.
Returns true for success, false for failure.
GetAttrib
Get an attribute from the IFD Handler (reader driver).
The attr can be one of the following:
ASYNC_PROTOCOL_TYPESATR_STRINGCHANNEL_IDCHARACTERISTICSCURRENT_BWTCURRENT_CLKCURRENT_CWTCURRENT_DCURRENT_EBC_ENCODINGCURRENT_FCURRENT_IFSCCURRENT_IFSDCURRENT_IO_STATECURRENT_NCURRENT_PROTOCOL_TYPECURRENT_WDEFAULT_CLKDEFAULT_DATA_RATEDEVICE_FRIENDLY_NAMEDEVICE_IN_USEDEVICE_SYSTEM_NAMEDEVICE_UNITESC_AUTHREQUESTESC_CANCELESC_RESETEXTENDED_BWTICC_INTERFACE_STATUSICC_PRESENCEICC_TYPE_PER_ATRMAX_CLKMAX_DATA_RATEMAX_IFSDMAXINPUTPOWER_MGMT_SUPPORTSUPRESS_T1_IFS_REQUESTSYNC_PROTOCOL_TYPESUSER_AUTH_INPUT_DEVICEUSER_TO_CARD_AUTH_DEVICEVENDOR_IFD_SERIAL_NOVENDOR_IFD_TYPEVENDOR_IFD_VERSIONVENDOR_NAME
The attribute data is returned in bd.
Returns true for success, false for failure.
topGetAttribStr
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.
ASYNC_PROTOCOL_TYPESATR_STRINGCHANNEL_IDCHARACTERISTICSCURRENT_BWTCURRENT_CLKCURRENT_CWTCURRENT_DCURRENT_EBC_ENCODINGCURRENT_FCURRENT_IFSCCURRENT_IFSDCURRENT_IO_STATECURRENT_NCURRENT_PROTOCOL_TYPECURRENT_WDEFAULT_CLKDEFAULT_DATA_RATEDEVICE_FRIENDLY_NAMEDEVICE_IN_USEDEVICE_SYSTEM_NAMEDEVICE_UNITESC_AUTHREQUESTESC_CANCELESC_RESETEXTENDED_BWTICC_INTERFACE_STATUSICC_PRESENCEICC_TYPE_PER_ATRMAX_CLKMAX_DATA_RATEMAX_IFSDMAXINPUTPOWER_MGMT_SUPPORTSUPRESS_T1_IFS_REQUESTSYNC_PROTOCOL_TYPESUSER_AUTH_INPUT_DEVICEUSER_TO_CARD_AUTH_DEVICEVENDOR_IFD_SERIAL_NOVENDOR_IFD_TYPEVENDOR_IFD_VERSIONVENDOR_NAME
Returns true for success, false for failure.
topGetAttribUint
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.
ASYNC_PROTOCOL_TYPESATR_STRINGCHANNEL_IDCHARACTERISTICSCURRENT_BWTCURRENT_CLKCURRENT_CWTCURRENT_DCURRENT_EBC_ENCODINGCURRENT_FCURRENT_IFSCCURRENT_IFSDCURRENT_IO_STATECURRENT_NCURRENT_PROTOCOL_TYPECURRENT_WDEFAULT_CLKDEFAULT_DATA_RATEDEVICE_FRIENDLY_NAMEDEVICE_IN_USEDEVICE_SYSTEM_NAMEDEVICE_UNITESC_AUTHREQUESTESC_CANCELESC_RESETEXTENDED_BWTICC_INTERFACE_STATUSICC_PRESENCEICC_TYPE_PER_ATRMAX_CLKMAX_DATA_RATEMAX_IFSDMAXINPUTPOWER_MGMT_SUPPORTSUPRESS_T1_IFS_REQUESTSYNC_PROTOCOL_TYPESUSER_AUTH_INPUT_DEVICEUSER_TO_CARD_AUTH_DEVICEVENDOR_IFD_SERIAL_NOVENDOR_IFD_TYPEVENDOR_IFD_VERSIONVENDOR_NAME
Returns 0xFFFFFFFF on failure.
topGetStatusChange
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.
GetStatusChangeAsync (Android™) (Java)
Creates an asynchronous task to call the GetStatusChange method with the arguments provided.
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
GetStatusChangeCancel
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.
topListReaderGroups
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.
topListReaders
Returns a list of currently available readers on the system.
Returns true for success, false for failure.
Reconnect
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.
topReleaseContext
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.
topSendControl
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.
topSendControlHex
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.
topTransmit
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.
topTransmitHex
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.
topEvents
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
Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second. Return true to abort; return false to continue (not abort)
PercentDone
This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).
The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.
Return true to abort; return false to continue (not abort)
ProgressInfo
This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.
TaskCompleted
Called from the background thread when an asynchronous task completes.