Keyple Card Calypso C++ Library 2.1.0
Reference Terminal Reader API for C++
Public Member Functions | List of all members
keyple::card::calypso::CardSelectorAdapter Class Referencefinal

#include <CardSelectorAdapter.h>

Inheritance diagram for keyple::card::calypso::CardSelectorAdapter:
Inheritance graph
[legend]
Collaboration diagram for keyple::card::calypso::CardSelectorAdapter:
Collaboration graph
[legend]

Public Member Functions

 CardSelectorAdapter ()
 
CardSelectorSpi & filterByCardProtocol (const std::string &cardProtocol)
 
CardSelectorSpi & filterByPowerOnData (const std::string &powerOnDataRegex)
 
CardSelectorSpi & filterByDfName (const std::vector< uint8_t > &aid)
 
CardSelectorSpi & filterByDfName (const std::string &aid)
 
CardSelectorSpi & setFileOccurrence (const FileOccurrence fileOccurrence)
 
CardSelectorSpi & setFileControlInformation (const FileControlInformation fileControlInformation)
 
CardSelectorSpi & addSuccessfulStatusWord (const int statusWord)
 
const std::string & getCardProtocol () const final
 
const std::string & getPowerOnDataRegex () const override
 
const std::vector< uint8_t > & getAid () const override
 
FileOccurrence getFileOccurrence () const override
 
FileControlInformation getFileControlInformation () const override
 
const std::vector< int > & getSuccessfulSelectionStatusWords () const override
 

Detailed Description

(package-private)
Implementation of CardSelectorSpi.

Since
2.0.0

Definition at line 36 of file CardSelectorAdapter.h.

Constructor & Destructor Documentation

◆ CardSelectorAdapter()

keyple::card::calypso::CardSelectorAdapter::CardSelectorAdapter ( )

(package-private)
Created an instance of CardSelectorAdapter.

Initialize default values.

Since
2.0.0

Definition at line 26 of file CardSelectorAdapter.cpp.

Member Function Documentation

◆ addSuccessfulStatusWord()

CardSelectorSpi & keyple::card::calypso::CardSelectorAdapter::addSuccessfulStatusWord ( const int  statusWord)

Adds a status word to the list of those that should be considered successful for the Select Application APDU.

Note: initially, the list contains the standard successful status word

9000h

.

Parameters
statusWordA positive int ≤
FFFFh
.
Returns
The object instance.
Since
2.0.0

Definition at line 73 of file CardSelectorAdapter.cpp.

◆ filterByCardProtocol()

CardSelectorSpi & keyple::card::calypso::CardSelectorAdapter::filterByCardProtocol ( const std::string &  cardProtocol)

Sets a protocol-based filtering by defining an expected card.

If the card protocol is set, only cards using that protocol will match the card selector.

Parameters
cardProtocolA not empty String.
Returns
The object instance.
Since
2.0.0

Definition at line 31 of file CardSelectorAdapter.cpp.

◆ filterByDfName() [1/2]

CardSelectorSpi & keyple::card::calypso::CardSelectorAdapter::filterByDfName ( const std::string &  aid)

Sets a DF Name-based filtering by defining in a hexadecimal string the AID that will be included in the standard SELECT APPLICATION command sent to the card during the selection process.

The provided AID can be a right truncated image of the target DF Name (see ISO 7816-4 4.2).

Parameters
aidA hexadecimal string representation of 5 to 16 bytes.
Returns
The object instance.
Since
2.0.0

Definition at line 53 of file CardSelectorAdapter.cpp.

◆ filterByDfName() [2/2]

CardSelectorSpi & keyple::card::calypso::CardSelectorAdapter::filterByDfName ( const std::vector< uint8_t > &  aid)

Sets a DF Name-based filtering by defining in a byte array the AID that will be included in the standard SELECT APPLICATION command sent to the card during the selection process.

The provided AID can be a right truncated image of the target DF Name (see ISO 7816-4 4.2).

Parameters
aidA byte array containing 5 to 16 bytes.
Returns
The object instance.
Since
2.0.0

Definition at line 46 of file CardSelectorAdapter.cpp.

◆ filterByPowerOnData()

CardSelectorSpi & keyple::card::calypso::CardSelectorAdapter::filterByPowerOnData ( const std::string &  powerOnDataRegex)

Sets a power-on data-based filtering by defining a regular expression that will be applied to the card's power-on data.

If it is set, only the cards whose power-on data is recognized by the provided regular expression will match the card selector.

Parameters
powerOnDataRegexA valid regular expression
Returns
The object instance.
Since
2.0.0

Definition at line 39 of file CardSelectorAdapter.cpp.

◆ getAid()

const std::vector< uint8_t > & keyple::card::calypso::CardSelectorAdapter::getAid ( ) const
override
Since
2.0.0

Definition at line 90 of file CardSelectorAdapter.cpp.

◆ getCardProtocol()

const std::string & keyple::card::calypso::CardSelectorAdapter::getCardProtocol ( ) const
final
Since
2.0.0

Definition at line 80 of file CardSelectorAdapter.cpp.

◆ getFileControlInformation()

FileControlInformation keyple::card::calypso::CardSelectorAdapter::getFileControlInformation ( ) const
override
Since
2.0.0

Definition at line 100 of file CardSelectorAdapter.cpp.

◆ getFileOccurrence()

FileOccurrence keyple::card::calypso::CardSelectorAdapter::getFileOccurrence ( ) const
override
Since
2.0.0

Definition at line 95 of file CardSelectorAdapter.cpp.

◆ getPowerOnDataRegex()

const std::string & keyple::card::calypso::CardSelectorAdapter::getPowerOnDataRegex ( ) const
override
Since
2.0.0

Definition at line 85 of file CardSelectorAdapter.cpp.

◆ getSuccessfulSelectionStatusWords()

const std::vector< int > & keyple::card::calypso::CardSelectorAdapter::getSuccessfulSelectionStatusWords ( ) const
override
Since
2.0.0

Definition at line 105 of file CardSelectorAdapter.cpp.

◆ setFileControlInformation()

CardSelectorSpi & keyple::card::calypso::CardSelectorAdapter::setFileControlInformation ( const FileControlInformation  fileControlInformation)

Sets the file control mode (see ISO7816-4).

The default value is FileControlInformation#FCI.

Parameters
fileControlInformationThe FileControlInformation.
Returns
The object instance.
Since
2.0.0

Definition at line 65 of file CardSelectorAdapter.cpp.

◆ setFileOccurrence()

CardSelectorSpi & keyple::card::calypso::CardSelectorAdapter::setFileOccurrence ( const FileOccurrence  fileOccurrence)

Sets the file occurrence mode (see ISO7816-4).

The default value is FileOccurrence#FIRST.

Parameters
fileOccurrenceThe FileOccurrence.
Returns
The object instance.
Since
2.0.0

Definition at line 58 of file CardSelectorAdapter.cpp.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.2