Keyple Card Calypso C++ Library 2.2.2
Reference Terminal Reader API for C++
Public Member Functions | Static Public Member Functions | 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< BasicSignatureComputationData > createBasicSignatureComputationData () const
 
std::shared_ptr< TraceableSignatureComputationData > createTraceableSignatureComputationData () const
 
std::shared_ptr< BasicSignatureVerificationData > createBasicSignatureVerificationData () const
 
std::shared_ptr< TraceableSignatureVerificationData > createTraceableSignatureVerificationData () 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 > cardReader, const std::shared_ptr< CalypsoCard > calypsoCard, const std::shared_ptr< CardSecuritySetting > cardSecuritySetting) const
 
std::shared_ptr< CardTransactionManager > createCardTransactionWithoutSecurity (std::shared_ptr< CardReader > cardReader, const std::shared_ptr< CalypsoCard > calypsoCard) const
 
std::shared_ptr< SamSecuritySetting > createSamSecuritySetting () const
 
std::shared_ptr< SamTransactionManager > createSamTransaction (std::shared_ptr< CardReader > samReader, const std::shared_ptr< CalypsoSam > calypsoSam, const std::shared_ptr< SamSecuritySetting > samSecuritySetting) const
 
std::shared_ptr< SamTransactionManager > createSamTransactionWithoutSecurity (std::shared_ptr< CardReader > samReader, const std::shared_ptr< CalypsoSam > calypsoSam) const
 

Static Public Member Functions

static std::shared_ptr< CalypsoExtensionService > getInstance ()
 

Detailed Description

Card extension dedicated to the management of Calypso cards.

Since
2.0.0

Definition at line 64 of file CalypsoExtensionService.h.

Member Function Documentation

◆ createBasicSignatureComputationData()

std::shared_ptr< BasicSignatureComputationData > keyple::card::calypso::CalypsoExtensionService::createBasicSignatureComputationData ( ) const

Returns a new instance of BasicSignatureComputationData to use to define the parameters of the CardTransactionManager::prepareComputeSignature(CommonSignatureComputationData) and SamTransactionManager::prepareComputeSignature(CommonSignatureComputationData) methods.

Returns
A not null reference.
Since
2.2.0

Definition at line 82 of file CalypsoExtensionService.cpp.

◆ createBasicSignatureVerificationData()

std::shared_ptr< BasicSignatureVerificationData > keyple::card::calypso::CalypsoExtensionService::createBasicSignatureVerificationData ( ) const

Returns a new instance of BasicSignatureVerificationData to use to define the parameters of the CardTransactionManager::prepareVerifySignature(CommonSignatureVerificationData) and SamTransactionManager::prepareVerifySignature(CommonSignatureVerificationData) methods.

Returns
A not null reference.
Since
2.2.0

Definition at line 96 of file CalypsoExtensionService.cpp.

◆ createCardSecuritySetting()

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

Returns a new instance of CardSecuritySetting to use for secure card operations.

Returns
A not null reference.
Since
2.0.0

Definition at line 128 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 109 of file CalypsoExtensionService.cpp.

◆ createCardTransaction()

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

Return a new card transaction manager to handle operations secured with a control 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
cardReaderThe 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 "calypsoCard" has a null or unknown product type.
Since
2.0.0

Definition at line 133 of file CalypsoExtensionService.cpp.

◆ createCardTransactionWithoutSecurity()

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

Returns a new card transaction manager to handle non-secured operations.

Parameters
cardReaderThe 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 "calypsoCard" has a null or unknown product type.
Since
2.0.0

Definition at line 145 of file CalypsoExtensionService.cpp.

◆ createSamResourceProfileExtension()

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

Returns a new instance of CardResourceProfileExtension to provide to the keyple::core::service::resource::CardResourceService service.

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 120 of file CalypsoExtensionService.cpp.

◆ createSamSecuritySetting()

std::shared_ptr< SamSecuritySetting > keyple::card::calypso::CalypsoExtensionService::createSamSecuritySetting ( ) const

Returns a new instance of SamSecuritySetting to use for secure SAM operations.

Returns
A not null reference.
Since
2.2.0

Definition at line 194 of file CalypsoExtensionService.cpp.

◆ createSamSelection()

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

Returns a new instance of CalypsoSamSelection to use when selecting a SAM.

Returns
A not null reference.
Since
2.0.0

Definition at line 114 of file CalypsoExtensionService.cpp.

◆ createSamTransaction()

std::shared_ptr< SamTransactionManager > keyple::card::calypso::CalypsoExtensionService::createSamTransaction ( std::shared_ptr< CardReader >  samReader,
const std::shared_ptr< CalypsoSam >  calypsoSam,
const std::shared_ptr< SamSecuritySetting >  samSecuritySetting 
) const

Returns a new SAM transaction manager to handle operations secured with a control SAM.

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

Parameters
samReaderThe reader through which the SAM communicates.
calypsoSamThe initial SAM data provided by the selection process.
samSecuritySettingThe security settings. @retur A not null reference.
Exceptions
IllegalArgumentExceptionIf one of the provided argument is null or if "calypsoSam" has a null or unknown product type.
Since
2.2.0

Definition at line 199 of file CalypsoExtensionService.cpp.

◆ createSamTransactionWithoutSecurity()

std::shared_ptr< SamTransactionManager > keyple::card::calypso::CalypsoExtensionService::createSamTransactionWithoutSecurity ( std::shared_ptr< CardReader >  samReader,
const std::shared_ptr< CalypsoSam >  calypsoSam 
) const

Returns a new SAM transaction manager to handle non-secured operations.

Parameters
samReaderThe reader through which the SAM communicates.
calypsoSamThe initial SAM data provided by the selection process.
Returns
A not null reference.
Exceptions
IllegalArgumentExceptionIf one of the provided argument is null or if "calypsoSam" has a null or unknown product type.
Since
2.2.0

Definition at line 207 of file CalypsoExtensionService.cpp.

◆ createSearchCommandData()

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

Returns a new instance of SearchCommandData to use to define the parameters of the CardTransactionManager::prepareSearchRecords(SearchCommandData) method.

Returns
A not null reference.
Since
2.1.0

Definition at line 76 of file CalypsoExtensionService.cpp.

◆ createTraceableSignatureComputationData()

std::shared_ptr< TraceableSignatureComputationData > keyple::card::calypso::CalypsoExtensionService::createTraceableSignatureComputationData ( ) const

Returns a new instance of TraceableSignatureComputationData to use to define the parameters of the CardTransactionManager::prepareComputeSignature(CommonSignatureComputationData) and SamTransactionManager::prepareComputeSignature(CommonSignatureComputationData) methods.

Returns
A not null reference.
Since
2.2.0

Definition at line 89 of file CalypsoExtensionService.cpp.

◆ createTraceableSignatureVerificationData()

std::shared_ptr< TraceableSignatureVerificationData > keyple::card::calypso::CalypsoExtensionService::createTraceableSignatureVerificationData ( ) const

Returns a new instance of TraceableSignatureVerificationData to use to define the parameters of the CardTransactionManager::prepareVerifySignature(CommonSignatureVerificationData) and SamTransactionManager::prepareVerifySignature(CommonSignatureVerificationData) methods.

Returns
A not null reference.
Since
2.2.0

Definition at line 103 of file CalypsoExtensionService.cpp.

◆ getCardApiVersion()

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

Definition at line 66 of file CalypsoExtensionService.cpp.

◆ getCommonApiVersion()

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

Definition at line 71 of file CalypsoExtensionService.cpp.

◆ getInstance()

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

Returns the service instance.

Returns
A not null reference.
Since
2.0.0

Definition at line 52 of file CalypsoExtensionService.cpp.

◆ getReaderApiVersion()

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

Definition at line 61 of file CalypsoExtensionService.cpp.

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