Qore ConnectionProvider Module Reference  1.5
AbstractConnection.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
2 // Qore AbstractConnection class definition
3 
4 /* AbstractConnection.qc Copyright 2016 - 2021 Qore Technologies, s.r.o.
5 
6  Permission is hereby granted, free of charge, to any person obtaining a
7  copy of this software and associated documentation files (the "Software"),
8  to deal in the Software without restriction, including without limitation
9  the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  and/or sell copies of the Software, and to permit persons to whom the
11  Software is furnished to do so, subject to the following conditions:
12 
13  The above copyright notice and this permission notice shall be included in
14  all copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  DEALINGS IN THE SOFTWARE.
23 */
24 
26 namespace ConnectionProvider {
28 
32 class AbstractConnection : public Serializable {
33 
34 public:
36  string name;
37 
39  string desc;
40 
42  string url;
43 
45  string safe_url;
46 
48  *hash<auto> orig_opts;
49 
51  *hash<auto> opts;
52 
54  hash<auto> urlh;
55 
58 
60  string status = "not checked";
61 
63  bool up = False;
64 
66  bool monitor;
67 
70 
72  bool loopback = False;
73 
75  static *code post_processing;
76 
78  bool enabled = True;
79 
81  bool locked = False;
82 
84  bool debug_data = False;
85 
87  hash<auto> tags = {};
88 
90  hash<auto> internal_info;
91 
93 
102  deprecated
103 constructor(string n_name, string n_desc, string n_url, bool n_monitor, *hash n_opts, hash n_urlh, *string n_safe_url, *bool n_enabled);
104 
105 
107 
124  constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {});
125 
126 
128 
132  hash<PingInfo> ping(bool throw_exception = False);
133 
134 
136 protected:
137  hash<PingInfo> pingIntern(hash<PingInfo> rv);
138 public:
139 
140 
142 
148  hash<ConnectionInfo> getInfo(bool with_password = False);
149 
150 
152 
157  hash<ConnectionInfo> getInfo(*hash<auto> opts);
158 
159 
161 
165  hash<auto> getExtendedInfo(*hash<auto> opts);
166 
167 
169 
171  hash<ConfigInfo> getConfigHash();
172 
173 
175  hash<ConnectionSchemeInfo> getConnectionSchemeInfo();
176 
177 
179  *hash<auto> getOptions();
180 
181 
183  *hash<auto> getRuntimeOptions();
184 
185 
187  *hash<auto> getDefaultOptions();
188 
189 
191  *hash<auto> getRealOptions();
192 
193 
195 
197  object get(bool connect = True, *hash<auto> rtopts);
198 
199 
201 
204 
205 
207  hash<auto> getTags();
208 
209 
211  auto getTag(string tag);
212 
213 
215 
217  auto getTagEx(string tag);
218 
219 
221 
232  AbstractDataProvider getDataProvider();
233 
234 
236 
245  bool hasDataProvider();
246 
247 
249 
257 protected:
258  hash<UrlInfo> parseUrl(string url);
259 public:
260 
261 
263 
276 protected:
277  string getSafeUrl(hash<auto> urlh);
278 public:
279 
280 
282 
289 protected:
290  hash<auto> validateOptions(hash<auto> options);
291 public:
292 
293 
295 
298 private:
299  constructorInit(string name, string description, string url, hash<auto> attributes, hash<auto> options);
300 public:
301 
302 
304  abstract string getType();
305 
307 
312 protected:
313  abstract object getImpl(bool connect = True, *hash<auto> rtopts);
314 public:
315 };
316 }; // ConnectionProvider namespace
parseTextOptions()
this method is called when parsing connection file definitions from text files when loading into the ...
auto getTag(string tag)
returns the value of the given tag or NOTHING if not present
bool monitor
monitoring flag
Definition: AbstractConnection.qc.dox.h:66
date date(date dt)
hash< auto > getExtendedInfo(*hash< auto > opts)
Returns connection info plus any extended information returned by the connection. ...
hash< auto > internal_info
internal tags
Definition: AbstractConnection.qc.dox.h:90
date last_check
date/time of last check/ping
Definition: AbstractConnection.qc.dox.h:57
bool locked
locked/unlocked flag
Definition: AbstractConnection.qc.dox.h:81
hash< ConnectionInfo > getInfo(bool with_password=False)
returns a ConnectionInfo hash of information about the connection
string getSafeUrl(hash< auto > urlh)
creates a "safe" URL string with password information removed
*hash< auto > getOptions()
returns static / initialization options
const True
deprecated constructor(string n_name, string n_desc, string n_url, bool n_monitor, *hash n_opts, hash n_urlh, *string n_safe_url, *bool n_enabled)
creates the AbstractConnection object
string name
connection name
Definition: AbstractConnection.qc.dox.h:36
hash< auto > urlh
broken down URL hash (as returned by Qore::parse_url())
Definition: AbstractConnection.qc.dox.h:54
hash< ConnectionSchemeInfo > getConnectionSchemeInfo()
Returns a default ConnectionSchemeInfo hash.
*hash< auto > opts
connection options
Definition: AbstractConnection.qc.dox.h:51
static *code post_processing
optional code for default post-processing of objects created by getImpl(); must take the connection o...
Definition: AbstractConnection.qc.dox.h:75
hash< PingInfo > ping(bool throw_exception=False)
returns a hash with the results of the ping operation
const False
string status
status string; in case of a connection error this string will be the error string ...
Definition: AbstractConnection.qc.dox.h:60
hash< auto > tags
connection tags; user-defined key-value pairs
Definition: AbstractConnection.qc.dox.h:87
bool hasDataProvider()
returns True if the connection returns a data provider with the getDataProvider() method ...
abstract base class for connections
Definition: AbstractConnection.qc.dox.h:32
AbstractDataProvider getDataProvider()
returns a data provider object for this connection, if supported
string safe_url
"safe" URL (password information removed)
Definition: AbstractConnection.qc.dox.h:45
*hash< auto > getRealOptions()
returns options for saving the connection&#39;s configuration information
bool enabled
enabled/disabled indicator flag
Definition: AbstractConnection.qc.dox.h:78
auto getTagEx(string tag)
returns the value of the given tag or throws an exception if the tag is not set with a value ...
constructorInit(string name, string description, string url, hash< auto > attributes, hash< auto > options)
Common construtor implementation.
abstract object getImpl(bool connect=True, *hash< auto > rtopts)
this method must return the connection object corresponding to the object&#39;s configuration ...
abstract string getType()
returns the string type name for the connection object
hash< ConfigInfo > getConfigHash()
returns a ConfigInfo hash of static configuration information about the connection ...
hash< auto > getTags()
returns all tags associated with the connection
string desc
connection description
Definition: AbstractConnection.qc.dox.h:39
hash< auto > hash(object obj)
date updated
date/time of last update
Definition: AbstractConnection.qc.dox.h:69
hash< auto > validateOptions(hash< auto > options)
performs options validation in the constructor
hash< UrlInfo > parseUrl(string url)
Parse the URL to a hash.
bool up
connection status flag; set by monitoring or explicit pings/connections
Definition: AbstractConnection.qc.dox.h:63
*hash< auto > getRuntimeOptions()
returns runtime options
string url
connection URL (potentially with password info)
Definition: AbstractConnection.qc.dox.h:42
bool debug_data
debug data flag; to be used an an indication for a higher-level implementation
Definition: AbstractConnection.qc.dox.h:84
*hash< auto > orig_opts
original connection options
Definition: AbstractConnection.qc.dox.h:48
hash< PingInfo > pingIntern(hash< PingInfo > rv)
performs the ping by executing get(); returns a PingInfo hash
bool loopback
set to True for loopback connections
Definition: AbstractConnection.qc.dox.h:72
the ConnectionProvider namespace. All classes used in the ConnectionProvider module should be inside ...
Definition: AbstractConnection.qc.dox.h:26
*hash< auto > getDefaultOptions()
returns default options