be.fedict.commons.eid.client.spi

Class BeIDCardUIAdapter

java.lang.Object

be.fedict.commons.eid.client.spi.BeIDCardUIAdapter

All Implemented Interfaces:

BeIDCardUI

public class BeIDCardUIAdapter
extends Object
implements BeIDCardUI

An adapter implementing BeIDCardUI with empty default actions. Intended to be extended by a useful class overriding only those methods it requires. For example, in an embedded application having only a secure PINPAD reader, none of the obtain() methods would ever be called.

Author:

Frank Marien

Field Summary

Fields

Modifier and Type	Field	Description
protected Locale	locale

Constructor Summary

Constructors

Constructor	Description
BeIDCardUIAdapter()

Method Summary

Modifier and Type	Method	Description
void	advisePINBlocked()	too many tries.
void	advisePINChanged()	PIN was changed successfully
void	advisePINPadChangePIN(int retriesLeft)	user can change PIN (old, new, new-again) on PIN Pad
void	advisePINPadNewPINEntry(int retriesLeft)	user can enter new PIN on PINPad
void	advisePINPadNewPINEntryAgain(int retriesLeft)	user can enter new PIN on PINPad again
void	advisePINPadOldPINEntry(int retriesLeft)	user can enter old PIN on PINPad
void	advisePINPadOperationEnd()	one of the above PINPad operation ends
void	advisePINPadPINEntry(int retriesLeft, PINPurpose purpose, String applicationName)	user can enter PIN on Secure PINPad
void	advisePINPadPUKEntry(int retriesLeft)	user can enter PUK on PINPad
void	advisePINUnblocked()	PIN unblock operation was successful.
void	adviseSecureReaderOperation()	user needs to attend some operation on a secure reader (more instuctions are available from the reader's own user interface)
void	adviseSecureReaderOperationEnd()	operation on secure reader ends
Locale	getLocale()	get the Locale currently set.
char[][]	obtainOldAndNewPIN(int triesLeft)	get Old and New PIN from the user.
char[]	obtainPIN(int triesLeft, PINPurpose type, String applicationName)	get PIN from the user
char[][]	obtainPUKCodes(int triesLeft)	get PUK Codes from the user (PIN unblock)
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

BeIDCardUIAdapter

public BeIDCardUIAdapter()

Method Detail

obtainPIN

public char[] obtainPIN(int triesLeft,
                        PINPurpose type,
                        String applicationName)
                 throws UserCancelledException

Description copied from interface: BeIDCardUI

get PIN from the user

Specified by:

obtainPIN in interface BeIDCardUI

Parameters:

triesLeft - the number of attempts left before the PIN is blocked.

type - the reason why the PIN code is requested

applicationName - the optional application name.

Returns:

the PIN code.

Throws:

UserCancelledException - thrown in case the user cancels the PIN entry.

obtainOldAndNewPIN

public char[][] obtainOldAndNewPIN(int triesLeft)

Description copied from interface: BeIDCardUI

get Old and New PIN from the user. (pin change)

Specified by:

obtainOldAndNewPIN in interface BeIDCardUI

Parameters:

triesLeft - the number of attempts left before the PIN is blocked.

Returns:

old and new PIN codes

obtainPUKCodes

public char[][] obtainPUKCodes(int triesLeft)

Description copied from interface: BeIDCardUI

get PUK Codes from the user (PIN unblock)

Specified by:

obtainPUKCodes in interface BeIDCardUI

Parameters:

triesLeft - the number of attempts left before the card is blocked.

Returns:

PUK1 and PUK2 codes

advisePINChanged

public void advisePINChanged()

Description copied from interface: BeIDCardUI

PIN was changed successfully

Specified by:

advisePINChanged in interface BeIDCardUI

advisePINBlocked

public void advisePINBlocked()

Description copied from interface: BeIDCardUI

too many tries. PIN now blocked

Specified by:

advisePINBlocked in interface BeIDCardUI

advisePINUnblocked

public void advisePINUnblocked()

Description copied from interface: BeIDCardUI

PIN unblock operation was successful.

Specified by:

advisePINUnblocked in interface BeIDCardUI

advisePINPadPINEntry

public void advisePINPadPINEntry(int retriesLeft,
                                 PINPurpose purpose,
                                 String applicationName)

Description copied from interface: BeIDCardUI

user can enter PIN on Secure PINPad

Specified by:

advisePINPadPINEntry in interface BeIDCardUI

Parameters:

retriesLeft - the number of attempts left before the PIN is blocked.

purpose - the reason why the PIN code is requested

applicationName - the optional application name.

advisePINPadPUKEntry

public void advisePINPadPUKEntry(int retriesLeft)

Description copied from interface: BeIDCardUI

user can enter PUK on PINPad

Specified by:

advisePINPadPUKEntry in interface BeIDCardUI

Parameters:

retriesLeft - the number of attempts left before the card is blocked.

advisePINPadChangePIN

public void advisePINPadChangePIN(int retriesLeft)

Description copied from interface: BeIDCardUI

user can change PIN (old, new, new-again) on PIN Pad

Specified by:

advisePINPadChangePIN in interface BeIDCardUI

Parameters:

retriesLeft - the number of attempts left before the PIN is blocked.

advisePINPadOldPINEntry

public void advisePINPadOldPINEntry(int retriesLeft)

Description copied from interface: BeIDCardUI

user can enter old PIN on PINPad

Specified by:

advisePINPadOldPINEntry in interface BeIDCardUI

Parameters:

retriesLeft - the number of attempts left before the PIN is blocked.

advisePINPadNewPINEntry

public void advisePINPadNewPINEntry(int retriesLeft)

Description copied from interface: BeIDCardUI

user can enter new PIN on PINPad

Specified by:

advisePINPadNewPINEntry in interface BeIDCardUI

Parameters:

retriesLeft - the number of attempts left before the PIN is blocked.

advisePINPadNewPINEntryAgain

public void advisePINPadNewPINEntryAgain(int retriesLeft)

Description copied from interface: BeIDCardUI

user can enter new PIN on PINPad again

Specified by:

advisePINPadNewPINEntryAgain in interface BeIDCardUI

Parameters:

retriesLeft - the number of attempts left before the PIN is blocked.

advisePINPadOperationEnd

public void advisePINPadOperationEnd()

Description copied from interface: BeIDCardUI

one of the above PINPad operation ends

Specified by:

advisePINPadOperationEnd in interface BeIDCardUI

adviseSecureReaderOperation

public void adviseSecureReaderOperation()

Description copied from interface: BeIDCardUI

user needs to attend some operation on a secure reader (more instuctions are available from the reader's own user interface)

Specified by:

adviseSecureReaderOperation in interface BeIDCardUI

adviseSecureReaderOperationEnd

public void adviseSecureReaderOperationEnd()

Description copied from interface: BeIDCardUI

operation on secure reader ends

Specified by:

adviseSecureReaderOperationEnd in interface BeIDCardUI

setLocale

public void setLocale(Locale newLocale)

Description copied from interface: BeIDCardUI

set Locale for subsequent operations. Implementations MUST ensure that after this call, any of the other 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 BeIDCardUI

getLocale

public Locale getLocale()

Description copied from interface: BeIDCardUI

get the Locale currently set.

Specified by:

getLocale in interface BeIDCardUI

Returns:

the current Locale for this UI