OMQ::AbstractServiceSoapHandler Class Reference

This class is used to customize and control the behavior of the Qorus HTTP server with SOAP messages. More...

Inherits OMQ::AbstractServiceHttpHandlerifdef QorusServer, and SoapHandler::SoapHandlerendif.

Public Member Methods
constructor(string path, HttpServer::AbstractAuthenticator auth=new DefaultQorusRBACAuthenticator()) hash< HttpResponseInfo >	handleRequest (HttpListenerInterface listener, Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	creates the object with the given arguments More...
*hash< auto >	handleRequestImpl (reference< hash< auto > > cx, hash< auto > hdr, *data body)
	This method is called by this class's handleRequest() More...

Detailed Description

This class is used to customize and control the behavior of the Qorus HTTP server with SOAP messages.

Since

Qorus 5.1.30 This class redirects URLs to Qorus services providing HTTP-based SOAP services If any listeners are added to the AbstractServiceSoapHandler object, then the URL set in the object is only bound to the new listeners specified in this object.

Otherwise, the URL is bound to all listeners in the system HTTP server.

Note

When used in Stateless services, HTTP and SOAP 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

handleRequest()

constructor(string path, HttpServer::AbstractAuthenticator auth=new DefaultQorusRBACAuthenticator()) hash< HttpResponseInfo > OMQ::AbstractServiceSoapHandler::handleRequest	(	HttpListenerInterface	listener,
		Socket	s,
		hash< auto >	cx,
		hash< auto >	hdr,
		*data	body
	)

creates the object with the given arguments

Parameters

path	the string or regular expression for the path to match on incoming requests (ex "my-service")
auth	the AbstractAuthenticator for the object; if no argument is passed, then the system RBAC authenticator is used; meaning that Qorus application users are required to connect, and the users must have the OMQ::QR_LOGIN role to connect as well

Example:

class MySoapHandler inherits AbstractServiceSoapHandler {
    constructor() : AbstractServiceSoapHandler("my-service")) {
    }
}

Note

that the path argument defaults to a string instead of a regular expression in this constructor

Since

Qorus 5.1.30 this method ensures that thread-local data is set properly

handleRequestImpl()

*hash< auto > OMQ::AbstractServiceSoapHandler::handleRequestImpl	(	reference< hash< auto > >	cx,
		hash< auto >	hdr,
		*data	body
	)

This method is called by this class's handleRequest()

This method is called before trying to service the request automatically based on service file resources

---

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

• AbstractServiceHttpHandler.qc