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

#include <CalypsoExtensionService.h>

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

Public Member Functions

const std::string & getReaderApiVersion () const override
 
const std::string & getCardApiVersion () const override
 
const std::string & getCommonApiVersion () const override
 
std::shared_ptr< SearchCommandData > createSearchCommandData () const
 
std::shared_ptr< CalypsoCardSelection > createCardSelection () const
 
std::shared_ptr< CalypsoSamSelection > createSamSelection () const
 
std::shared_ptr< CardResourceProfileExtension > createSamResourceProfileExtension (const std::shared_ptr< CalypsoSamSelection > calypsoSamSelection) const
 
std::shared_ptr< CardSecuritySetting > createCardSecuritySetting () const
 
std::shared_ptr< CardTransactionManager > createCardTransaction (std::shared_ptr< CardReader > reader, const std::shared_ptr< CalypsoCard > calypsoCard, const std::shared_ptr< CardSecuritySetting > cardSecuritySetting)
 
std::shared_ptr< CardTransactionManager > createCardTransactionWithoutSecurity (std::shared_ptr< CardReader > reader, const std::shared_ptr< CalypsoCard > calypsoCard)
 

Static Public Member Functions

static std::shared_ptr< CalypsoExtensionServicegetInstance ()
 

Static Public Attributes

static const std::string PRODUCT_TYPE = "productType"
 

Detailed Description

Card extension dedicated to the management of Calypso cards.

Since
2.0.0

Definition at line 54 of file CalypsoExtensionService.h.

Member Function Documentation

◆ createCardSecuritySetting()

std::shared_ptr< CardSecuritySetting > keyple::card::calypso::CalypsoExtensionService::createCardSecuritySetting ( ) const

Creates an instance of CalypsoCardSelection that can be supplemented later with specific commands.

Returns
A not null reference.
Since
2.0.0

Definition at line 97 of file CalypsoExtensionService.cpp.

◆ createCardSelection()

std::shared_ptr< CalypsoCardSelection > keyple::card::calypso::CalypsoExtensionService::createCardSelection ( ) const

Creates an instance of CalypsoCardSelection that can be supplemented later with specific commands.

Returns
A not null reference.
Since
2.0.0

Definition at line 78 of file CalypsoExtensionService.cpp.

◆ createCardTransaction()

std::shared_ptr< CardTransactionManager > keyple::card::calypso::CalypsoExtensionService::createCardTransaction ( std::shared_ptr< CardReader >  reader,
const std::shared_ptr< CalypsoCard >  calypsoCard,
const std::shared_ptr< CardSecuritySetting >  cardSecuritySetting 
)

Creates a card transaction manager to handle operations secured with a SAM.

The reader and the card's initial data are those from the selection.
The provided CardSecuritySetting must match the specific needs of the card (SAM card resource profile and other optional settings).

Parameters
readerThe reader through which the card communicates.
calypsoCardThe initial card data provided by the selection process.
cardSecuritySettingThe security settings.
Returns
A not null reference.
Exceptions
IllegalArgumentExceptionIf one of the provided argument is null or if the CalypsoCard has a null or unknown product type.
Since
2.0.0

Definition at line 102 of file CalypsoExtensionService.cpp.

◆ createCardTransactionWithoutSecurity()

std::shared_ptr< CardTransactionManager > keyple::card::calypso::CalypsoExtensionService::createCardTransactionWithoutSecurity ( std::shared_ptr< CardReader >  reader,
const std::shared_ptr< CalypsoCard >  calypsoCard 
)

Creates a card transaction manager to handle non-secured operations.

Parameters
readerThe reader through which the card communicates.
calypsoCardThe initial card data provided by the selection process.
Returns
A not null reference.
Exceptions
IllegalArgumentExceptionIf one of the provided argument is null or if the CalypsoCard has a null or unknown product type.
Since
2.0.0

Definition at line 125 of file CalypsoExtensionService.cpp.

◆ createSamResourceProfileExtension()

std::shared_ptr< CardResourceProfileExtension > keyple::card::calypso::CalypsoExtensionService::createSamResourceProfileExtension ( const std::shared_ptr< CalypsoSamSelection >  calypsoSamSelection) const

Creates an instance of CardResourceProfileExtension to be provided to the CardResourceService.

The provided argument defines the selection rules to be applied to the SAM when detected by the card resource service.

Parameters
calypsoSamSelectionA not null CalypsoSamSelection.
Returns
A not null reference.
Exceptions
IllegalArgumentExceptionIf calypsoSamSelection is null.
Since
2.0.0

Definition at line 89 of file CalypsoExtensionService.cpp.

◆ createSamSelection()

std::shared_ptr< CalypsoSamSelection > keyple::card::calypso::CalypsoExtensionService::createSamSelection ( ) const

Creates an instance of CalypsoCardSelection.

Returns
A not null reference.
Since
2.0.0

Definition at line 83 of file CalypsoExtensionService.cpp.

◆ createSearchCommandData()

std::shared_ptr< SearchCommandData > keyple::card::calypso::CalypsoExtensionService::createSearchCommandData ( ) const

Creates an instance of SearchCommandData to be used to define the parameters of the CardTransactionManager::prepareSearchRecords(SearchCommandData) method.

Returns
A not null reference.
Since
2.1.0

Definition at line 73 of file CalypsoExtensionService.cpp.

◆ getCardApiVersion()

const std::string & keyple::card::calypso::CalypsoExtensionService::getCardApiVersion ( ) const
override
Since
2.0.0

Definition at line 63 of file CalypsoExtensionService.cpp.

◆ getCommonApiVersion()

const std::string & keyple::card::calypso::CalypsoExtensionService::getCommonApiVersion ( ) const
override
Since
2.0.0

Definition at line 68 of file CalypsoExtensionService.cpp.

◆ getInstance()

std::shared_ptr< CalypsoExtensionService > keyple::card::calypso::CalypsoExtensionService::getInstance ( )
static

Gets the single instance of CalypsoExtensionService.

Returns
The instance of CalypsoExtensionService.
Since
2.0.0

Definition at line 49 of file CalypsoExtensionService.cpp.

◆ getReaderApiVersion()

const std::string & keyple::card::calypso::CalypsoExtensionService::getReaderApiVersion ( ) const
override
Since
2.0.0

Definition at line 58 of file CalypsoExtensionService.cpp.

Member Data Documentation

◆ PRODUCT_TYPE

const std::string keyple::card::calypso::CalypsoExtensionService::PRODUCT_TYPE = "productType"
static

Definition at line 59 of file CalypsoExtensionService.h.


The documentation for this class was generated from the following files: