AbstractApduCommand.h

Go to the documentation of this file.

/**************************************************************************************************
 * Copyright (c) 2023 Calypso Networks Association https://calypsonet.org/                        *
 *                                                                                                *
 * See the NOTICE file(s) distributed with this work for additional information regarding         *
 * copyright ownership.                                                                           *
 *                                                                                                *
 * This program and the accompanying materials are made available under the terms of the Eclipse  *
 * Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0                  *
 *                                                                                                *
 * SPDX-License-Identifier: EPL-2.0                                                               *
 **************************************************************************************************/
 
#pragma once
 
#include <map>
#include <memory>
#include <string>
 
/* Keyple Card Calypso */
#include "ApduRequestAdapter.h"
#include "CalypsoApduCommandException.h"
#include "CardCommand.h"
 
/* Calypsonet Terminal Card */
#include "ApduResponseApi.h"
 
namespace keyple {
namespace card {
namespace calypso {
 
using namespace calypsonet::terminal::card;
 
class AbstractApduCommand {
public:
    class StatusProperties {
    public:
        StatusProperties(const std::string& information);
 
        StatusProperties(const std::string& information, const std::type_info& exceptionClass);
 
        const std::string& getInformation() const;
 
        bool isSuccessful() const;
 
        const std::type_info& getExceptionClass() const;
 
    private:
        const std::string mInformation;
 
        const bool mSuccessful;
 
        const std::type_info& mExceptionClass;
    };
 
    static const std::map<const int, const std::shared_ptr<StatusProperties>> STATUS_TABLE;
 
    AbstractApduCommand(const CardCommand& commandRef, const int expectedResponseLength);
 
    virtual void addSubName(const std::string& subName) final;
 
    virtual const CardCommand& getCommandRef() const;
 
    virtual const std::string& getName() const final;
 
    virtual void setExpectedResponseLength(const int expectedResponseLength) final;
 
    virtual void setApduRequest(const std::shared_ptr<ApduRequestAdapter> apduRequest) final;
 
    virtual const std::shared_ptr<ApduRequestAdapter> getApduRequest() const final;
 
    virtual void parseApduResponse(
        const std::shared_ptr<ApduResponseApi> apduResponse);
 
    virtual const std::shared_ptr<ApduResponseApi> getApduResponse() const final;
 
    virtual const std::map<const int, const std::shared_ptr<StatusProperties>>& getStatusTable()
        const;
 
    virtual const CalypsoApduCommandException buildCommandException(
        const std::type_info& exceptionClass, const std::string& message) const = 0;
 
    virtual const CalypsoApduCommandException buildUnexpectedResponseLengthException(
        const std::string& message) const = 0;
 
    virtual bool isSuccessful() const final;
 
    virtual const std::string getStatusInformation() const final;
 
private:
    const CardCommand& mCommandRef;
 
    int mExpectedResponseLength;
 
    std::string mName;
 
    std::shared_ptr<ApduRequestAdapter> mApduRequest;
 
    std::shared_ptr<ApduResponseApi> mApduResponse;
 
    virtual const std::shared_ptr<StatusProperties> getStatusWordProperties() const;
 
    virtual void checkStatus();
};
 
}
}
}