Line data Source code
1 : /*
2 : ___________________________________________
3 : | _ ___ _ |
4 : | | | |__ \ | | |
5 : | | |__ ) |__ _ __ _ ___ _ __ | |_ |
6 : | | '_ \ / // _` |/ _` |/ _ \ '_ \| __| | HTTP/2 AGENT FOR MOCK TESTING
7 : | | | | |/ /| (_| | (_| | __/ | | | |_ | Version 0.0.z
8 : | |_| |_|____\__,_|\__, |\___|_| |_|\__| | https://github.com/testillano/h2agent
9 : | __/ | |
10 : | |___/ |
11 : |___________________________________________|
12 :
13 : Licensed under the MIT License <http://opensource.org/licenses/MIT>.
14 : SPDX-License-Identifier: MIT
15 : Copyright (c) 2021 Eduardo Ramos
16 :
17 : Permission is hereby granted, free of charge, to any person obtaining a copy
18 : of this software and associated documentation files (the "Software"), to deal
19 : in the Software without restriction, including without limitation the rights
20 : to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
21 : copies of the Software, and to permit persons to whom the Software is
22 : furnished to do so, subject to the following conditions:
23 :
24 : The above copyright notice and this permission notice shall be included in all
25 : copies or substantial portions of the Software.
26 :
27 : THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
28 : IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
29 : FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
30 : AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
31 : LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
32 : OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33 : SOFTWARE.
34 : */
35 :
36 : #pragma once
37 :
38 : #include <nlohmann/json.hpp>
39 :
40 : #include <Map.hpp>
41 : #include <JsonSchema.hpp>
42 :
43 :
44 : namespace h2agent
45 : {
46 : namespace model
47 : {
48 :
49 : /**
50 : * This class stores the global variables list.
51 : */
52 : class GlobalVariable : public Map<std::string, std::string>
53 : {
54 : mutable mutex_t rw_mutex_{};
55 :
56 : h2agent::jsonschema::JsonSchema global_variable_schema_{};
57 :
58 : public:
59 : GlobalVariable();
60 160 : ~GlobalVariable() = default;
61 :
62 : /**
63 : * Loads variable and value.
64 : * Append is done if variable already exists. This allows to use global variables
65 : * as memory buckets. To reset them, use 'eraser' source or just delete from
66 : * REST API.
67 : *
68 : * @param variable variable name
69 : * @param value value to append into variable
70 : */
71 : void load(const std::string &variable, const std::string &value);
72 :
73 : /**
74 : * Loads server data global operation data
75 : *
76 : * @param j Json document from operation body request
77 : *
78 : * @return Load operation result
79 : */
80 : bool loadJson(const nlohmann::json &j);
81 :
82 : /** Clears list
83 : *
84 : * @return Boolean about success of operation (something removed, nothing removed: already empty)
85 : */
86 : bool clear();
87 :
88 : /**
89 : * Json string representation for class information (json object)
90 : *
91 : * @return Json string representation ('{}' for empty object).
92 : */
93 : std::string asJsonString() const;
94 :
95 : /**
96 : * Gets the variable value for the variable name provided
97 : *
98 : * @param variableName Variable name for which the query was performed
99 : * @param exists Variable was found (true) or missing (false)
100 : *
101 : * @return variable value
102 : */
103 : std::string getValue(const std::string &variableName, bool &exists) const;
104 :
105 : /**
106 : * Removes the variable name provided from map
107 : *
108 : * @param variableName Variable name to be removed
109 : * @param exists Variable was found (true) or missing (false)
110 : */
111 : void removeVariable(const std::string &variableName, bool &exists);
112 :
113 : /**
114 : * Builds json document for class information
115 : *
116 : * @return Json object
117 : */
118 : nlohmann::json getJson() const;
119 :
120 : /**
121 : * Gets global variables schema
122 : */
123 1 : const h2agent::jsonschema::JsonSchema& getSchema() const {
124 1 : return global_variable_schema_;
125 : }
126 : };
127 :
128 : }
129 : }
130 :
|
