be.fedict.commons.eid.client

Class BeIDCardManager

java.lang.Object

be.fedict.commons.eid.client.BeIDCardManager

public class BeIDCardManager
extends Object

A BeIDCardManager uses a CardAndTerminalManager to detect Card Insertion and Removal Events, distinguishes between Belgian eID and other cards, calls any registered BeIDCardEventsListeners for eID cards inserted and removed, and any registered CardEventsListener for other cards being inserted and removed. Note that by default, a BeIDCardManager will only connect to cards using card protocol "T=0" to ensure optimal compatibility with Belgian eID cards in all card readers, meaning that if you wish to use its "other card" facility you may have to supply your own CardAndTerminalManager with a protocol setting of "ALL".

Author:

Frank Marien, Frank Cornelis

Constructor Summary

Constructors

Constructor	Description
BeIDCardManager()	Instantiate a BeIDCardManager with a default (void) logger and a private CardAndTerminalManager that is automatically started and stopped with the BeIDCardManager, and that only connects to Cards with Protocol T=0
BeIDCardManager(CardAndTerminalManager cardAndTerminalManager)	Instantiate a BeIDCardManager with a default (void) logger, caller supplies a CardAndTerminalManager. note: caller is responsible for start()in the supplied CardAndTerminalManager, it will not be automatically started.
BeIDCardManager(Logger logger)	Instantiate BeIDCardManager logging to logger, and a private CardAndTerminalManager that is automatically started and stopped with the BeIDCardManager, and that only connects to Cards with Protocol T=0.
BeIDCardManager(Logger logger, CardAndTerminalManager cardAndTerminalManager)	Instantiate a BeIDCardManager logging to logger, caller supplies a CardAndTerminalManager. note: caller is responsible for start()in the supplied CardAndTerminalManager, it will not be automatically started!
BeIDCardManager(Logger logger, CardAndTerminalManager cardAndTerminalManager, boolean terminalManagerIsPrivate)

Method Summary

Modifier and Type	Method	Description
BeIDCardManager	addBeIDCardEventListener(BeIDCardEventsListener listener)	add a BeIDCardEventsListener to be notified of BeID cards being inserted and removed.
BeIDCardManager	addOtherCardEventListener(CardEventsListener listener)	add a CardEventsListener to be notified of non-BeID cards being inserted and removed.
Locale	getLocale()
static boolean	matches18ATR(javax.smartcardio.ATR atr)	Returns true for Belpic applet version 1.8 eID cards.
void	refreshCards()	Refreshes the cached BeIDCards, and replaces any instances that are in an unusable state (SCARD_W_RESET_CARD).
BeIDCardManager	removeBeIDCardListener(BeIDCardEventsListener listener)	remove a BeIDCardEventsListener from being notified of BeID cards being inserted and removed.
BeIDCardManager	removeOtherCardEventListener(CardEventsListener listener)	remove a CardEventsListener from being notified of non-BeID cards being inserted and removed.
BeIDCardManager	setLocale(Locale newLocale)
BeIDCardManager	start()	Starts this BeIDCardManager.
BeIDCardManager	stop()	Stops this BeIDCardManager.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BeIDCardManager

public BeIDCardManager()

Instantiate a BeIDCardManager with a default (void) logger and a private CardAndTerminalManager that is automatically started and stopped with the BeIDCardManager, and that only connects to Cards with Protocol T=0

BeIDCardManager

public BeIDCardManager(Logger logger)

Instantiate BeIDCardManager logging to logger, and a private CardAndTerminalManager that is automatically started and stopped with the BeIDCardManager, and that only connects to Cards with Protocol T=0.

Parameters:

logger - an instance of be.fedict.commons.eid.spi.Logger that will be send all the logs

BeIDCardManager

public BeIDCardManager(CardAndTerminalManager cardAndTerminalManager)

Instantiate a BeIDCardManager with a default (void) logger, caller supplies a CardAndTerminalManager. note: caller is responsible for start()in the supplied CardAndTerminalManager, it will not be automatically started. The supplied CardAndTerminalManager should allow protocol T0 ("T=0") or ANY ("*") for BeIDCards to work.

Parameters:

cardAndTerminalManager - the CardAndTerminalManager to use

BeIDCardManager

public BeIDCardManager(Logger logger,
                       CardAndTerminalManager cardAndTerminalManager)

Instantiate a BeIDCardManager logging to logger, caller supplies a CardAndTerminalManager. note: caller is responsible for start()in the supplied CardAndTerminalManager, it will not be automatically started!

Parameters:

logger - an instance of be.fedict.commons.eid.spi.Logger that will be send all the logs

cardAndTerminalManager - the CardAndTerminalManager to use

BeIDCardManager

public BeIDCardManager(Logger logger,
                       CardAndTerminalManager cardAndTerminalManager,
                       boolean terminalManagerIsPrivate)

Method Detail

start

public BeIDCardManager start()

Starts this BeIDCardManager. If no CardAndTerminalManager was given at construction, this will start our private CardAndTerminalManager. After this, any registered listeners will start receiving their designated events, including the existing state. If a CardAndTerminalManager was given at construction, this has no effect.

Returns:

this BeIDCardManager to allow for method chaining

addBeIDCardEventListener

public BeIDCardManager addBeIDCardEventListener(BeIDCardEventsListener listener)

add a BeIDCardEventsListener to be notified of BeID cards being inserted and removed.

Parameters:

listener - the BeIDCardEventsListener to notify about BeID card insertions and removals

Returns:

this BeIDCardManager to allow for method chaining

removeBeIDCardListener

public BeIDCardManager removeBeIDCardListener(BeIDCardEventsListener listener)

remove a BeIDCardEventsListener from being notified of BeID cards being inserted and removed.

Parameters:

listener - the BeIDCardEventsListener stop notifying about BeID card insertions and removals

Returns:

this BeIDCardManager to allow for method chaining

addOtherCardEventListener

public BeIDCardManager addOtherCardEventListener(CardEventsListener listener)

add a CardEventsListener to be notified of non-BeID cards being inserted and removed. Note that this is the same interface as in CardAndTerminalManager.addCardListener(CardEventsListener) with one notable semantic difference: a BeIDCardManager will call its CardEventsListeners only for non-eID cards, while a CardAndTerminalManager will call them for all card events: If you instantiate your own CardAndTerminalManager and supply it to a BeIDCardManager, you will get 2 card insert events if you register your BeIDCardEventsListerer to the BeIDCardManager and your CardEventsListeners to the CardAndTerminalManager: Register both with the BeIDCardManager to avoid this.

Parameters:

listener - the CardEventsListener to notify about non-BeID card insertions and removals.

Returns:

this BeIDCardManager to allow for method chaining

removeOtherCardEventListener

public BeIDCardManager removeOtherCardEventListener(CardEventsListener listener)

remove a CardEventsListener from being notified of non-BeID cards being inserted and removed.

Parameters:

listener - the CardEventsListener to stop notifying about non-BeID card insertions and removals

Returns:

this BeIDCardManager to allow for method chaining

stop

public BeIDCardManager stop()
                     throws InterruptedException

Stops this BeIDCardManager. If no CardAndTerminalManager was given at construction, this will stop our private CardAndTerminalManager. After this, no registered listeners will receive any more events. If a CardAndTerminalManager was given at construction, this has no effect.

Returns:

this BeIDCardManager to allow for method chaining

Throws:

InterruptedException

matches18ATR

public static boolean matches18ATR(javax.smartcardio.ATR atr)

Returns true for Belpic applet version 1.8 eID cards.

Parameters:

atr -

Returns:

setLocale

public BeIDCardManager setLocale(Locale newLocale)

getLocale

public Locale getLocale()

refreshCards

public void refreshCards()

Refreshes the cached BeIDCards, and replaces any instances that are in an unusable state (SCARD_W_RESET_CARD).