Qorus Integration Engine® Enterprise Edition 6.0.25_prod
Loading...
Searching...
No Matches
OMQ::QorusExtensionHandler Class Reference

this class is used to define a Qorus UI extension in a Qorus service More...

Inheritance diagram for OMQ::QorusExtensionHandler:
[legend]
Collaboration diagram for OMQ::QorusExtensionHandler:
[legend]

Public Member Methods

 constructor (string group, string menuname, string desc)
 creates the extension handler object from the arguments More...
 
string getGroup ()
 returns the group name
 
string getMenuName ()
 returns the menu name
 
string getDesc ()
 returns the description
 
- Public Member Methods inherited from OMQ::AbstractServiceHttpHandler
OMQ::ThreadLocalData otld ()
 thread-local data to add before calling handleRequest()
 
 constructor (string n_path, *softlist< auto > n_content_type, *softlist< auto > n_special_headers, HttpServer::AbstractAuthenticator n_auth=new DefaultQorusRBACAuthenticator(), bool n_isregex=True)
 creates the object with the given arguments More...
 
hash< auto > getServiceInfo ()
 returns a hash with info about the linked service
 
 addListener (hash< HttpServer::HttpListenerOptionInfo > opt)
 adds a listener from a bind string in the format: "address:port" (ex: "192.168.20.1:8011") More...
 
 addListener (softstring bind, hash< HttpServer::HttpListenerOptionInfo > opt)
 adds a listener from a bind string in the format: "address:port" (ex: "192.168.20.1:8011") More...
 
 addListener (softstring bind, *string cert_path, *string key_path, *string key_password, *hash< HttpServer::HttpListenerOptionInfo > opt)
 adds a listener from a bind string in the format: "address:port" (ex: "192.168.20.1:8011") More...
 
 addListener (softstring bind, *Qore::SSLCertificate cert, *Qore::SSLPrivateKey key, *hash< HttpServer::HttpListenerOptionInfo > opt)
 adds a listener from a bind string in the format: "address:port" (ex: "192.168.20.1:8011") More...
 
 addListeners (softlist< auto > l)
 adds a list of listeners from hash elements describing the listener More...
 
final *hash< auto > saveThreadLocalData ()
 called before handleRequest() More...
 
final restoreThreadLocalData (*hash< auto > data)
 called after handleRequest() with any data returned from saveThreadLocalData()
 
 log (int ll, string fmt,...)
 logs to the service log file
 
 setUserIndexInfo (string heading, string title, string url)
 sets heading and title for user HTTP services
 
 clearUserIndexInfo ()
 clears heading and title into for user HTTP services More...
 
hash< HttpResponseInfo > handleRequest (HttpListenerInterface listener, Socket s, hash< auto > cx, hash< auto > hdr, *data body)
 this method ensures that thread-local data is set properly
 
hash< auto > handleRequest (hash< auto > cx, hash< auto > hdr, *data body)
 This method calls handleRequestImpl() to service the request. More...
 
string getRequestPath (string hpath)
 returns the request path with the common leading part of the URL and also any URI query argument stripped
 
*hash< auto > handleRequestImpl (reference< hash< auto > > cx, hash< auto > hdr, *data body)
 This method is called by this class's handleRequest() More...
 
 setDefaultResource (string name)
 sets the default service file resource to be rendered More...
 
 setThreadContext (hash< auto > cx)
 Sets the service thread context. More...
 

Private Attributes

string group
 menu group
 
string menuname
 extension description
 
string desc
 extension description
 

Additional Inherited Members

- Static Public Member Methods inherited from OMQ::AbstractServiceHttpHandler
static AbstractServiceStream getServiceStreamRequestExtern (AbstractServiceHttpHandler hr, Socket s, hash< auto > cx, hash< auto > hdr, *data body)
 for calling the getServiceStreamRequestImpl() externally
 
static setServiceThreadContext (hash< auto > cx)
 Sets the service thread context. More...
 
- Public Attributes inherited from OMQ::AbstractServiceHttpHandler
string url
 The path string or regex to match incoming requests.
 
*softlist< auto > content_type
 the content-type to check
 
*softlist< auto > special_headers
 list of special headers; if a request has any of these HTTP headers, then the requests will match this handler
 
list< auto > listeners = ()
 list of listener info; do not write to this list directly More...
 
code svcc
 a closure that allows specific Service methods to be called
 
code svc_method_call
 a closure that allows any Service methods to be called
 
*string utype
 the type/heading for user HTTP services
 
*string utitle
 the title for user HTTP services
 
*string uurl
 the URL for user HTTP services
 
bool isregex
 if the path is a regex or a string
 
*string default_resource
 the default resource to serve
 
hash< auto > svcinfo
 service info hash
 
- Private Member Methods inherited from OMQ::AbstractServiceHttpHandler
AbstractStreamRequest getStreamRequestImpl (HttpListenerInterface listener, Socket s, hash< auto > cx, hash< auto > hdr, *data body)
 returns the AbstractStreamRequest object for handling chunked requests
 
AbstractServiceStream getServiceStreamRequestImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
 returns the AbstractStreamRequest object for handling chunked requests
 

Detailed Description

this class is used to define a Qorus UI extension in a Qorus service

See also
Note
When used in Stateless services, HTTP handlers are identified by a unique ID that is generated from the options used to create the object. To ensure that all stateless services use the same ID, you must ensure that the same options are used in each service's bindHttp() call. Failure to do this, for example my using a randomly-generated strings in the constructor, will cause runtime errors.

Member Function Documentation

◆ constructor()

OMQ::QorusExtensionHandler::constructor ( string  group,
string  menuname,
string  desc 
)

creates the extension handler object from the arguments

Parameters
groupthe menu group name; extensions with the same group name will be grouped together in the extension menu
menunamethe menu name for this extension
desca descriptive string for the UI extension

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