keyple::card::calypso::AbstractCardCommand Class Reference

#include <AbstractCardCommand.h>

Inheritance diagram for keyple::card::calypso::AbstractCardCommand:

Collaboration diagram for keyple::card::calypso::AbstractCardCommand:

Public Member Functions
	AbstractCardCommand (const CalypsoCardCommand &commandRef, const int le)
const CalypsoCardCommand &	getCommandRef () const override
virtual bool	isSessionBufferUsed () const =0
const CalypsoApduCommandException	buildCommandException (const std::type_info &exceptionClass, const std::string &message) const final
const CalypsoApduCommandException	buildUnexpectedResponseLengthException (const std::string &message) const final
AbstractCardCommand &	setApduResponse (const std::shared_ptr< ApduResponseApi > apduResponse) override
void	checkStatus () override
Public Member Functions inherited from keyple::card::calypso::AbstractApduCommand
	AbstractApduCommand (const CardCommand &commandRef, const int le)
virtual void	addSubName (const std::string &subName) final
virtual const std::string &	getName () const final
virtual void	setApduRequest (const std::shared_ptr< ApduRequestAdapter > apduRequest) final
virtual const std::shared_ptr< ApduRequestAdapter >	getApduRequest () const final
virtual const std::shared_ptr< ApduResponseApi >	getApduResponse () const final
virtual const std::map< const int, const std::shared_ptr< StatusProperties > > &	getStatusTable () const
virtual bool	isSuccessful () const final
virtual const std::string	getStatusInformation () const final

Additional Inherited Members
Static Public Attributes inherited from keyple::card::calypso::AbstractApduCommand
static const std::map< const int, const std::shared_ptr< StatusProperties > >	STATUS_TABLE

Detailed Description

(package-private)
Superclass for all card commands.

Since

2.0.1

Definition at line 29 of file AbstractCardCommand.h.

Constructor & Destructor Documentation

AbstractCardCommand()

keyple::card::calypso::AbstractCardCommand::AbstractCardCommand	(	const CalypsoCardCommand &	commandRef,
		const int	le
	)

(package-private)
Constructor dedicated for the building of referenced Calypso commands

Parameters

commandRef	a command reference from the Calypso command table.
le	The value of the LE field.

Since

2.0.1

Definition at line 34 of file AbstractCardCommand.cpp.

Member Function Documentation

buildCommandException()

const CalypsoApduCommandException keyple::card::calypso::AbstractCardCommand::buildCommandException ( const std::type_info &  exceptionClass, const std::string &  message  ) const

finalvirtual

(package-private)
Builds a specific APDU command exception.

Parameters

message

The message.

Returns

A not null reference.

A not null value

Since

2.0.1

Since

2.0.1

Implements keyple::card::calypso::AbstractApduCommand.

Definition at line 42 of file AbstractCardCommand.cpp.

buildUnexpectedResponseLengthException()

const CalypsoApduCommandException keyple::card::calypso::AbstractCardCommand::buildUnexpectedResponseLengthException ( const std::string &  message ) const

finalvirtual

(package-private)
Builds a specific APDU command exception for the case of an unexpected response length.

Parameters

message

The message.

Returns

A not null reference.

Since

2.1.1

Since

2.1.1

Implements keyple::card::calypso::AbstractApduCommand.

Definition at line 73 of file AbstractCardCommand.cpp.

checkStatus()

void keyple::card::calypso::AbstractCardCommand::checkStatus ( )

overridevirtual

(package-private)
This method check the status word and if the length of the response is equal to the LE field in the request.
If status word is not referenced, then status is considered unsuccessful.

Exceptions

CalypsoApduCommandException

if status is not successful or if the length of the response is not equal to the LE field in the request.

Since

2.0.1

Since

2.0.1

Reimplemented from keyple::card::calypso::AbstractApduCommand.

Definition at line 88 of file AbstractCardCommand.cpp.

getCommandRef()

const CalypsoCardCommand & keyple::card::calypso::AbstractCardCommand::getCommandRef ( ) const

overridevirtual

(package-private)
Gets CardCommand the current command identification

Returns

A not null reference.

Since

2.0.1

Since

2.0.1

Reimplemented from keyple::card::calypso::AbstractApduCommand.

Definition at line 37 of file AbstractCardCommand.cpp.

isSessionBufferUsed()

virtual bool keyple::card::calypso::AbstractCardCommand::isSessionBufferUsed ( ) const

pure virtual

(package-private)
Indicates if the session buffer is used when executing this command.

Allows the management of the overflow of this buffer.

Returns

True if this command uses the session buffer

Since

2.0.1

Implemented in keyple::card::calypso::CmdCardAppendRecord, keyple::card::calypso::CmdCardChangeKey, keyple::card::calypso::CmdCardChangePin, keyple::card::calypso::CmdCardCloseSession, keyple::card::calypso::CmdCardGetChallenge, keyple::card::calypso::CmdCardGetDataEfList, keyple::card::calypso::CmdCardGetDataFci, keyple::card::calypso::CmdCardGetDataFcp, keyple::card::calypso::CmdCardGetDataTraceabilityInformation, keyple::card::calypso::CmdCardIncreaseOrDecrease, keyple::card::calypso::CmdCardIncreaseOrDecreaseMultiple, keyple::card::calypso::CmdCardInvalidate, keyple::card::calypso::CmdCardOpenSession, keyple::card::calypso::CmdCardReadBinary, keyple::card::calypso::CmdCardReadRecordMultiple, keyple::card::calypso::CmdCardReadRecords, keyple::card::calypso::CmdCardRehabilitate, keyple::card::calypso::CmdCardSearchRecordMultiple, keyple::card::calypso::CmdCardSelectFile, keyple::card::calypso::CmdCardSvDebitOrUndebit, keyple::card::calypso::CmdCardSvGet, keyple::card::calypso::CmdCardSvReload, keyple::card::calypso::CmdCardUpdateOrWriteBinary, keyple::card::calypso::CmdCardUpdateRecord, keyple::card::calypso::CmdCardVerifyPin, and keyple::card::calypso::CmdCardWriteRecord.

setApduResponse()

AbstractCardCommand & keyple::card::calypso::AbstractCardCommand::setApduResponse ( const std::shared_ptr< ApduResponseApi >  apduResponse )

overridevirtual

(package-private)
Sets the command ApduResponseApi.

Parameters

apduResponse

The APDU response.

Returns

The current instance.

Since

2.0.1

Since

2.0.1

Reimplemented from keyple::card::calypso::AbstractApduCommand.

Reimplemented in keyple::card::calypso::CmdCardCloseSession, keyple::card::calypso::CmdCardGetDataFci, keyple::card::calypso::CmdCardIncreaseOrDecreaseMultiple, keyple::card::calypso::CmdCardOpenSession, keyple::card::calypso::CmdCardReadRecordMultiple, keyple::card::calypso::CmdCardReadRecords, keyple::card::calypso::CmdCardSearchRecordMultiple, keyple::card::calypso::CmdCardSvDebitOrUndebit, keyple::card::calypso::CmdCardSvGet, and keyple::card::calypso::CmdCardSvReload.

Definition at line 82 of file AbstractCardCommand.cpp.

---

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

• /github/workspace/src/main/AbstractCardCommand.h
• /github/workspace/src/main/AbstractCardCommand.cpp