jsoner Class Reference

class jsoner More...

#include <jsoner.hpp>

Inheritance diagram for jsoner:

Public Member Functions
	jsoner (const jsoner &ref)=default
	jsoner (jsoner &&ref) noexcept(false)=default
jsoner &	operator= (const jsoner &ref)=default
jsoner &	operator= (jsoner &&ref) noexcept(false)=default
virtual void	load_json (const json &source)=0
	setup the components from the json provided information More...
virtual json	save_json () const =0
	produce a json structure from the component configuration More...
virtual void	clear_json ()=0
	instruct the object to get to its default/initial configuration More...

Static Protected Member Functions
static json	wrap_config_with_json_header (unsigned int version, const std::string &class_id, const json &config)
	given a version, class_id and configuration generates the global and common json structure More...
static json	unwrap_config_from_json_header (const json &source, unsigned int &version, std::string &class_id)
	from a given json global and common json structure split header parts and return the config part More...

Static Protected Attributes
static constexpr const char *	jsoner_version_label = "version"
static constexpr const char *	jsoner_id_label = "class_id"
static constexpr const char *	jsoner_config_label = "config"

Detailed Description

class jsoner

jsoner class is the base class of all others that are able to save their status and read their status from a json formated configuration.

Examples

/home/denis/Webdar/webdar/src/html_form_input_file.hpp.

Member Function Documentation

clear_json()

virtual void jsoner::clear_json ( )

pure virtual

instruct the object to get to its default/initial configuration

Implemented in bibliotheque, guichet, html_archive_read, html_ciphering, html_compression_params, html_entrepot, html_entrepot_landing, html_form_dynamic_table, html_form_gnupg_list, html_form_ignore_as_symlink, html_form_input, html_form_input_file, html_form_mask_bool, html_form_mask_expression, html_form_mask_file, html_form_mask_subdir, html_form_overwrite_action, html_form_overwrite_base_criterium, html_form_overwrite_chain_action, html_form_overwrite_chain_cell, html_form_overwrite_combining_criterium, html_form_overwrite_conditional_action, html_form_overwrite_constant_action, html_form_same_fs, html_form_sig_block_size, html_fsa_scope, html_mask_form_filename, html_mask_form_path, html_options_compare, html_options_create, html_options_extract, html_options_isolate, html_options_merge, html_options_read, html_options_repair, html_options_test, html_over_guichet, and html_slicing.

load_json()

virtual void jsoner::load_json ( const json &  source )

pure virtual

setup the components from the json provided information

Parameters

[in]

source

json formated configuration to use for configuration

Note

exception exception_json should be throw if the provided data does not follow the expected structure

Implemented in bibliotheque, guichet, html_archive_read, html_ciphering, html_compression_params, html_entrepot, html_entrepot_landing, html_form_dynamic_table, html_form_gnupg_list, html_form_ignore_as_symlink, html_form_input, html_form_input_file, html_form_mask_bool, html_form_mask_expression, html_form_mask_file, html_form_mask_subdir, html_form_overwrite_action, html_form_overwrite_base_criterium, html_form_overwrite_chain_action, html_form_overwrite_chain_cell, html_form_overwrite_combining_criterium, html_form_overwrite_conditional_action, html_form_overwrite_constant_action, html_form_same_fs, html_form_sig_block_size, html_fsa_scope, html_mask_form_filename, html_mask_form_path, html_options_compare, html_options_create, html_options_extract, html_options_isolate, html_options_merge, html_options_read, html_options_repair, html_options_test, html_over_guichet, and html_slicing.

save_json()

virtual json jsoner::save_json ( ) const

pure virtual

produce a json structure from the component configuration

Returns

the current component configuration as a json object

Note

the json structure should contain:

• a json format version
• a json component identifier (name the class for example)
• an arbitrary configuration under { "version": num, "id": "class name", "config": {...} } see the protected static methods that implement this.

Implemented in bibliotheque, guichet, html_archive_read, html_ciphering, html_compression_params, html_entrepot, html_entrepot_landing, html_form_dynamic_table, html_form_gnupg_list, html_form_ignore_as_symlink, html_form_input, html_form_input_file, html_form_mask_bool, html_form_mask_expression, html_form_mask_file, html_form_mask_subdir, html_form_overwrite_action, html_form_overwrite_base_criterium, html_form_overwrite_chain_action, html_form_overwrite_chain_cell, html_form_overwrite_combining_criterium, html_form_overwrite_conditional_action, html_form_overwrite_constant_action, html_form_same_fs, html_form_sig_block_size, html_fsa_scope, html_mask_form_filename, html_mask_form_path, html_options_compare, html_options_create, html_options_extract, html_options_isolate, html_options_merge, html_options_read, html_options_repair, html_options_test, html_over_guichet, and html_slicing.

unwrap_config_from_json_header()

json jsoner::unwrap_config_from_json_header ( const json &  source, unsigned int &  version, std::string &  class_id  )

staticprotected

from a given json global and common json structure split header parts and return the config part

Parameters

[in]	source	the global json configuration to apply to the current object
[in]	version	the format and expected fields of the returned json configuration
[in]	class_id	should match the name of the class this static method is used by

Returns

inherited class specific data to apply to the current object following the format version 'version'

Note

may throw exception upon format error regarding expected json fields.

wrap_config_with_json_header()

json jsoner::wrap_config_with_json_header ( unsigned int  version, const std::string &  class_id, const json &  config  )

staticprotected

given a version, class_id and configuration generates the global and common json structure

Parameters

[in]	version	define the expected field and structure of the config json parameter
[in]	class_id	is expected to be the class name that implements the jsoner interface
[in]	config	this is the resulting current configuration as a json object to be wrapped wil version and class_id.

---

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

• jsoner.hpp
• jsoner.cpp