ConnectionSchemeCache.qc.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
namespace ConnectionProvider {
public hashdecl ConnectionOptionInfo {
    string display_name;
 
    string short_desc;
 
    string desc;
 
    string type;
 
    bool sensitive = False;
 
    bool multiselect;
 
    *softlist<hash<Util::AllowedValueInfo>> allowed_values;
 
    *bool allowed_values_creatable;
 
    *softlist<hash<Util::AllowedValueInfo>> element_allowed_values;
 
    *bool element_allowed_values_creatable;
 
    auto default_value;
 
    bool subst_env_vars = False;
 
    bool freeform = False;
 
    auto example_value;
};
 
public hashdecl ConnectionSchemeInfo {
    string display_name;
 
    string short_desc;
 
    string desc;
 
 
    hash<string, bool> schemes;
 
    hash<string, string> base_scheme_map;
 
    Class cls;
 
    *hash<string, hash<ConnectionOptionInfo>> options;
 
    *hash<string, bool> sensitive_options;
 
    bool auto_url = False;
 
 
    *string required_options;
};
 
class ConnectionSchemeCache {
 
public:
        const SchemeMap = ...;
 
 
protected:
        static hash<string, hash<ConnectionSchemeInfo>> cache = {
            "ftp": FtpConnection::ConnectionScheme,
            "ftps": FtpConnection::ConnectionScheme,
 
            "dir": FilesystemConnection::ConnectionScheme,
            "file": FilesystemConnection::ConnectionScheme,
 
            "http": HttpConnection::ConnectionScheme,
            "https": HttpConnection::ConnectionScheme,
        };
 
        static hash<string, code> initmap;
 
        static Mutex lck();
 
        static bool load_all;
 
public:
 
 
      static registerPendingScheme(string scheme, code init);
 
 
      static bool registerScheme(string scheme, hash<ConnectionSchemeInfo> entry);
 
 
      static *hash<ConnectionSchemeInfo> deregisterScheme(string scheme);
 
      static hash<string, hash<ConnectionSchemeInfo>> getLoadAll();
 
      static hash<string, hash<ConnectionSchemeInfo>> get();
 
      static int size();
 
      static bool empty();
 
 
      static *list<string> listSchemes();
 
 
      static *hash<ConnectionSchemeInfo> getScheme(string scheme);
 
 
      static hash<ConnectionSchemeInfo> getSchemeEx(string scheme);
 
 
      static *hash<ConnectionSchemeInfo> getSchemeImpl(string scheme, bool throw_exception, *code scheme_loader);
 
 
      static *hash<auto> getDefaultOptionValues(string scheme);
 
 
      static *hash<auto> getDefaultOptionValues(hash<ConnectionSchemeInfo> scheme_info);
 
 
      static hash<auto> validateConnectionOptions(string conn_name, string scheme, hash<auto> options, bool check_required = True);
 
 
      static hash<auto> validateConnectionOptions(string conn_name, hash<ConnectionSchemeInfo> scheme_info, hash<auto> options, bool check_required = True);
 
protected:
      static bool tryLoadModule(string mod, bool throw_exception);
public:
 
 
 
private:
      static deregisterSchemeIntern(string scheme);
public:
 
};
};