org.eclipse.keyple.core.plugin

Class AbstractReader

java.lang.Object

org.eclipse.keyple.core.plugin.AbstractReader

All Implemented Interfaces:

ProxyReader, Reader

Direct Known Subclasses:

AbstractLocalReader

public abstract class AbstractReader
extends java.lang.Object
implements ProxyReader

Implements the ProxyReader high-level interface.

AbstractReader defines the minimum required functionality for a local or remote reader.

It provides logging facilities.

Since:

0.9

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isRegistered Registeration status of the reader

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractReader(java.lang.String pluginName, java.lang.String name) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Gets the name of the reader.
java.lang.String	getPluginName() Gets the name of plugin provided in the constructor.
protected abstract CardResponse	processCardRequest(CardRequest cardRequest, ChannelControl channelControl) This method is the actual implementation of the process of a CardRequest as defined by ProxyReader.transmitCardRequest(CardRequest, ChannelControl)
protected abstract java.util.List<CardSelectionResponse>	processCardSelectionRequests(java.util.List<CardSelectionRequest> cardSelectionRequests, MultiSelectionProcessing multiSelectionProcessing, ChannelControl channelControl) This method is the actual implementation of the process of transmitting a list of CardSelectionRequest as defined by ProxyReader.transmitCardSelectionRequests(List, MultiSelectionProcessing, ChannelControl).
CardResponse	transmitCardRequest(CardRequest cardRequest, ChannelControl channelControl) Transmits a single CardRequest passed as an argument and returns a CardResponse.
java.util.List<CardSelectionResponse>	transmitCardSelectionRequests(java.util.List<CardSelectionRequest> cardSelectionRequests, MultiSelectionProcessing multiSelectionProcessing, ChannelControl channelControl) Transmits the list of CardSelectionRequest and gets in return a list of CardSelectionResponse.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.keyple.core.card.message.ProxyReader

releaseChannel

Methods inherited from interface org.eclipse.keyple.core.service.Reader

activateProtocol, deactivateProtocol, isCardPresent, isContactless

Field Detail

isRegistered

protected boolean isRegistered

Registeration status of the reader

Constructor Detail

AbstractReader

protected AbstractReader(java.lang.String pluginName,
                         java.lang.String name)

Constructor.

Plugin and reader names helps to identify the object in a multireader context.

The reader is marked as registered as soon as it is created.

Initializes the time measurement log at CardRequest level. The first measurement gives the time elapsed since the plugin was loaded.

Parameters:

pluginName - A not empty string.

name - A not empty string.

Since:

0.9

Method Detail

getName

public final java.lang.String getName()

Gets the name of the reader.

Specified by:

getName in interface Reader

Returns:

A not empty string.

getPluginName

public final java.lang.String getPluginName()

Gets the name of plugin provided in the constructor.

Returns:

A not empty string.

Since:

0.9

transmitCardSelectionRequests

public final java.util.List<CardSelectionResponse> transmitCardSelectionRequests(java.util.List<CardSelectionRequest> cardSelectionRequests,
                                                                                 MultiSelectionProcessing multiSelectionProcessing,
                                                                                 ChannelControl channelControl)

Transmits the list of CardSelectionRequest and gets in return a list of CardSelectionResponse.

The actual processing of each CardSelectionRequest is similar to that performed by ProxyReader.transmitCardRequest(CardRequest, ChannelControl) (see this method for further explanation of how the process works).

If the multiSelectionProcessing parameter equals to MultiSelectionProcessing.FIRST_MATCH, the iteration over the CardSelectionRequest list is interrupted at the first processing that leads to an open logical channel state. In this case, the list of CardSelectionResponse may be shorter than the list of CardSelectionRequest provided as input.

If it equals to MultiSelectionProcessing.PROCESS_ALL, all the CardSelectionRequest are processed and the logical channel is closed after each process.
The physical channel is managed by the ChannelControl parameter as in ProxyReader.transmitCardRequest(CardRequest, ChannelControl).

In the case of a selection specifying a card protocol, it is imperative to activate it previously with the method Reader.activateProtocol(String, String). An IllegalStateException exception will be thrown in case of inconsistency.

This implementation of ProxyReader.transmitCardSelectionRequests(List, MultiSelectionProcessing, ChannelControl) is based on processCardSelectionRequests(List, MultiSelectionProcessing, ChannelControl).
It adds a logging of exchanges including a measure of execution time, available at the debug level.

Specified by:

transmitCardSelectionRequests in interface ProxyReader

Parameters:

cardSelectionRequests - A not empty list of CardSelectionRequest.

multiSelectionProcessing - The multi card processing flag (must be not null).

channelControl - indicates if the physical channel has to be closed at the end of the processing (must be not null).

Returns:

A not null response list (can be empty).

Since:

0.9

processCardSelectionRequests

protected abstract java.util.List<CardSelectionResponse> processCardSelectionRequests(java.util.List<CardSelectionRequest> cardSelectionRequests,
                                                                                      MultiSelectionProcessing multiSelectionProcessing,
                                                                                      ChannelControl channelControl)

This method is the actual implementation of the process of transmitting a list of CardSelectionRequest as defined by ProxyReader.transmitCardSelectionRequests(List, MultiSelectionProcessing, ChannelControl).

Parameters:

cardSelectionRequests - A not empty list of not null CardSelectionRequest.

multiSelectionProcessing - The multi card processing flag (must be not null).

channelControl - indicates if the physical channel has to be closed at the end of the processing (must be not null).

Returns:

A not null response list (can be empty).

Throws:

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

java.lang.IllegalArgumentException - if one of the arguments is null.

java.lang.IllegalStateException - in case of configuration inconsistency.

Since:

0.9

See Also:

ProxyReader.transmitCardSelectionRequests(List, MultiSelectionProcessing, ChannelControl)

transmitCardRequest

public final CardResponse transmitCardRequest(CardRequest cardRequest,
                                              ChannelControl channelControl)

Transmits a single CardRequest passed as an argument and returns a CardResponse.

The process includes the following steps:

• Open the physical channel if it is not already open.
• If the CardRequest contains a non null CardSelector. The 3 following operations are performed in this order:
  1. If specified, check the card protocol (compare the specified protocol with the current protocol).
  2. If specified, check the ATR (test the received ATR with the regular expression from the filter)
  3. If specified, select the application by AID
  If one of the 3 operations fails, then an empty response containing the selection status is returned.
  If all executed operations are successful then a selection status is created with the corresponding data (ATR and/or FCI) and the hasMatched flag true.
• If the CardRequest contains a list of APDUs to send (ApduRequest) then each APDU is sent to the card and its response (ApduResponse is added to a new list.
• Closes the physical channel if the ChannelControl is ChannelControl.CLOSE_AFTER.
• Returns a CardResponse containing:
  • a boolean giving the current logical channel status.
  • a boolean giving the previous logical channel status.
  • if a selection has been made (CardSelector not null) a SelectionStatus object containing the elements resulting from the selection.
  • if APDUs have been transmitted to the card, the list of responses to these APDUs.

Note: in case of a communication error when sending an APDU an KeypleReaderIOException exception is thrown. Responses to previous APDUs are attached to this exception.
This allows the calling application to be tolerant to the card tearing and to recover a partial response to the CardRequest.

This implementation of ProxyReader.transmitCardRequest(CardRequest, ChannelControl) is based on processCardRequest(CardRequest, ChannelControl).
It adds a logging of exchanges including a measure of execution time, available at the debug level.

Specified by:

transmitCardRequest in interface ProxyReader

Parameters:

cardRequest - The CardRequest to be processed (must be not null).

channelControl - indicates if the physical channel has to be closed at the end of the processing (must be not null).

Returns:

cardResponse A not null CardResponse.

Since:

0.9

processCardRequest

protected abstract CardResponse processCardRequest(CardRequest cardRequest,
                                                   ChannelControl channelControl)

This method is the actual implementation of the process of a CardRequest as defined by ProxyReader.transmitCardRequest(CardRequest, ChannelControl)

Parameters:

cardRequest - The CardRequest to be processed (can be null).

channelControl - indicates if the physical channel has to be closed at the end of the processing (must be not null).

Returns:

cardResponse A not null CardResponse.

Throws:

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

java.lang.IllegalArgumentException - if one of the arguments is null.

Since:

0.9

See Also:

ProxyReader.transmitCardRequest(CardRequest, ChannelControl)