be.fedict.commons.eid.client.spi

Class BeIDCardsIUAdapter

java.lang.Object

be.fedict.commons.eid.client.spi.BeIDCardsIUAdapter

All Implemented Interfaces:

BeIDCardsUI

public class BeIDCardsIUAdapter
extends Object
implements BeIDCardsUI

An adapter implementing empty or simple implementations of the BeIDCardsUI interface. Intended to be extended by a useful class without having to implement unused methods. For example, in an embedded application where only one card reader is possible, only adviseBeIDCardRequired() and adviseEnd() would ever be called.

Author:

Frank Marien

Field Summary

Fields

Modifier and Type	Field and Description
protected Locale	locale

Constructor Summary

Constructors

Constructor and Description
BeIDCardsIUAdapter()

Method Summary

Modifier and Type	Method and Description
void	adviseBeIDCardRemovalRequired() The user needs to remove a BeID Card for security reasons.
void	adviseBeIDCardRequired() The user needs to insert a BeID Card.
void	adviseCardTerminalRequired() The user needs to connect a Card Terminal, since there are none
void	adviseEnd() No more user actions are required, at this point.
void	eIDCardInsertedDuringSelection(BeIDCard card) user added a BeID card while selectBeIDCard() was blocking.
void	eIDCardRemovedDuringSelection(BeIDCard card) user removed a BeID card while selectBeIDCard() was blocking.
Locale	getLocale() get the Locale currently set.
BeIDCard	selectBeIDCard(Collection<BeIDCard> availableCards) user has multiple eID Cards inserted and needs to choose exactly one. throws CancelledException if user cancels throws OutOfCardsException if all cards removed before selection could be made.
void	setLocale(Locale newLocale) set Locale for subsequent operations.

Methods inherited from class java.lang.Object

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

Field Detail

locale

protected Locale locale

Constructor Detail

BeIDCardsIUAdapter

public BeIDCardsIUAdapter()

Method Detail

adviseCardTerminalRequired

public void adviseCardTerminalRequired()

Description copied from interface: BeIDCardsUI

The user needs to connect a Card Terminal, since there are none

Specified by:

adviseCardTerminalRequired in interface BeIDCardsUI

adviseBeIDCardRequired

public void adviseBeIDCardRequired()

Description copied from interface: BeIDCardsUI

The user needs to insert a BeID Card. There are card terminals, but none currently holds a BeID card.

Specified by:

adviseBeIDCardRequired in interface BeIDCardsUI

adviseBeIDCardRemovalRequired

public void adviseBeIDCardRemovalRequired()

Description copied from interface: BeIDCardsUI

The user needs to remove a BeID Card for security reasons.

Specified by:

adviseBeIDCardRemovalRequired in interface BeIDCardsUI

selectBeIDCard

public BeIDCard selectBeIDCard(Collection<BeIDCard> availableCards)

Description copied from interface: BeIDCardsUI

user has multiple eID Cards inserted and needs to choose exactly one. throws CancelledException if user cancels throws OutOfCardsException if all cards removed before selection could be made.

Specified by:

selectBeIDCard in interface BeIDCardsUI

Returns:

eIDCardInsertedDuringSelection

public void eIDCardInsertedDuringSelection(BeIDCard card)

Description copied from interface: BeIDCardsUI

user added a BeID card while selectBeIDCard() was blocking. An implementation should update the list of cards, if possible.

Specified by:

eIDCardInsertedDuringSelection in interface BeIDCardsUI

Parameters:

card - the card just inserted.

eIDCardRemovedDuringSelection

public void eIDCardRemovedDuringSelection(BeIDCard card)

Description copied from interface: BeIDCardsUI

user removed a BeID card while selectBeIDCard() was blocking. An implementation should update the list of cards, if possible.

Specified by:

eIDCardRemovedDuringSelection in interface BeIDCardsUI

Parameters:

card - the card just removed.

adviseEnd

public void adviseEnd()

Description copied from interface: BeIDCardsUI

No more user actions are required, at this point.

Specified by:

adviseEnd in interface BeIDCardsUI

setLocale

public void setLocale(Locale newLocale)

Description copied from interface: BeIDCardsUI

set Locale for subsequent operations. Implementations MUST ensure that after this call, any of the obtainXXX and adviseXXX methods for the same instance respect the locale set here. Implementations MAY choose to update any interface elements already facing the user at time of call, but this is not required.

Specified by:

setLocale in interface BeIDCardsUI

getLocale

public Locale getLocale()

Description copied from interface: BeIDCardsUI

get the Locale currently set.

Specified by:

getLocale in interface BeIDCardsUI

Returns:

the current Locale for this UI