Sample code for 30+ languages & platforms
Java

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

See more SCard Examples

Demonstrates how to synchronously wait for a status change, such as for a smart card to be inserted into a reader, or removed from a reader.

Note: This functionality was introduced in Chilkat v9.5.0.87.

Chilkat Java Downloads

Chilkat2 Java
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.SCard;
import com.chilkatsoft.chilkat2.StringBuilder;
import com.chilkatsoft.chilkat2.StringTable;

public class ChilkatExample {

    public static void main(String[] args) {
        // This example requires the Chilkat API to have been previously unlocked.
        // See Global Unlock Sample for sample code.

        SCard scard = new SCard();

        // First establish a context to the PC/SC Resource Manager
        try {
            scard.establishContext("user");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // First we'll examine the state of all connected readers to see which have smartcards already inserted..
        // Get JSON containing information about the smartcards currently inserted into readers.
        // This also includes information about USB security tokens.
        JsonObject json = new JsonObject();
        try {
            scard.findSmartcards(json);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // When writing this example, I have 3 smart card readers plugged into my system.
        // One of them has a smart card inserted.
        // Here's the JSON returned by FindSmartcards...

        // {
        //   "reader": [
        //     {
        //       "name": "Alcor Micro USB Smart Card Reader 0",
        //       "state": "empty"
        //     },
        //     {
        //       "name": "Generic Smart Card Reader Interface 0",
        //       "state": "present",
        //       "vendorName": "Generic",
        //       "serialNumber": "3230303730383138303030303030303030",
        //       "systemName": "Generic Smart Card Reader Interface 0",
        //       "card": {
        //         "atr": "3BFC180000813180459067464A00641606F2727E00E0",
        //         "windows": {
        //           "miniDriver": "tagliov70px.dll",
        //           "cryptoProvider": "Microsoft Base Smart Card Crypto Provider",
        //           "keyStorageProvider": "Microsoft Smart Card Key Storage Provider"
        //         }
        //       }
        //     },
        //     {
        //       "name": "SCM Microsystems Inc. SCR33x USB Smart Card Reader 0",
        //       "state": "empty"
        //     }
        //   ]
        // }

        json.setEmitCompact(false);
        System.out.println(json.emit());
        System.out.println(" ");

        // We can iterate over the JSON to find the readers with a smart card already inserted..
        String name = "";
        StringBuilder sbState = new StringBuilder();

        int i = 0;
        int count_i = json.sizeOfArray("reader");
        while (i < count_i) {
            json.setI(i);
            name = json.stringOf("reader[i].name");

            sbState.clear();
            json.stringOfSb("reader[i].state", sbState);

            if (sbState.contains("present", true)) {
                System.out.println(name + " has a smart card inserted.");
            } else {
                System.out.println(name + " does not have a smart card inserted.");
            }

            i = i + 1;
        }

        System.out.println(" ");

        // Now let's begin the code to wait for a change (where a smart card gets inserted or removed)

        // Get the list of all readers.
        StringTable stReaders = new StringTable();
        try {
            scard.listReaders(stReaders);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Show the reader names..
        int numReaders = stReaders.getCount();
        i = 0;
        while (i < numReaders) {
            System.out.println(i + ": " + stReaders.stringAt(i));
            i = i + 1;
        }

        // Sample output from the above loop.
        // 0: Alcor Micro USB Smart Card Reader 0
        // 1: Generic Smart Card Reader Interface 0
        // 2: SCM Microsystems Inc. SCR33x USB Smart Card Reader 0
        //

        // Synchronously wait 30 seconds for a card to be inserted or removed from any of the above readers.
        JsonObject json2 = new JsonObject();
        try {
            scard.getStatusChange(30000, stReaders, json2);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        System.out.println(" ");

        // Let's see what happened...
        json2.setEmitCompact(false);
        System.out.println(json2.emit());
        System.out.println(" ");

        // This is what json2 contains.
        // A card was inserted into the reader named "SCM Microsystems Inc. SCR33x USB Smart Card Reader 0"
        // The "numChanged" indicates that one reader's status changed.
        // The "changed":true indicates the reader that changed.   The state is now "present".

        // {
        //   "numChanged": 1,
        //   "reader": [
        //     {
        //       "name": "Alcor Micro USB Smart Card Reader 0",
        //       "changed": false,
        //       "state": "empty"
        //     },
        //     {
        //       "name": "Generic Smart Card Reader Interface 0",
        //       "changed": false,
        //       "state": "present",
        //       "atr": "3BFC180000813180459067464A00641606F2727E00E0"
        //     },
        //     {
        //       "name": "SCM Microsystems Inc. SCR33x USB Smart Card Reader 0",
        //       "changed": true,
        //       "state": "present",
        //       "atr": "3BDF96FF8131FE455A018048494443313158587300011B09"
        //     }
        //   ]
        // }

        // Find the reader that changed...
        boolean changed = false;
        String state = "";
        String atr = "";

        int numChanged = json2.intOf("numChanged");
        System.out.println("number of readers with a changed state: " + numChanged);

        i = 0;
        count_i = json2.sizeOfArray("reader");
        while (i < count_i) {
            json2.setI(i);
            changed = json2.boolOf("reader[i].changed");
            if (changed) {
                name = json2.stringOf("reader[i].name");
                state = json2.stringOf("reader[i].state");

                System.out.println("Changed: ");
                System.out.println("    reader name: " + name);
                System.out.println("    new state: " + state);

                // If a card is now in this reader, we should have the ATR of the card..
                if (json2.hasMember("reader[i].atr")) {
                    atr = json2.stringOf("reader[i].atr");
                    System.out.println("    ATR of card inserted into this reader: " + atr);
                }
            }

            i = i + 1;
        }

        // The output from the above loop:

        // number of readers with a changed state: 1
        // Changed:
        //     reader name: SCM Microsystems Inc. SCR33x USB Smart Card Reader 0
        //     new state: present
        //     ATR of card inserted into this reader: 3BDF96FF8131FE455A018048494443313158587300011B09

        // Applications should always release the context when finished.
        try {
            scard.releaseContext();
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
        }
    }
}