Keyple Core

Version 1.0 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.

Features / packages and corresponding usages

The Keyple Core is a tool to handle smart card reader and to operate generic processing with smart cards.

The Core is divided in 3 sub-modules:

  • Service API : provides the interfaces to access to the smart card readers and to select a smart card.
  • Card API : for the transmission of APDU commands with a smart card.
  • Plugin API : includes the factorized processing for the implementation of plugin.
Serviceorg.eclipse.keyple.core.serviceManagement of the smart card readers
  • Registration of plugins to the smart card Service
  • Access to the readers through plugins
org.eclipse.keyple.core.service.eventNotifications of reader plug/unplug, of smart card insertion/removed
  • Define observers of plugins or readers
  • Interface to be implemented by observers to be notified on plugin event or reader event
  • For observable reader, setting of default selections, to automatically operate in case of smart card insertion
org.eclipse.keyple.core.service.utilCommunication protocols setting for contactless/contacts Reader
org.eclipse.keyple.card.selectionGeneric selection of a smart card
  • preparation of smart card selection requests
  • matching selection results as smart card images
Smart cardorg.eclipse.keyple.card.messageTransmission of grouped APDU commands to a Reader
org.eclipse.keyple.core.card.commandGeneric API to develop a smart card specific library
Reader plugins implementation
  • Utility classes providing generic processing for Readers

According to the developer’s objective different packages must be imported:

  • for the implementation of a smart card terminal application: the packages service, event and selection.
  • to develop a dedicated library supporting the command sets and transaction features of a specific smart card solution: the packages message, command, and selection.
  • to implement a plugin: the packages plugin, service, event, and message.
Core packages
Core packages

Service Interface - Reader Access

for the development of ticketing terminal application

Types of plugin & reader

On Keyple, the smart card readers are managed through plugins in order to integrate specific reader solutions. The SmartCard Service singleton provides the unique name list of registered plugins. There can be three kinds of plugin:

  • Plugin is the generic interface to list the readers of a plugin, or to access to a specific reader with its name.
  • The Observable Plugin interface extends Plugins which have the capability to be observed: in order to notify registered Plugin Observers about the plug or unplug of readers. Plugin Observers could be added or removed to the Observable Plugin. Useful for systems allowing the hot plug / unplug of Readers.
  • A Pool Plugin is a plugin for which a Reader is available only after an explicit allocation. When not more necessary, a Reader must be released. Useful for server solutions managing farms of Readers or interfaced with HSM: unallocated Readers or HSM instances could be shared between several smartcard terminal solutions.

A smartcard Reader is identified through its unique name in a Plugin. There are two kinds of Reader:

  • The Reader is the generic interface to handle a smartcard reader. The presence of card in a Reader could be checked.
  • The Observable Reader interface extends Readers which have the capability to notify registered Reader Observers about the insertion or remove of a Card in the Reader. Reader Observers could be added or removed to the Observable Reader. Useful for systems automatically starting the processing of a Card at its insertion: like a ticketing validator.
    [Reader Access v1.0.0
    [Reader Access v1.0.0

(The APDU transmission with a Card is managed at a lower layer, through a Card Solution API.)

Specific Plugin integration

The Plugins are registered to the SmartCard Service through related specific Plugin Factory.

Specific Plugin v1.0.0
Specific Plugin v1.0.0

Reader Notifications

To be notified about Plugin Event or Reader Event, a terminal application must implement the dedicated Plugin Observer or Reader Observer interfaces.

Reader Notifications v1.0.0
Reader Notifications v1.0.0

Plugin Event

Several Plugin Observers could be registered to an Observable Plugin. In case of reader connection / disconnection, the Observable Plugin notifies sequentially the registered Plugin Observers with the corresponding Plugin Event. The Observable Plugin is a blocking API, the thread managing the issuance of the Plugin Event waits the acknowledge of the Plugin Observer currently notified.

Reader Event

Several Reader Observers could be registered to an Observable Reader. In case of Card insertion / removal or selection match, the Observable Reader notifies sequentially the registered Reader Observers with the corresponding Reader Event. The Observable Reader could be a blocking API, the thread managing the issuance of the Plugin Event could wait the acknowledge of the notified Reader Observers.

An Observable Reader has the capability to be set with a Default Selections Request: in this case when a Card is inserted in the Reader, the Reader will try to operate the configured default selections. If a selection successfully matches with the Card, instead to simply notify about the insertion of a Card, the Observable Reader will notify about a successful selection with a Card application.

  • If the notification mode is defined as always, then in case of Card insertion, the Observable Reader will notify a matched card Reader Event in case of successful selection, or a simple card insertion Reader Event if not.
  • If the notification mode is defined as matched only, then in case of Card insertion, simple card insertion Reader Events are not notified.

When the processing of an inserted or matched Card is finished, a Reader Observer must release the logical channel with the Card, in order to prepare the Observable Reader to detect the removal of the Card.

Observable Reader states

An Observable Reader is active only when at least one Reader Observer is registered, and if the start of the detection has been requested. When active, an Observable Reader could switch between three internal states: Wait for Card Insertion, Wait for Card Processing, & Wait for Card Removal.

In the nominal case, a Reader Observer indicates to the Observable Reader that the processing of the SE is finished by releasing the Card Channel. To manage a failure of the Reader Observer process, the Observable Reader interface provides also a method to finalize the Card processing.

Observable Reader States
Observable Reader States

The states could be switched:

  • due to an explicit API request (blue arrows):
    • the release of the Card Channel,
    • the call of an Observable Reader method:
      • the addition or the remove of an Observable Reader,
      • a request to start or stop the detection, to finalize the Card processing.
  • Or because of an external event (red arrows), the insertion or the remove of a Card.
    • the insertion a Card causing the Observable Reader to notify a Card matched Reader Event (in case of successful default selection) or a Card inserted Reader Event (Notification Mode defined as always).
    • the removal of a Card causing the Observable Reader to notify a Card removed Reader Event.

If a Card detection is started with the repeating polling mode, then later when the Card is removed, the Reader starts again the detection of a new Card.

Whatever the Plugin of Observable Reader, when waiting for the Card removal, any Observable Reader shall have the capability to notify the remove of the Card. Some Plugin solutions could have the capability to notify a Card removal also during the processing of the Card.

Service Interface - Card Selection

for the development of ticketing terminal application

Selection scenarios

Depending on the Card transaction use case, or on the Reader capability, there are two ways to manage the Selection of a Card:

  • Either on a simple Reader, a Selection could be operated directly by transmitting the Selection Request. In this case the same entity manages both the Card Selection and the Card processing.
  • Otherwise, on an Observable Reader, a Default Selection could be defined. In this case the Selection is operated automatically at the insertion of the Card. In this case, the Card Selection is next managed by the Observable Reader, but the Card processing is managed by a Reader Observer.
Selection v1.0.0
Selection v1.0.0

Selection setting and processing

A Card Selection request is defined with a Card Selector. A Card Selector could be defined with tree optional levels of selection filter.

  • The selection could be limited to match a specific card communication protocol.
  • The Card ATR could be filtered to match a regular expression.
  • If an AID is defined, the local reader transmits a Select Application APDU command to the card. If a SE Selector is defined without any filter, the selection is always successful if a card is present in the reader.

Depending on the Keyple Card Solution extension library, a card request could be completed with specific card commands to operate at the selection (for example, a Select File for a specific DF LID, the read of a specific file).

For terminal managing several kinds of card applications, a Card Selection could be prepared with several card selection request to operate sequentially with the card.

According to the defined multi selection processing mode, the card selection could stop at the first selection request matching card application, otherwise all the prepared card selection request could be operated.

  • Before the new processing of card selection request, the logical channel previously opened is closed.
  • The channel control defines if the logical channel should be kept open or close after the last processed card selection request.
Card Selection v1.0.0
Card Selection v1.0.0

The result of a card request selection is a card image of a matching card. For a card selection with multiple requests, several matching card could be provided.

Card Interface

for the development of smartcard solution library

The Keyple Calypso extension uses the card interface to exchange APDU commands with Calypso cards and SAM.

APDU Transmission

APDU Transmission v1.0.0
APDU Transmission v1.0.0

Plugin API

for the implementation of smartcard reader plugins

Plugin Factorized Processing

The implementation of Plugins requires to extend the classes AbstractPlugin and AbstractLocalReader.

  • If the reader solution allows the hot plug/unplug of readers then AbstractThreadedObservablePlugin should be extended.
  • In case the local reader has the capability to detect the insertion or the removal or a card, then AbstractObservableLocalReader should be extended.

For reader solutions managing themselves the allocation of logical channel for communicatio with smart cards, the interface SmartSelectionReader should be implemented (e.g. it is the case for the OMAPI plugin).

Only the abstract methods highlighted in blue have to be implemented have to be implemented by the specific plugins.

For plugins with ObservableReader: depending on the capability of the reader solution different interfaces could be implemented:

  • WaitForCardInsertionAutonomous
  • WaitForCardRemovalAutonomous
  • WaitForCardRemovalDuringProcessing or DontWaitForCardRemovalDuringProcessing
  • WaitForCardInsertionBlocking or WaitForCardInsertionNonBlocking
  • WaitForCardRemovalBlocking or WaitForCardRemovalNonBlocking
  • AbstractObservableLocalAutonomousReader
Plugin Factorized Processing v1.0.0
Plugin Factorized Processing v1.0.0