ConnectionProvider::HttpBasedConnection Class Reference

base class for HTTP-based connections that need their URLs rewritten to create the real connection object More...

Inheritance diagram for ConnectionProvider::HttpBasedConnection:

Public Member Methods
	constructor (string name, string desc, string url, hash attributes, hash options)
	creates the invalid connection object More...
Public Member Methods inherited from ConnectionProvider::AbstractConnection
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 More...
	constructor (string name, string description, string url, hash attributes={}, hash options={})
	creates the AbstractConnection object More...
object	get (bool connect=True, *hash rtopts)
	returns the underlying connection object More...
hash< ConfigInfo >	getConfigHash ()
	returns a ConfigInfo hash of static configuration information about the connection More...
hash< ConnectionConstructorInfo >	getConstructorInfo ()
	returns a ConnectionConstructorInfo hash for creating the connection object dynamically More...
*hash	getDefaultOptions ()
	returns default options
hash< ConnectionInfo >	getInfo (bool with_password=False)
	returns a ConnectionInfo hash of information about the connection More...
*hash	getOptions ()
	returns static / initialization options
*hash	getRealOptions ()
	returns options for saving the connection's configuration information
*hash	getRuntimeOptions ()
	returns runtime options
abstract string	getType ()
	returns the string type name for the connection object
	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=False)
	returns a hash with the results of the ping operation More...
hash	validateOptions (hash options)
	performs options validation in the constructor More...

Public Attributes
string	real_url
	A string containing real url. With http(s) internal schema.
Public Attributes inherited from ConnectionProvider::AbstractConnection
string	desc
	connection description
bool	enabled = True
	enabled/disabled indicator flag
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	opts
	connection options
*hash	orig_opts
	original connection options
string	safe_url
	"safe" URL (password information removed)
string	status = "not checked"
	status string; in case of a connection error this string will be the error string
bool	up = False
	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	urlh
	broken down URL hash (as returned by Qore::parse_url())

Additional Inherited Members
Static Public Attributes inherited from ConnectionProvider::AbstractConnection
static *code	post_processing
	optional code for default post-processing of objects created by getImpl(); must take the object created and the connection name as arguments
Private Member Methods inherited from ConnectionProvider::AbstractConnection
abstract hash< ConnectionConstructorInfo >	getConstructorInfoImpl ()
	this method must return a ConnectionConstructorInfo hash for creating the connection object dynamically More...
abstract object	getImpl (bool connect=True, *hash rtopts)
	this method must return the connection object corresponding to the object's configuration More...
string	getSafeUrl (hash urlh)
	creates a "safe" URL string with password information removed More...
hash	parseUrl (string url)
	Parse the URL to a hash. More...
hash< PingInfo >	pingIntern (hash< PingInfo > rv)
	performs the ping by executing get(); returns a PingInfo hash

Detailed Description

base class for HTTP-based connections that need their URLs rewritten to create the real connection object

Example of the usage is in the RestConnection. Schema rest:// is internally used as http://

Member Function Documentation

constructor()

ConnectionProvider::HttpBasedConnection::constructor	(	string	name,
		string	desc,
		string	url,
		hash	attributes,
		hash	options
	)

creates the invalid connection object

Parameters

name	the name of the connection
description	connection description
url	connection URL (potentially with password info)
attributes	various attributes. See below
options	connection options

See AbstractConnection::constructor() for attributes and options reference.