 |
Keypop Reader C++ API 2.0.0
Reference Reader API for C++
|
|
Keypop Reader C++ API 2.0.0
Reference Reader API for C++
|
#include <CardSelectionManager.hpp>
Public Member Functions | |
| virtual | ~CardSelectionManager ()=default |
| virtual void | setMultipleSelectionMode ()=0 |
| virtual int | prepareSelection (const std::shared_ptr< CardSelector > cardSelector, const std::shared_ptr< spi::CardSelectionExtension > cardSelectionExtension)=0 |
| virtual void | prepareReleaseChannel ()=0 |
| virtual const std::string | exportCardSelectionScenario () const =0 |
| virtual int | importCardSelectionScenario (const std::string &cardSelectionScenario)=0 |
| virtual const std::shared_ptr< CardSelectionResult > | processCardSelectionScenario (std::shared_ptr< CardReader > reader)=0 |
| virtual void | scheduleCardSelectionScenario (std::shared_ptr< ObservableCardReader > observableCardReader, const ObservableCardReader::NotificationMode notificationMode)=0 |
| virtual std::shared_ptr< calypsonet::reader::selection::CardSelectionResult > | parseScheduledCardSelectionsResponse (const std::shared_ptr< ScheduledCardSelectionsResponse > scheduledCardSelectionsResponse) const =0 |
| virtual const std::string & | exportProcessedCardSelectionScenario () const =0 |
| virtual const std::shared_ptr< CardSelectionResult > | importProcessedCardSelectionScenario (const std::string &processedCardSelectionScenario) const =0 |
Service dedicated to card selection, based on the preparation of a card selection scenario.
A card selection scenario consists of one or more selection cases based on a CardSelectionExtension.
A card selection case targets a specific card.
Optionally, additional commands can be defined to be executed after the successful selection of the card.
If a card selection case fails, the service will try with the next card selection case defined in the scenario, until there are no further card selection cases available.
If a card selection case succeeds:
The logical channel established with the card can be left open (default) or closed after card selection (by using the CardSelectionManager#prepareReleaseChannel() method).
This service allows to:
An instance of this interface can be obtained via the method ReaderApiFactory#createCardSelectionManager().
Definition at line 70 of file CardSelectionManager.hpp.
|
virtualdefault |
Virtual destructor.
|
pure virtual |
Exports the current prepared card selection scenario to a string in string format.
This string can be imported into the same or another card selection manager via the method importCardSelectionScenario(const std::string&).
|
pure virtual |
Exports the content of the previously processed card selection scenario in string format.
This string can be imported into the same or another card selection manager via the method importProcessedCardSelectionScenario(const std::string&).
Prerequisite: the card selection scenario must first have been processed via the processCardSelectionScenario(const std::shared_ptr<CardReader>) or parseScheduledCardSelectionsResponse(const std::shared_ptr<ScheduledCardSelectionsResponse>) method.
Caution: if the local environment does not have the card extensions involved in the selection scenario, then methods processCardSelectionScenario(const std::shared_ptr<CardReader>) and parseScheduledCardSelectionsResponse(const std::shared_ptr<ScheduledCardSelectionsResponse>) will not be able to interpret the content of the result, and consequently, the content of the result object CardSelectionResult will not contain any active selection. It will then be necessary to export the processed scenario in order to import it and interpret it correctly by a card selection manager that has all the card extensions involved in the selection scenario.
| IllegalStateException | If the card selection scenario has not yet been processed or has failed. |
|
pure virtual |
Imports a card selection scenario provided as a string in string format.
The string must have been exported from a card selection manager via the method exportCardSelectionScenario().
| cardSelectionScenario | The string containing the exported card selection scenario. |
| IllegalArgumentException | If the string is null or malformed. |
|
pure virtual |
Imports a previously exported processed card selection scenario in string format and returns the card selection result.
Prerequisites:
| processedCardSelectionScenario | The string containing the exported processed card selection scenario. |
| IllegalArgumentException | If the string is null, malformed or contains more card selection cases than the current card selection scenario. |
| InvalidCardResponseException | If the data returned by the card could not be interpreted. |
|
pure virtual |
Analyzes the responses provided by a calypsonet::terminal::reader::CardReaderEvent following the insertion of a card and the execution of the card selection scenario.
| scheduledCardSelectionsResponse | The card selection scenario execution response. |
| IllegalArgumentException | If the provided card selection response is null. |
| InvalidCardResponseException | If the data returned by the card could not be interpreted. |
|
pure virtual |
Requests the closing of the physical channel at the end of the execution of the card selection request.
It is thus possible to chain several selections on the same card selection scenario by restarting the card connection sequence.
|
pure virtual |
Appends a card selection case to the card selection scenario.
The method returns the index giving the current position of the selection in the selection scenario (0 for the first application, 1 for the second, etc.). This index will be used to retrieve the corresponding result in the CardSelectionResult object.
| cardSelector | The card selector containing the filters to be used to select the card. |
| cardSelectionExtension | The card selection extension to be used to parse the card selection response. |
| IllegalArgumentException | If the provided card selector or card selection extension is null. |
|
pure virtual |
Explicitely executes a previously prepared card selection scenario and returns the card selection result.
| reader | The reader to communicate with the card. |
| IllegalArgumentException | If the provided reader is null. |
| ReaderCommunicationException | If the communication with the reader has failed. |
| CardCommunicationException | If communication with the card has failed or if the status word check is enabled in the card request and the card has returned an unexpected code. |
| InvalidCardResponseException | If the card returned invalid data during the selection process. |
|
pure virtual |
Schedules the execution of the prepared card selection scenario as soon as a card is presented to the provided ObservableCardReader.
calypsonet::terminal::reader::CardReaderEvent are pushed to the observer according to the specified notification mode.
The result of the scenario execution will be analyzed by parseScheduledCardSelectionsResponse(ScheduledCardSelectionsResponse).
| observableCardReader | The reader with which the card communication is carried out. |
| notificationMode | The card notification mode to use when a card is detected. |
| IllegalArgumentException | If one of the parameters is null. |
|
pure virtual |
Sets the multiple selection mode to process all selection cases even in case of a successful selection.
The multiple selection mode is disabled by default.
1.9.2