SoapClient.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  SoapClient.qm Copyright (C) 2012 - 2019 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.
*/
 
// make sure we have the required qore version
 
 
// do not use $ for vars
 
// do not ignore argument errors
 
// require type declarations
 
// enable all warnings
 
 
namespace SoapClient {
class SoapClient : public HTTPClient {
 
public:
        const Version = "0.2.5";
 
        const Headers = ("User-Agent": ("Qore-Soap-Client/" + SoapClient::Version));
 
        const HTTPOptions = ("connect_timeout", "http_version", "max_redirects", "proxy", "timeout");
 
protected:
            // web service definition
            WSDL::WebService wsdl;
            // service name
            string svc;
            string port;
            string binding;
            *string url_path;
 
            *code logc;
            *code dbglogc;
 
            // send content encoding hash
            *hash<auto> seh;
 
public:
 
            string url;
            hash headers = Headers;
 
 
            const EncodingSupport = (
                "gzip": (
                    "ce": "gzip",
                    "func": \gzip(),
                ),
                "bzip2": (
                    "ce": "bzip2",
                    "func": \bzip2(),
                ),
                "deflate": (
                    "ce": "deflate",
                    "func": \compress(),
                ),
                "identity": (
                    "ce": NOTHING,
                ),
            );
 
            const CompressionThreshold = 1024;
 
 
        constructor(hash<auto> h) ;
 
 
 
        hash<auto> getMsg(string operation, auto args, *hash<auto> soap_header, reference<auto> op, *hash<auto> http_header, *int xml_opts, *string soapaction);
 
 
 
        auto callOperation(string operation, auto args, *hash<auto> opts, *reference info);
 
 
 
        auto call(string operation, auto args, *hash<auto> soap_header, *hash<auto> http_header, *string binding);
 
 
 
        auto call(string operation, auto args, *reference info, *string binding);
 
 
 
        auto call(reference info, string operation, auto args, *hash<auto> soap_header, *hash<auto> http_header);
 
 
private:
         auto makeCallIntern(*reference info, string operation, auto args, *hash<auto> opts);
public:
 
 
 
        auto methodGate(string op);
 
 
        hash<auto> getType(string type, auto v);
 
 
        WSDL::WebService getWebService();
 
 
 
        hash<auto> getInfo();
 
 
 
        setSendEncoding(string enc = 'auto');
 
 
 
        setContentEncoding(string enc = 'auto');
 
 
 
        addDefaultHeaders(hash<auto> h);
 
 
 
        hash<auto> getDefaultHeaders();
 
 
 
        *string getSendEncoding();
 
 
        log(string msg);
 
 
        dbglog(string msg);
 
protected:
         nothing msglog(hash<auto> msg);
public:
 
    };
 
 
class SoapConnection : public HttpBasedConnection {
 
public:
            hash<auto> real_opts;
 
            const Options = HttpConnection::Options + {
                "content_encoding": True,
                "service": True,
                "port": True,
                "send_encoding": True,
                "target_url": True,
                "wsdl": True,
            };
 
 
        deprecated
        constructor(string name, string desc, string url, bool monitor, *hash<auto> n_opts, hash<auto> urlh)
 ;
 
 
 
        constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
 ;
 
 
private:
         constructorInit();
public:
 
 
        string getType();
 
 
 
        *hash<auto> getRuntimeOptions();
 
 
 
protected:
         SoapClient getImpl(bool connect = True, *hash<auto> rtopts);
public:
 
 
        hash<auto> getOptions();
 
 
        *hash<auto> getDefaultOptions();
 
 
 
        DataProvider::AbstractDataProvider getDataProvider();
 
 
 
        bool hasDataProvider();
 
 
 
        deprecated
          static SoapConnection make(string name, string desc, string url, bool monitor, *hash<auto> opts, hash<auto> urlh);
    };
};