RestHandler.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/* RestHandler.qm Copyright (C) 2013 - 2025 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/
 
// minimum qore version
 
// use new-style
 
// require type definitions everywhere
 
// enable all warnings
 
 
 
namespace RestHandler {
 
    class AbstractRestStreamRequestHandler {
 
public:
        
 
protected:
            hash<auto> cx;
 
            *hash<auto> ex;
 
            *hash<auto> ah;
 
            hash<auto> rhdr;
 
            *int timeout_ms;
 
public:
 
 
        constructor(hash<auto> cx, *hash<auto> ah);
 
 
 
        hash<HttpServer::HttpHandlerResponseInfo> getResponseHeaderMessage();
 
 
 
        nothing recv(hash<auto> v);
 
 
 
        auto send();
 
 
        *code getPersistentClosedNotification();
 
 
        bool isPersistent();
 
 
        setTimeout(timeout timeout_ms);
 
 
        *int getTimeout();
 
 
        streamError(hash<auto> ex);
 
 
 
        abstract hash<auto> getResponseHeaderMessageImpl();
 
 
        abstract nothing recvImpl(hash<auto> v);
 
 
        abstract auto sendImpl();
    };
 
class RestStreamRequest : public HttpServer::AbstractStreamRequest {
 
public:
protected:
            RestHandler::AbstractRestStreamRequestHandler stream;
            bool deserialized;
 
public:
 
        constructor(RestHandler::AbstractRestStreamRequestHandler stream, HttpServer::HttpListenerInterface listener, HttpServer::AbstractHttpRequestHandler handler, Socket s, hash<auto> cx, hash<auto> hdr, auto body)
 ;
 
 
        destructor();
 
 
        // callback method for the response header; this calls @ref RestHandler::AbstractRestStreamRequestHandler::getResponseHeaderMessage() and returns the result
protected:
         hash<HttpServer::HttpHandlerResponseInfo> getResponseHeaderMessageImpl();
public:
 
 
 
protected:
         nothing recvImpl(hash<auto> v);
public:
 
 
 
protected:
         auto sendImpl();
public:
 
    };
 
    class AbstractRestClass {
 
public:
            hash<string, AbstractRestClass> class_hash;
 
            const RestBasicMethodSet = map {$1: True}, RestHandler::Methods.iterator();
 
        constructor();
 
 
        abstract string name();
 
        addClass(AbstractRestClass cls);
 
 
 
        *AbstractRestClass subClass(string name, hash<auto> cx, *hash<auto> args);
 
 
 
        *AbstractRestClass subClassImpl(string name, hash<auto> cx, *hash<auto> args);
 
 
        hash<HttpServer::HttpHandlerResponseInfo> handleRequest(HttpListenerInterface listener, RestHandler rh, Socket s, *list<string> cl, string mn, hash<auto> cx, *hash<auto> args);
 
 
protected:
         hash<HttpServer::HttpHandlerResponseInfo> dispatchStream(HttpListenerInterface listener, RestHandler rh, Socket s, string mn, *hash<auto> ah, hash<auto> cx);
public:
 
 
 
protected:
         hash<HttpServer::HttpHandlerResponseInfo> dispatch(RestHandler rh, string mn, *hash<auto> ah, hash<auto> cx);
public:
 
 
 
protected:
         hash<HttpServer::HttpHandlerResponseInfo> unknownSubClassError(string cls_name, hash<auto> cx, *hash<auto> ah);
public:
 
 
 
protected:
         *hash<string, bool> doGetPossibleSubClasses(hash<auto> cx, *hash<auto> ah);
public:
 
    };
 
 
class RestHandler : public HttpServer::AbstractHttpRequestHandler, public AbstractRestClass, public Logger::LoggerWrapper {
 
public:
            const Err501 = ...;
 
 
            const Methods = ...;
 
 
protected:
            RestSchemaValidator::AbstractRestSchemaValidator validator;
 
public:
 
 
        constructor(*HttpServer::AbstractAuthenticator auth, RestSchemaValidator::AbstractRestSchemaValidator validator = new NullRestSchemaValidator())
 ;
 
 
 
        constructor(Logger::LoggerInterface logger, *HttpServer::AbstractAuthenticator auth, RestSchemaValidator::AbstractRestSchemaValidator validator = new NullRestSchemaValidator(logger))
 ;
 
 
        string name();
 
 
        setLogger(*Logger::LoggerInterface logger);
 
 
        *AbstractRestSchemaValidator getRestSchemaValidator();
 
 
 
        auto handleExternalRequest(string method, string path, *hash<auto> body, hash<auto> cx = {});
 
 
 
        hash<HttpResponseInfo> handleRequest(HttpListenerInterface listener, Socket s, hash<auto> cx, hash<auto> hdr, *data b);
 
 
 
protected:
         *hash<auto> errorResponseHeaders(hash<auto> cx);
public:
 
 
protected:
         hash<HttpHandlerResponseInfo> dispatchRequest(HttpListenerInterface listener, Socket s, *list<string> class_list, string method_name, string path, hash<auto> cx, *hash<auto> args);
public:
 
 
 
protected:
         hash<HttpHandlerResponseInfo> returnRestException(hash<ExceptionInfo> ex);
public:
 
 
protected:
         checkExceptionSerializable(reference<hash<ExceptionInfo>> ex);
public:
 
 
        hash<auto> get(hash<auto> cx, *hash<auto> ah);
 
 
        removeRootPath(reference<string> path);
 
 
        requestDeserializationError(hash<auto> hdr, hash<auto> cx, string body);
 
 
        responseSerializationError(hash<auto> cx, *hash<auto> aih, hash<auto> rv);
 
 
 
        logInfo(string fmt, ...);
 
 
 
        logError(string fmt, ...);
 
 
 
        logDebug(string fmt, ...);
 
 
          static hash<HttpHandlerResponseInfo> make200(string fmt, ...);
 
          static hash<HttpHandlerResponseInfo> make200(hash<auto> hdr, string fmt, ...);
 
          static hash<HttpHandlerResponseInfo> make400(string fmt, ...);
 
          static hash<HttpHandlerResponseInfo> make400(hash<auto> hdr, string fmt, ...);
 
          static hash<HttpHandlerResponseInfo> makeResponse(int code, auto body, *hash<auto> hdr);
 
          static hash<HttpHandlerResponseInfo> make500(string fmt, ...);
 
          static hash<HttpHandlerResponseInfo> make500(hash<auto> hdr, string fmt, ...);
 
          static hash<HttpHandlerResponseInfo> make501(string fmt, ...);
 
          static hash<HttpHandlerResponseInfo> make501(hash<auto> hdr, string fmt, ...);
    };
};
 
// private, unexported namespace
namespace Priv {
    // dumHttpListenerInterface class
class DummyListenerInterface : public HttpListenerInterface {
 
public:
        addUserThreadContext(hash<auto> uctx);
 
 
        auto removeUserThreadContext(*string k);
 
 
        log(string fmt, ...);
 
 
        logError(string fmt, ...);
 
    };
};