Keyple Plugin Android NFC Java Lib

This document specifies the API dedicated to the integration of the Android NFC plugin in an Android Keyple application.

The Android NFC plugin requires the use of the Keyple observation pattern at the reader level to handle card insertion and removal events.
Unlike other reader implementations, Android NFC does not support continuous polling for card presence (e.g., isCardPresent()). Instead, it relies entirely on Android’s event-driven model.

To properly detect card presence and handle interactions, it is mandatory to cast Reader objects as ObservableReader and implement the appropriate interfaces from the Keyple Service SPI package.

Since NFC events are managed asynchronously by the Android system, working without observation is not possible in this context. Any integration of the Android NFC plugin must therefore be designed around this event-driven approach.

Configuration & Instantiation

To create an instance of the plugin, use the AndroidNfcPluginFactoryProvider which requires an AndroidNfcConfig object.

Storage Card Support

To support storage cards (such as Mifare Classic, Mifare Ultralight, etc.), the plugin relies on the keyple-plugin-storagecard-java-api. An implementation of ApduInterpreterFactory must be provided via the AndroidNfcConfig.apduInterpreterFactory property.

This factory is responsible for creating the interpreter that translates standard APDU commands into specific Android NFC I/O operations (e.g. using MifareClassic or MifareUltralight Android tech classes).

Copyright © Eclipse Foundation, Inc. All Rights Reserved.