RestHandler.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-

/* RestHandler.qm Copyright (C) 2013 - 2016 Qore Technologies, sro

    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:
private:

public:

        private :
            hash cx;

            *hash ex;

            *hash ah;

            hash rhdr;

            *int timeout_ms;

public:


        constructor(hash n_cx, *hash n_ah);



        hash getResponseHeaderMessage();



        nothing recv(hash v);



        any send();


        *code getPersistentClosedNotification();


        bool isPersistent();


        setTimeout(timeout n_timeout_ms);


        *int getTimeout();


        streamError(hash n_ex);



        abstract hash getResponseHeaderMessageImpl();


        abstract nothing recvImpl(hash v);


        abstract any sendImpl();
    };

class RestStreamRequest : public HttpServer::AbstractStreamRequest {

public:
        private :
            RestHandler::AbstractRestStreamRequestHandler stream;
            bool deserialized;

public:

        constructor(RestHandler::AbstractRestStreamRequestHandler n_stream, HttpServer::HttpListenerInterface listener, HttpServer::AbstractHttpRequestHandler handler, Socket s, hash cx, hash hdr, any body) ;


        destructor();


        // callback method for the response header; this calls @ref RestHandler::AbstractRestStreamRequestHandler::getResponseHeaderMessage() and returns the result
        private hash getResponseHeaderMessageImpl();



        private nothing recvImpl(hash v);



        private any sendImpl();

    };

    class AbstractRestClass {

public:
private:

public:

        constructor();


        abstract string name();


        *AbstractRestClass subClass(string name, hash cx, *hash args);


        hash handleRequest(HttpListenerInterface listener, RestHandler rh, Socket s, *list cl, string mn, hash cx, *hash args);


        private hash dispatchStream(HttpListenerInterface listener, RestHandler rh, Socket s, string mn, *hash ah, hash cx);


        private hash dispatch(RestHandler rh, string mn, *hash ah, hash cx);


        private hash unknownSubClassError(string n_name);

    };


class RestHandler : public HttpServer::AbstractHttpRequestHandler,public  AbstractRestClass {

public:
        public :
            const Err501 = (
                "code": 501,
                "body": "not implemented",
                );

            const Methods = (
                "GET": "get",
                "POST": "post",
                "PUT": "put",
                "DELETE": "del",
                "OPTIONS": "options",
                );

            const MimeDataTypes = (
                MimeTypeJsonRpc: (
                    "serialize": \make_json(),
                    "deserialize": \parse_json(),
                ),
                MimeTypeYaml: (
                    "serialize": \make_yaml(),
                    "deserialize": \parse_yaml(),
                ),

                MimeTypeYamlRpc: (
                    "serialize": \make_yaml(),
                    "deserialize": \parse_yaml(),
                ),
                MimeTypeXml: (
                    "serialize": \make_xmlrpc_value(),
                    "deserialize": \parse_xmlrpc_value(),
                ),
                MimeTypeHtml: (
                    "serialize": string (any body) { return sprintf("<pre>%N</pre>", body); },
                ),
                );

public:

        private :
            hash ch;

            Mutex mx();

public:


        constructor(*HttpServer::AbstractAuthenticator auth) ;


        string name();



        hash handleRequest(HttpListenerInterface listener, Socket s, hash cx, hash hdr, *data b);


        removeRootPath(reference path);


        requestDeserializationError(hash hdr, hash cx, string body);


        responseSerializationError(hash cx, *hash aih, hash rv);


        logInfo(string fmt);


        logError(string fmt);


        logDebug(string fmt);


        addClass(AbstractRestClass cls);


        hash get(hash cx, *hash ah);


          static hash makeResponse(int code, any body, *hash hdr);
    };
};