de.gematik.ti.cardreader.provider.api

Interface ICardReader

public interface ICardReader

The physical card reader is represented by a class implementing ICardReader interface. This class handles card reader’s initialisation status and card.

Class diagram 1: ICardReader

Method Summary

Modifier and Type	Method and Description
ICard	connect() Establishes a connection to the card.
default java.lang.String	getDisplayName() Returns the system name of this reader.
java.lang.String	getName() Returns the unique name of this reader.
void	initialize() start initialisation
boolean	isCardPresent() Returns whether a card is present in this reader.
boolean	isInitialized() Return the current initialisation status

Method Detail

initialize

void initialize()

start initialisation

isInitialized

boolean isInitialized()

Return the current initialisation status

Returns:

true: if card reader is initialized false: card reader not operational

connect

ICard connect()
       throws CardException

Establishes a connection to the card. If a connection has previously established using the specified protocol, this method returns the same Card object as the previous call.

Returns:

Card object

Throws:

CardException - - if a connection could not be established using the specified protocol or if a connection has previously been established using a different protocol

getName

java.lang.String getName()

Returns the unique name of this reader.

Returns:

the unique name of this reader.

getDisplayName

default java.lang.String getDisplayName()

Returns the system name of this reader.

Returns:

the system name of this reader.

isCardPresent

boolean isCardPresent()
               throws CardException

Returns whether a card is present in this reader.

Returns:

whether a card is present in this reader.

Throws:

CardException - - if the status could not be determined