Qore RestHandler Module Reference
1.5
|
the base abstract class for REST handler classes More...
Public Member Methods | |
addClass (AbstractRestClass cls) | |
adds a REST class to the handler | |
hash< HttpServer::HttpHandlerResponseInfo > | handleRequest (HttpListenerInterface listener, RestHandler rh, Socket s, *list< string > cl, string mn, hash< auto > cx, *hash< auto > args) |
this method is called by the RestHandler class to match the right object with incoming requests | |
abstract string | name () |
this provides the name of the REST class | |
Public Attributes | |
hash< string, AbstractRestClass > | class_hash |
class hash: name -> AbstractRestClass | |
const | RestBasicMethodSet = map {$1: True} |
set of REST class method names based on basic HTTP methods | |
Private Member Methods | |
hash< HttpServer::HttpHandlerResponseInfo > | dispatch (RestHandler rh, string mn, *hash< auto > ah, hash< auto > cx) |
this method is called to dispatch requests on the given object More... | |
hash< HttpServer::HttpHandlerResponseInfo > | dispatchStream (HttpListenerInterface listener, RestHandler rh, Socket s, string mn, *hash< auto > ah, hash< auto > cx) |
this method is called to dispatch streamed requests on the given object | |
*hash< string, bool > | doGetPossibleSubClasses (hash< auto > cx) |
returns a set of possible subclasses for a particular request More... | |
hash< HttpServer::HttpHandlerResponseInfo > | unknownSubClassError (string cls_name, hash< auto > cx) |
returns a 404 Not Found response when a request tries to access an unknown subclass More... | |
the base abstract class for REST handler classes
|
private |
this method is called to dispatch requests on the given object
rh | the RestHandler object |
mn | the method name |
ah | the holds URI and / or message body arguments for the REST call; if a request has both URI query arguments and message body arguments, then this value will be a combination of URI query arguments and deserialized message body arguments with URI query arguments taking precedence over the message body arguments |
cx | call context hash; this hash will have the following keys:
|
|
private |
returns a set of possible subclasses for a particular request
cx | the HTTP call context hash |
|
private |
returns a 404 Not Found response when a request tries to access an unknown subclass
cls_name | the URI path element that could not be matched to a REST subclass |
cx | the HTTP call context hash |