AbstractConnection.qc.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
// Qore AbstractConnection class definition
 
/*  AbstractConnection.qc Copyright 2016 - 2024 Qore Technologies, s.r.o.
 
    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.
*/
 
 
namespace ConnectionProvider {
const PF_THROW_EXCEPTION = (1 << 0);
 
 
const PF_AUTOMATIC_PING =  (1 << 1);
 
const CCS_UNSUPPORTED = "unsupported";
 
 
const CCS_UNCUSTOMIZED = "uncustomized";
 
 
const CCS_IN_PROGRESS = "in-progress";
 
 
const CCS_CUSTOMIZED = "customized";
 
 
class AbstractConnection : public Qore::Serializable, public Logger::LoggerWrapper, public OptionHelper {
 
public:
        string name;
 
        string display_name;
 
        *string short_desc;
 
        string desc;
 
        string url;
 
        string safe_url;
 
        string real_url;
 
        *hash<auto> orig_opts;
 
        *hash<auto> opts;
 
        hash<auto> urlh;
 
        *date last_check;
 
        string status = "not checked";
 
        bool up = True;
 
        bool monitor;
 
        date updated;
 
        bool loopback = False;
 
        bool supports_customization = False;
 
        string customization_status = CCS_UNSUPPORTED;
 
        *date customization_timestamp;
 
 
        static *code post_processing;
 
        bool enabled = True;
 
        bool locked = False;
 
        bool debug_data = False;
 
        hash<auto> tags = {};
 
        bool children_can_support_apis = False;
 
        bool children_can_support_records = False;
 
        bool children_can_support_observers = False;
 
        bool children_can_support_messages = False;
 
        bool children_can_support_transactions = False;
 
        hash<auto> internal_info;
 
        bool disable_automatic_pings;
 
        transient hash<auto> transient_info;
 
 
        const CF_LOGGER = "logger";
 
 
        const CF_UPDATE_OPTIONS = "update-options";
 
        const DefaultDescription = "n/a; update connection to use the `AbstractConnectionWithInfo` class instead";
 
        const CommonConnectionKeys = ...;
 
 
 
    deprecated
    constructor(string name, string desc, string url, bool monitor, *hash opts, hash urlh, *string safe_url, *bool enabled);
 
 
 
      deprecated constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {}, *LoggerInterface logger) ;
 
 
    constructor(hash<auto> config, *hash<auto> attr);
 
 
 
    string getName();
 
 
 
    string getDisplayName();
 
 
 
    string getShortDescription();
 
 
 
    string getDescription();
 
 
 
    string getUrl();
 
 
 
    string getSafeUrl();
 
 
 
    bool needsAuth();
 
 
 
    *string getAppName();
 
 
 
    hash<PingInfo> ping(bool throw_exception);
 
 
 
    hash<PingInfo> ping(int ping_flags = 0);
 
 
 
    persistInfo(AbstractConnection old);
 
 
 
    startCustomization(*bool restart);
 
 
protected:
     hash<PingInfo> pingIntern(hash<PingInfo> rv);
public:
 
 
 
    hash<ConnectionInfo> getInfo(bool with_password = False);
 
 
 
    hash<ConnectionInfo> getInfo(*hash<auto> opts);
 
 
 
    hash<ConnectionDataInfo> getInfoAsData(*hash<auto> opts);
 
 
 
    *hash<string, bool> getFeatures();
 
 
 
    hash<auto> getExtendedInfo(*hash<auto> opts);
 
 
 
    hash<auto> getExtendedInfoAsData(*hash<auto> opts);
 
 
 
    hash<ConfigInfo> getConfigHash();
 
 
    hash<ConnectionSchemeInfo> getConnectionSchemeInfo();
 
 
    hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
 
 
    *hash<auto> getOptions();
 
 
    *hash<auto> getRuntimeOptions();
 
 
    *hash<auto> getDefaultOptions();
 
 
    *hash<auto> getRealOptions();
 
 
    *hash<auto> getConnectionOptions(*hash<auto> rtopts);
 
 
 
    object get(bool connect = True, *hash<auto> rtopts);
 
 
 
    parseTextOptions();
 
 
    hash<auto> getTags();
 
 
    auto getTag(string tag);
 
 
 
    auto getTagEx(string tag);
 
 
 
    bool hasDataProvider();
 
 
 
    AbstractDataProvider getDataProvider(*hash<auto> constructor_options);
 
 
 
    AbstractDataProvider getDataProvider(string subtype, *hash<auto> constructor_options);
 
 
 
    *hash<string, hash<DataProviderOptionInfo>> getDataProviderConstructorOptions();
 
 
 
    *hash<string, *hash<string, hash<DataProviderOptionInfo>>> getDataProviderSubtypes();
 
 
 
    bool supportsPollingApi();
 
 
 
    Qore::AbstractPollOperation startPollConnect(*Logger::LoggerInterface logger);
 
 
 
    object getPollImpl();
 
 
    handlePingSuccess(date delta);
 
 
    handlePingFailed(date delta, hash<ExceptionInfo> ex);
 
 
    handlePingFailed(date delta, string err);
 
 
      static hash<ConnectionOptionInfo> getConnectionOptionInfo(hash<DataProviderOptionInfo> dinfo);
 
      static hash<string, hash<ConnectionOptionInfo>> getConnectionOptionInfo( hash<string, hash<DataProviderOptionInfo>> dinfo);
 
      static string getRealUrl(string url, hash<ConnectionSchemeInfo> info, string type);
 
 
protected:
     startCustomizationImpl();
public:
 
 
 
protected:
     AbstractDataProvider getDataProviderImpl(string subtype, *hash<auto> constructor_options);
public:
 
 
 
protected:
     *hash<string, hash<DataProviderOptionInfo>> getDataProviderConstructorOptionsImpl();
public:
 
 
 
protected:
     *hash<string, *hash<string, hash<DataProviderOptionInfo>>> getDataProviderSubtypesImpl();
public:
 
 
 
protected:
     *hash<auto> getSubtypeOptions(*hash<string, hash<DataProviderOptionInfo>> subtype_options, *hash<auto> constructor_options);
public:
 
 
 
protected:
     pingImpl();
public:
 
 
 
protected:
     hash<UrlInfo> parseUrl(string url);
public:
 
 
 
protected:
     string getSafeUrl(hash<auto> urlh);
public:
 
 
 
protected:
     hash<auto> validateOptions(hash<auto> options, bool check_required = True);
public:
 
 
 
private:
     constructorInit(hash<auto> config, *hash<auto> attr);
public:
 
 
 
protected:
     setRealUrl(*string url);
public:
 
 
 
protected:
     *hash<string, bool> getFeaturesImpl();
public:
 
 
protected:
     setChildCapabilities();
public:
 
 
    abstract string getType();
 
 
protected:
     abstract object getImpl(bool connect = True, *hash<auto> rtopts);
public:
};
}; // ConnectionProvider namespace