consul_interface.h

/*
MIT License Block

Copyright (c) 2016 Alex Barry

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

#ifndef AOSSL_CONSUL_INCLUDE_CONSUL_INTERFACE_H_
#define AOSSL_CONSUL_INCLUDE_CONSUL_INTERFACE_H_

#include <string.h>
#include <string>
#include <vector>

#include "aossl/core/include/buffers.h"

// ----------------------------Health Checks----------------------------------//

struct HealthCheck {
  std::string script;

  std::string interval;
};

// -------------------------------Service-------------------------------------//


class ServiceInterface {
 public:
  virtual ~ServiceInterface() {}

  virtual std::string to_json() const = 0;

  virtual std::string get_id() const = 0;

  virtual std::string get_name() const = 0;

  virtual std::string get_address() const = 0;

  virtual std::string get_port() const = 0;

  virtual void set_id(std::string new_id) = 0;

  virtual void set_name(std::string new_name) = 0;

  virtual void set_address(std::string new_address) = 0;

  virtual void set_port(std::string new_port) = 0;

  virtual std::vector<std::string> get_tags() = 0;
  virtual void add_tag(std::string new_tag) = 0;
  virtual void clear_tags() = 0;
  virtual int num_tags() const = 0;

  virtual HealthCheck get_check() = 0;
  virtual void set_check(std::string scr, int interval_seconds) = 0;
};

// ----------------------------Consul Admin-----------------------------------//


class ConsulInterface {
 public:


  virtual std::string base64_decode(std::string const& encoded_string) = 0;



  virtual AOSSL::StringBuffer* \
    base64_decode_safe(std::string const& encoded_string) = 0;

  virtual ~ConsulInterface() {}

  // -----------------Service Registry Functions------------------------------//


  virtual bool register_service(const ServiceInterface& s) = 0;


  virtual bool deregister_service(const ServiceInterface& s) = 0;

  // ------------Configuration Key-Value Storage Functions--------------------//



  virtual bool set_config_value(std::string key, std::string val) = 0;



  virtual std::string get_config_value(std::string key) = 0;


  virtual AOSSL::StringBuffer* get_config_value_safe(std::string key) = 0;

  virtual bool del_config_value(std::string key) = 0;

  // Basic Queries
  // All Return a JSON string

  // Local Agent Queries


  virtual std::string services() = 0;

  virtual AOSSL::StringBuffer* services_safe() = 0;


  virtual std::string agent_info() = 0;

  virtual AOSSL::StringBuffer* agent_info_safe() = 0;


  virtual std::string healthy_services() = 0;

  virtual AOSSL::StringBuffer* healthy_services_safe() = 0;

  // Catalog Queries


  virtual std::string datacenters() = 0;

  virtual AOSSL::StringBuffer* datacenters_safe() = 0;



  virtual std::string nodes_dc(std::string data_center) = 0;


  virtual AOSSL::StringBuffer* nodes_dc_safe(std::string data_center) = 0;



  virtual std::string services_dc(std::string data_center) = 0;


  virtual AOSSL::StringBuffer* services_dc_safe(std::string data_center) = 0;



  virtual std::string nodes_service(std::string service) = 0;


  virtual AOSSL::StringBuffer* nodes_service_safe(std::string service) = 0;


  virtual std::string \
    services_node(std::string node, std::string data_center) = 0;


  virtual AOSSL::StringBuffer* \
    services_node_safe(std::string node, std::string data_center) = 0;
};

#endif  // AOSSL_CONSUL_INCLUDE_CONSUL_INTERFACE_H_