de.gematik.ti.cardreader.provider.pcsc.entities

Class CardReader

java.lang.Object

de.gematik.ti.cardreader.provider.pcsc.entities.CardReader

All Implemented Interfaces:

de.gematik.ti.cardreader.provider.api.ICardReader

public class CardReader
extends java.lang.Object
implements de.gematik.ti.cardreader.provider.api.ICardReader

The CardReader represent a pcsc card reader with one slot.

Class diagram 1: CardReader

Constructor Summary

Constructors

Constructor and Description
CardReader(javax.smartcardio.CardTerminal cardTerminal)

Method Summary

Modifier and Type	Method and Description
de.gematik.ti.cardreader.provider.api.card.ICard	connect() Establishes a connection to the card with the protocol *.
de.gematik.ti.cardreader.provider.api.card.ICard	connect(java.lang.String protocol) Establishes a connection to the card.
javax.smartcardio.CardTerminal	getCardTerminal()
java.lang.String	getName() Returns the unique name of this terminal.
void	initialize() initialize the card reader
boolean	isCardPresent() Returns whether a card is present in this terminal.
boolean	isInitialized() Return the current initialisation status
java.lang.String	toString()
boolean	waitForCardAbsent(long timeout) Waits until a card is absent in this terminal or the timeout expires.
boolean	waitForCardPresent(long timeout) Waits until a card is present in this terminal or the timeout expires.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.gematik.ti.cardreader.provider.api.ICardReader

getDisplayName

Constructor Detail

CardReader

public CardReader(javax.smartcardio.CardTerminal cardTerminal)

Method Detail

initialize

public void initialize()

initialize the card reader

Specified by:

initialize in interface de.gematik.ti.cardreader.provider.api.ICardReader

isInitialized

public boolean isInitialized()

Return the current initialisation status

Specified by:

isInitialized in interface de.gematik.ti.cardreader.provider.api.ICardReader

Returns:

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

connect

public de.gematik.ti.cardreader.provider.api.card.ICard connect(java.lang.String protocol)
                                                         throws de.gematik.ti.cardreader.provider.api.card.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.

Parameters:

protocol - - the protocol to use ("T=0", "T=1", or "T=CL"), or "*" to connect using any available protocol.

Returns:

Card object

Throws:

java.lang.NullPointerException - if protocol is null IllegalArgumentException if protocol is an invalid protocol specification CardNotPresentException if no card is present in this terminal CardException if a connection could not be established using the specified protocol or if a connection has previously been established using a different protocol SecurityException if a SecurityManager exists and the caller does not have the required permission

de.gematik.ti.cardreader.provider.api.card.CardException

connect

public de.gematik.ti.cardreader.provider.api.card.ICard connect()
                                                         throws de.gematik.ti.cardreader.provider.api.card.CardException

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

Specified by:

connect in interface de.gematik.ti.cardreader.provider.api.ICardReader

Returns:

Card object

Throws:

java.lang.NullPointerException - if protocol is null IllegalArgumentException if protocol is an invalid protocol specification CardNotPresentException if no card is present in this terminal CardException if a connection could not be established using the specified protocol or if a connection has previously been established using a different protocol SecurityException if a SecurityManager exists and the caller does not have the required permission

de.gematik.ti.cardreader.provider.api.card.CardException

getName

public java.lang.String getName()

Returns the unique name of this terminal.

Specified by:

getName in interface de.gematik.ti.cardreader.provider.api.ICardReader

Returns:

the unique name of this terminal.

isCardPresent

public boolean isCardPresent()
                      throws de.gematik.ti.cardreader.provider.api.card.CardException

Returns whether a card is present in this terminal.

Specified by:

isCardPresent in interface de.gematik.ti.cardreader.provider.api.ICardReader

Returns:

whether a card is present in this terminal.

Throws:

de.gematik.ti.cardreader.provider.api.card.CardException - if the status could not be determined

waitForCardAbsent

public boolean waitForCardAbsent(long timeout)
                          throws de.gematik.ti.cardreader.provider.api.card.CardException

Waits until a card is absent in this terminal or the timeout expires. If the method returns due to an expired timeout, it returns false. Otherwise it return true. If no card is present in this terminal when this method is called, it returns immediately.

Parameters:

timeout - - if positive, block for up to timeout milliseconds; if zero, block indefinitely; must not be negative

Returns:

false if the method returns due to an expired timeout, true otherwise.

Throws:

java.lang.IllegalArgumentException - if timeout is negative CardException if the operation failed

de.gematik.ti.cardreader.provider.api.card.CardException

waitForCardPresent

public boolean waitForCardPresent(long timeout)
                           throws de.gematik.ti.cardreader.provider.api.card.CardException

Waits until a card is present in this terminal or the timeout expires. If the method returns due to an expired timeout, it returns false. Otherwise it return true. If a card is present in this terminal when this method is called, it returns immediately.

Parameters:

timeout - - if positive, block for up to timeout milliseconds; if zero, block indefinitely; must not be negative

Returns:

false if the method returns due to an expired timeout, true otherwise.

Throws:

java.lang.IllegalArgumentException - if timeout is negative CardException if the operation failed

de.gematik.ti.cardreader.provider.api.card.CardException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCardTerminal

public javax.smartcardio.CardTerminal getCardTerminal()

Returns:

cardTerminal