base class for HTTP-based connections that need their URLs rewritten to create the real connection object
More...
|
| | constructor (hash< auto > config, *hash< auto > attr) |
| | Creates the connection object. More...
|
| |
| | constructor (string name, string desc, string url, hash< auto > attributes, hash< auto > options, *Logger logger) |
| | Creates the connection object. More...
|
| |
| Qore::AbstractPollOperation | startPollConnect () |
| | Called to start the connection if the connection supports the polling API. More...
|
| |
| bool | supportsPollingApi () |
| | returns True, since this connection type supports the Qore Socket-based polling API More...
|
| |
| | constructor (hash< auto > config, *hash< auto > attr) |
| | creates the AbstractConnectionWithInfo object More...
|
| |
| | constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={}, *Logger logger) |
| | creates the AbstractConnectionWithInfo object More...
|
| |
|
hash< ConnectionSchemeInfo > | getConnectionSchemeInfo () |
| | Returns the ConnectionSchemeInfo hash for this object.
|
| |
|
*hash< auto > | getDefaultOptions () |
| | returns default options
|
| |
|
*hash< auto > | getOptions () |
| | returns static / initialization options
|
| |
| | constructor (hash< auto > config, *hash< auto > attr) |
| | creates the AbstractConnection object More...
|
| |
| deprecated | constructor (string name, string desc, string url, bool monitor, *hash opts, hash urlh, *string safe_url, *bool enabled) |
| | creates the AbstractConnection object More...
|
| |
| deprecated | constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={}, *LoggerInterface logger) |
| | creates the AbstractConnection object More...
|
| |
| object | get (bool connect=True, *hash< auto > rtopts) |
| | returns the underlying connection object More...
|
| |
| hash< ConfigInfo > | getConfigHash () |
| | returns a ConfigInfo hash of static configuration information about the connection More...
|
| |
|
*hash< auto > | getConnectionOptions (*hash< auto > rtopts) |
| | returns options for creating a new connection
|
| |
|
hash< ConnectionSchemeInfo > | getConnectionSchemeInfo () |
| | Returns a default ConnectionSchemeInfo hash.
|
| |
|
hash< ConnectionSchemeInfo > | getConnectionSchemeInfoImpl () |
| | Override in subclasses to return a native ConnectionSchemeInfo hash.
|
| |
| AbstractDataProvider | getDataProvider (*hash< auto > constructor_options) |
| | returns a data provider object for this connection, if supported More...
|
| |
| AbstractDataProvider | getDataProvider (string subtype, *hash< auto > constructor_options) |
| | Returns a data provider object for the connection and subtype passed as an argument. More...
|
| |
| *hash< string, hash< DataProviderOptionInfo > > | getDataProviderConstructorOptions () |
| | Returns a hash of data provider constructor option info, if applicable. More...
|
| |
| *hash< string, *hash< string, hash< DataProviderOptionInfo > > > | getDataProviderSubtypes () |
| | Returns a hash of supported data provider subtypes and constructor option info. More...
|
| |
|
*hash< auto > | getDefaultOptions () |
| | returns default options
|
| |
| string | getDescription () |
| | Returns the connection description. More...
|
| |
| string | getDisplayName () |
| | Returns the connection display name. More...
|
| |
| hash< auto > | getExtendedInfo (*hash< auto > opts) |
| | Returns connection info plus any extended information returned by the connection. More...
|
| |
| hash< auto > | getExtendedInfoAsData (*hash< auto > opts) |
| | Returns connection info plus any extended information returned by the connection. More...
|
| |
| *hash< string, bool > | getFeatures () |
| | Returns a list of connection-defined features. More...
|
| |
| hash< ConnectionInfo > | getInfo (*hash< auto > opts) |
| | returns a ConnectionInfo hash of information about the connection More...
|
| |
| hash< ConnectionInfo > | getInfo (bool with_password=False) |
| | returns a ConnectionInfo hash of information about the connection More...
|
| |
| hash< ConnectionDataInfo > | getInfoAsData (*hash< auto > opts) |
| | Returns a ConnectionDataInfo hash of information about the connection. More...
|
| |
| string | getName () |
| | Returns the connection name. More...
|
| |
|
*hash< auto > | getOptions () |
| | returns static / initialization options
|
| |
| object | getPollImpl () |
| | Returns an unconnected object for a non-blocking poll operation. More...
|
| |
|
*hash< auto > | getRealOptions () |
| | returns options for saving the connection's configuration information
|
| |
|
*hash< auto > | getRuntimeOptions () |
| | returns runtime options
|
| |
| string | getSafeUrl () |
| | Returns the connection safe URL (without password info) More...
|
| |
| string | getShortDescription () |
| | Returns the connection short description. More...
|
| |
|
auto | getTag (string tag) |
| | returns the value of the given tag or NOTHING if not present
|
| |
| auto | getTagEx (string tag) |
| | returns the value of the given tag or throws an exception if the tag is not set with a value More...
|
| |
|
hash< auto > | getTags () |
| | returns all tags associated with the connection
|
| |
|
abstract string | getType () |
| | returns the string type name for the connection object
|
| |
| string | getUrl () |
| | Returns the connection URL. More...
|
| |
|
| handlePingFailed (date delta, hash< ExceptionInfo > ex) |
| | Handles a failed ping operation on the connection.
|
| |
|
| handlePingFailed (date delta, string err) |
| | Handles a failed ping operation on the connection.
|
| |
|
| handlePingSuccess (date delta) |
| | Handles a successful ping operation on the connection.
|
| |
| bool | hasDataProvider () |
| | returns True if the connection returns a data provider with the getDataProvider() method More...
|
| |
| bool | needsAuth () |
| | Returns True if the connection requires OAuth2 authorization before it can be used. More...
|
| |
| | parseTextOptions () |
| | this method is called when parsing connection file definitions from text files when loading into the database More...
|
| |
| hash< PingInfo > | ping (bool throw_exception) |
| | returns a hash with the results of the ping operation More...
|
| |
| hash< PingInfo > | ping (int ping_flags=0) |
| | returns a hash with the results of the ping operation More...
|
| |
| Qore::AbstractPollOperation | startPollConnect () |
| | Called to start the connection polling operation. More...
|
| |
| bool | supportsPollingApi () |
| | returns True if the connection supports the Qore Socket-based polling API More...
|
| |
|
|
string | real_url |
| | A string containing the real URL using a http/https scheme.
|
| |
| const | CF_LOGGER = "logger" |
| | Connection feature: Logger support. More...
|
| |
| const | CF_UPDATE_OPTIONS = "update-options" |
| | Connection feature: Update Options support. More...
|
| |
|
bool | children_can_support_apis = False |
| | if the data provider or any of its children support requests (APIs)
|
| |
|
bool | children_can_support_messages = False |
| | if the data provider or any of its children support messages
|
| |
|
bool | children_can_support_observers = False |
| | if the data provider or any of its children support events
|
| |
|
bool | children_can_support_records = False |
| | if the data provider or any of its children support records
|
| |
|
bool | children_can_support_transactions = False |
| | if the data provider or any of its children support transaction management
|
| |
|
const | CommonConnectionKeys = ... |
| | Connection info keys mapped 1:1 to DataProviderOptionInfo keys.
|
| |
|
bool | debug_data = False |
| | debug data flag; to be used an an indication for a higher-level implementation
|
| |
|
const | DefaultDescription = "n/a; update connection to use the `AbstractConnectionWithInfo` class instead" |
| | Default option description.
|
| |
|
string | desc |
| | Connection description with markdown formatting.
|
| |
|
bool | disable_automatic_pings |
| | If automatic pings are disabled.
|
| |
|
string | display_name |
| | Display name.
|
| |
|
bool | enabled = True |
| | enabled/disabled indicator flag
|
| |
|
hash< auto > | internal_info |
| | internal tags (serializable)
|
| |
|
*date | last_check |
| | date/time of last check/ping
|
| |
|
bool | locked = False |
| | locked/unlocked flag
|
| |
|
bool | loopback = False |
| | set to True for loopback connections
|
| |
|
bool | monitor |
| | monitoring flag
|
| |
|
string | name |
| | Connection name.
|
| |
|
*hash< auto > | opts |
| | connection options
|
| |
|
*hash< auto > | orig_opts |
| | original connection options
|
| |
|
string | safe_url |
| | "safe" URL (password information removed)
|
| |
|
*string | short_desc |
| | Connection short description in plain text.
|
| |
|
string | status = "not checked" |
| | status string; in case of a connection error this string will be the error string
|
| |
|
hash< auto > | tags = {} |
| | connection tags; user-defined key-value pairs
|
| |
|
transient hash< auto > | transient_info |
| | internal transient tags (non-serializable)
|
| |
|
bool | up = True |
| | connection status flag; set by monitoring or explicit pings/connections
|
| |
|
date | updated |
| | date/time of last update
|
| |
|
string | url |
| | Connection URL (potentially with password info)
|
| |
|
hash< auto > | urlh |
| | broken down URL hash (as returned by Qore::parse_url())
|
| |
|
| | setRealUrl (string url) |
| | Called by the constructor to set the real URL. More...
|
| |
|
abstract hash< ConnectionSchemeInfo > | getConnectionSchemeInfoImpl () |
| | Returns the ConnectionSchemeInfo hash for this object.
|
| |
| *hash< string, hash< DataProviderOptionInfo > > | getDataProviderConstructorOptionsImpl () |
| | Returns a hash of data provider constructor option info, if applicable. More...
|
| |
| AbstractDataProvider | getDataProviderImpl (string subtype, *hash< auto > constructor_options) |
| | returns a data provider object for the connection and subtype passed as an argument More...
|
| |
| *hash< string, *hash< string, hash< DataProviderOptionInfo > > > | getDataProviderSubtypesImpl () |
| | Returns a hash of supported data provider subtypes. More...
|
| |
| *hash< string, bool > | getFeaturesImpl () |
| | Returns a hash of connection-defined features. More...
|
| |
| abstract object | getImpl (bool connect=True, *hash< auto > rtopts) |
| | this method must return the connection object corresponding to the object's configuration More...
|
| |
| string | getSafeUrl (hash< auto > urlh) |
| | creates a "safe" URL string with password information removed More...
|
| |
| *hash< auto > | getSubtypeOptions (*hash< string, hash< DataProviderOptionInfo > > subtype_options, *hash< auto > constructor_options) |
| | Returns options for each data provider subtype. More...
|
| |
| hash< UrlInfo > | parseUrl (string url) |
| | Parse the URL to a hash. More...
|
| |
| | pingImpl () |
| | performs the internal ping More...
|
| |
|
hash< PingInfo > | pingIntern (hash< PingInfo > rv) |
| | performs the ping by executing get(); returns a PingInfo hash
|
| |
|
| setChildCapabilities () |
| | Override to set child data provider capabilities once per child class.
|
| |
| hash< auto > | validateOptions (hash< auto > options, bool check_required=True) |
| | performs options validation in the constructor More...
|
| |
|
|
static hash< ConnectionOptionInfo > | getConnectionOptionInfo (hash< DataProviderOptionInfo > dinfo) |
| | Returns a ConnectionOptionInfo hash from a DataProviderOptionInfo hash.
|
| |
|
static hash< string, hash< ConnectionOptionInfo > > | getConnectionOptionInfo (hash< string, hash< DataProviderOptionInfo > > dinfo) |
| | Returns a hash of ConnectionOptionInfo hashes from a hash of DataProviderOptionInfo hashes.
|
| |
|
static *bool | getBool (*hash< auto > opts, string key, *bool required, *bool default_value) |
| | Returns a boolean value from a hash.
|
| |
|
static *hash< auto > | getHash (*hash< auto > opts, string key, *bool required, *hash< auto > default_value) |
| | Returns a hash value from a hash.
|
| |
|
static *int | getInt (*hash< auto > opts, string key, *bool required, *int default_value) |
| | Gets an integer option.
|
| |
|
static auto | getOptionType (*hash< auto > opts, string key, int type_code, string type_name, *bool required, auto default_value) |
| | gets an option value of the given type
|
| |
|
static *string | getString (*hash< auto > opts, string key, *bool required, *string default_value) |
| | Returns a string value from a hash.
|
| |
| static *code | post_processing |
| | optional code for default post-processing of objects created by getImpl() More...
|
| |
base class for HTTP-based connections that need their URLs rewritten to create the real connection object
Example of the usage is in RestConnection where the scheme rest:// is internally used as http://
Public Member Methods inherited from ConnectionProvider::AbstractConnectionWithInfo