Provision_Callback.h

Go to the documentation of this file.

#ifndef Provision_Callback_h
#define Provision_Callback_h
 
// Local includes.
#include "Timeoutable_Request.h"
 
 
struct Access_Token{};
 
struct Device_Access_Token{};
 
struct Basic_MQTT_Credentials{};
 
struct X509_Certificate{};
 
 
class Provision_Callback : public Callback<void, JsonDocument const &> {
  public:
    Provision_Callback() = default;
 
    Provision_Callback(Access_Token, function callback, char const * provision_device_key, char const * provision_device_secret, char const * device_name = nullptr, uint64_t const & timeout_microseconds = 0U, Callback_Watchdog::function timeout_callback = nullptr);
 
    Provision_Callback(Device_Access_Token, function callback, char const * provision_device_key, char const * provision_device_secret, char const * access_token, char const * device_name = nullptr, uint64_t const & timeout_microseconds = 0U, Callback_Watchdog::function timeout_callback = nullptr);
 
    Provision_Callback(Basic_MQTT_Credentials, function callback, char const * provision_device_key, char const * provision_device_secret, char const * username, char const * password, char const * client_id, char const * device_name = nullptr, uint64_t const & timeout_microseconds = 0U, Callback_Watchdog::function timeout_callback = nullptr);
 
    Provision_Callback(X509_Certificate, function callback, char const * provision_device_key, char const * provision_device_secret, char const * hash, char const * device_name = nullptr, uint64_t const & timeout_microseconds = 0U, Callback_Watchdog::function timeout_callback = nullptr);
 
    ~Provision_Callback() override = default;
 
    char const * Get_Device_Key() const;
 
    void Set_Device_Key(char const * provision_device_key);
 
    char const * Get_Device_Secret() const;
 
    void Set_Device_Secret(char const * provision_device_secret);
 
    char const * Get_Device_Name() const;
 
    void Set_Device_Name(char const * device_name) ;
 
    char const * Get_Device_Access_Token() const;
 
    void Set_Device_Access_Token(char const * access_token);
 
    char const * Get_Credentials_Username() const;
 
    void Set_Credentials_Username(char const * username);
 
    char const * Get_Credentials_Password() const;
 
    void Set_Credentials_Password(char const * password);
 
    char const * Get_Credentials_Client_ID() const;
 
    void Set_Credentials_Client_ID(char const * client_id);
 
    char const * Get_Certificate_Hash() const;
 
    void Set_Certificate_Hash(char const * hash);
 
    char const * Get_Credentials_Type() const;
 
    Timeoutable_Request & Get_Request_Timeout();
 
  private:
    char const          *m_device_key = {};          // Device Profile provisioning key
    char const          *m_device_secret = {};       // Device Profile provisioning secret
    char const          *m_device_name = {};         // Device name the provisioned device should have
    char const          *m_access_token = {};        // Access token supplied by the device, if it should not be generated by the server instead
    char const          *m_cred_username = {};       // MQTT credential username, if the MQTT basic credentials method is used
    char const          *m_cred_password = {};       // MQTT credential password, if the MQTT basic credentials method is used
    char const          *m_cred_client_id = {};      // MQTT credential client_id, if Mthe QTT basic credentials method is used
    char const          *m_hash = {};                // X.509 certificate hash, if the X.509 certificate authentication method is used
    char const          *m_credentials_type = {};    // Credentials type we are requesting from the server, nullptr for the default option (Credentials generated by the ThingsBoard server)
    Timeoutable_Request m_request_timeout = {}; // Handles callback that will be called if request times out
};
 
#endif // Provision_Callback_h