org.eclipse.keyple.core.service

Interface Reader

All Known Subinterfaces:

DontWaitForCardRemovalDuringProcessing, ObservableReader, ObservableReaderNotifier, ProxyReader, SmartSelectionReader, WaitForCardInsertionAutonomous, WaitForCardInsertionBlocking, WaitForCardInsertionNonBlocking, WaitForCardRemovalAutonomous, WaitForCardRemovalBlocking, WaitForCardRemovalDuringProcessing, WaitForCardRemovalNonBlocking

All Known Implementing Classes:

AbstractLocalReader, AbstractObservableLocalAutonomousReader, AbstractObservableLocalReader, AbstractReader

public interface Reader

Defines the high level API to access a card reader.

• To retrieve the unique reader name
• To check the card presence.
• To activate and deactivate the card protocols.
• To tell if the communication is contactless or not.

The interface is used by applications processing the card.

Since:

0.9

Method Summary

Modifier and Type	Method and Description
void	activateProtocol(java.lang.String readerProtocolName, java.lang.String applicationProtocolName) Activates the provided card protocol and assigns it a name.
void	deactivateProtocol(java.lang.String readerProtocolName) Deactivates the provided card protocol.
java.lang.String	getName() Gets the name of the reader
boolean	isCardPresent() Checks if is the card present.
boolean	isContactless() Tells if the current card communication is contactless.

Method Detail

getName

java.lang.String getName()

Gets the name of the reader

Returns:

A not empty string.

Since:

0.9

isCardPresent

boolean isCardPresent()

Checks if is the card present.

Returns:

true if a card is present in the reader

Throws:

KeypleReaderIOException - if the communication with the reader or the card has failed

java.lang.IllegalStateException - is called when reader is no longer registered

Since:

0.9

activateProtocol

void activateProtocol(java.lang.String readerProtocolName,
                      java.lang.String applicationProtocolName)

Activates the provided card protocol and assigns it a name.

• Activates the detection of cards using this protocol (if the plugin allows it).
• Asks the plugin to take this protocol into account if a card using this protocol is identified during the selection phase.
• Internally associates the two strings provided as arguments.
• The #readerProtocolName argument is the name of the protocol among those supported by the reader.
• The #applicationProtocolName is the name of the protocol to be the plugin when a card using this protocol is detected.

Note: in the case where multiple protocols are activated, they will be checked in the selection process in the order in which they were activated. The most likely cases should therefore be activated first.

Parameters:

readerProtocolName - A not empty String.

applicationProtocolName - A not empty String.

Throws:

KeypleReaderProtocolNotSupportedException - if the protocol is not supported.

java.lang.IllegalStateException - is called when reader is no longer registered

Since:

1.0

deactivateProtocol

void deactivateProtocol(java.lang.String readerProtocolName)

Deactivates the provided card protocol.

• Inhibits the detection of cards using this protocol.
• Ask the plugin to ignore this protocol if a card using this protocol is identified during the selection phase.

Parameters:

readerProtocolName - A not empty String.

Throws:

KeypleReaderProtocolNotSupportedException - if the protocol is not supported.

java.lang.IllegalStateException - is called when reader is no longer registered

Since:

1.0

isContactless

boolean isContactless()

Tells if the current card communication is contactless.

Returns:

True if the communication is contactless, false if not.

Throws:

java.lang.IllegalStateException - is called when reader is no longer registered

Since:

1.0