Qorus Integration Engine®  4.1.4.p2_git
remote Class Reference

main remote service class More...

Inherits QorusSystemService.

Static Public Member Methods

static QorusSystemAPIHelper get (string name)
 DEPRECATED: Setup and return a new OMQ::QorusSystemAPIHelper object to be used in user source code. More...
 
static QorusSystemRestHelper get_rest (string name)
 DEPRECATED: Setup and return a new OMQ::QorusSystemRestHelper object to be used in user source code. More...
 
static list get_remote_list ()
 DEPRECATED: Returns a list of non-local instances; loopback entries are filtered out.
 
static reload ()
 DEPRECATED: Refresh cached remote instances. More...
 
static list list ()
 DEPRECATED: Show available instances in a list.
 
static hash get_config (*string name)
 DEPRECATED: Returns a hash giving the configuration of the given connection; this is internal in order to prohibit login info from being sent in external calls. More...
 
static hash info ()
 DEPRECATED: Return available instances as a hash keyed by name, where the value is the description of the connection. More...
 
static string ping_local ()
 DEPRECATED: Returns an informational string about the local instance; no network traffic is made. More...
 
static hash ping ()
 DEPRECATED: Test the remote connection(s). Optional argument 'name' can limit the ping to given remote instance. More...
 

Detailed Description

main remote service class

Member Function Documentation

◆ get()

static QorusSystemAPIHelper remote::get ( string  name)
inlinestatic

DEPRECATED: Setup and return a new OMQ::QorusSystemAPIHelper object to be used in user source code.

Parameters
namea string key/name of the remote instance
Returns
OMQ::QorusSystemAPIHelper instance; see OMQ::QorusSystemAPIHelperBase for full API
Exceptions
REMOTE-GET-ERRORThere is something wrong in the configuration; see error description for more info
Deprecated:
use get_remote_rpc_connection() instead
Note
- internal: True (this method can only be called internally)

◆ get_config()

static hash remote::get_config ( *string  name)
inlinestatic

DEPRECATED: Returns a hash giving the configuration of the given connection; this is internal in order to prohibit login info from being sent in external calls.

Note
- internal: True (this method can only be called internally)

◆ get_rest()

static QorusSystemRestHelper remote::get_rest ( string  name)
inlinestatic

DEPRECATED: Setup and return a new OMQ::QorusSystemRestHelper object to be used in user source code.

Parameters
namea string key/name of the remote instance
Returns
OMQ::QorusSystemRestHelper instance; see OMQ::QorusSystemRestHelperBase for full API
Exceptions
REMOTE-GET-ERRORThere is something wrong in the configuration; see error description for more info
Deprecated:
use get_remote_rest_connection() instead
Note
- internal: True (this method can only be called internally)

◆ info()

static hash remote::info ( )
inlinestatic

DEPRECATED: Return available instances as a hash keyed by name, where the value is the description of the connection.

Returns
a hash of available instances keyed by name, where the value is the description of the connection

◆ ping()

static hash remote::ping ( )
inlinestatic

DEPRECATED: Test the remote connection(s). Optional argument 'name' can limit the ping to given remote instance.

Returns
a hash with (name : connection info) from the remote instance values

◆ ping_local()

static string remote::ping_local ( )
inlinestatic

DEPRECATED: Returns an informational string about the local instance; no network traffic is made.

Deprecated:
use PUT /api/latest/remote/qorus/{name}?action=ping instead

◆ reload()

static remote::reload ( )
inlinestatic

DEPRECATED: Refresh cached remote instances.

It is necessary to call this method (or reset the service) when the configuration changes

Exceptions
REMOTE-LOAD-ERRORMissing config file or malformed syntax
FILE-OPEN2-ERRORerror opening configuration file

The documentation for this class was generated from the following file: