be.fedict.commons.eid.client.spi

Interface BeIDCardUI

All Known Implementing Classes:

BeIDCardUIAdapter

public interface BeIDCardUI

Implement a BeIDCardUI to interact with the user from a BeIDCard instance.

Author:

Frank Marien

Method Summary

Modifier and Type	Method and 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 type, 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.

Method Detail

setLocale

void setLocale(Locale newLocale)

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.

Parameters:

newLocale -

getLocale

Locale getLocale()

get the Locale currently set.

Returns:

the current Locale for this UI

obtainPIN

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

get PIN from the user

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

char[][] obtainOldAndNewPIN(int triesLeft)

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

Parameters:

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

Returns:

old and new PIN codes

obtainPUKCodes

char[][] obtainPUKCodes(int triesLeft)

get PUK Codes from the user (PIN unblock)

Parameters:

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

Returns:

PUK1 and PUK2 codes

advisePINChanged

void advisePINChanged()

PIN was changed successfully

advisePINBlocked

void advisePINBlocked()

too many tries. PIN now blocked

advisePINUnblocked

void advisePINUnblocked()

PIN unblock operation was successful.

advisePINPadPINEntry

void advisePINPadPINEntry(int retriesLeft,
                          PINPurpose type,
                          String applicationName)

user can enter PIN on Secure PINPad

Parameters:

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

type - the reason why the PIN code is requested

applicationName - the optional application name.

advisePINPadPUKEntry

void advisePINPadPUKEntry(int retriesLeft)

user can enter PUK on PINPad

Parameters:

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

advisePINPadChangePIN

void advisePINPadChangePIN(int retriesLeft)

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

Parameters:

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

advisePINPadOldPINEntry

void advisePINPadOldPINEntry(int retriesLeft)

user can enter old PIN on PINPad

Parameters:

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

advisePINPadNewPINEntry

void advisePINPadNewPINEntry(int retriesLeft)

user can enter new PIN on PINPad

Parameters:

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

advisePINPadNewPINEntryAgain

void advisePINPadNewPINEntryAgain(int retriesLeft)

user can enter new PIN on PINPad again

Parameters:

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

advisePINPadOperationEnd

void advisePINPadOperationEnd()

one of the above PINPad operation ends

adviseSecureReaderOperation

void adviseSecureReaderOperation()

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

adviseSecureReaderOperationEnd

void adviseSecureReaderOperationEnd()

operation on secure reader ends