OMQ::DefaultQorusRBACAuthenticator Class Reference

Class for authenticating with standard Qorus RBAC authentication (Enterprise Edition only) More...

Inheritance diagram for OMQ::DefaultQorusRBACAuthenticator:

Collaboration diagram for OMQ::DefaultQorusRBACAuthenticator:

Public Member Methods
string	getRealm ()
	Returns the authentication realm as a string. More...

Private Member Methods
hash< auto >	getAuthHeader (*hash< auto > cx)
	Can be overridden to return a header with 401 Unauthorized responses. More...

Detailed Description

Class for authenticating with standard Qorus RBAC authentication (Enterprise Edition only)

See also

• OMQ::DefaultQorusRBACBasicAuthenticator
• Role Based Access Control
• rbac-security
• rbac-external

Note

This class is only included for API compatibility with the Enterprise Edition; In the Community Edition, this class allows all requests

Member Function Documentation

getAuthHeader()

hash< auto > OMQ::DefaultQorusRBACAuthenticator::getAuthHeader ( *hash< auto >  cx )

private

Can be overridden to return a header with 401 Unauthorized responses.

Returns

an empty hash

For example to return a header that tells the caller to require basic authentication (which will cause web browsers to show a dialog box asking for a username and password before repeating the request); use the following:

private hash<auto> getAuthHeader() {
    return {"WWW-Authenticate": sprintf("Basic realm=%y", getRealm())};
}

getRealm()

string OMQ::DefaultQorusRBACAuthenticator::getRealm

(

)

Returns the authentication realm as a string.

Returns

the authentication realm as a string; the value returned is "Qorus Integration Engine"

---

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

• QorusClientCore.qm
• DefaultQorusRBACAuthenticator.qc