SalesforceSoapClient.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
// @file SalesforceSoapClient.qm Salesforce SOAP Client Definition Module
 
/*  SalesforceSoapClient.qm Copyright (C) 2015 - 2020 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.
*/
 
 
 
 
namespace SalesforceSoapClient {
 
class SalesforceSoapClient : public SoapClient::SoapClient {
 
public:
protected:
            // mutex for atomic operations
            Mutex lck();
            // logged in flag
            bool logged_in = False;
 
            // Salesforce.com username
            string username;
            // Salesforce.com user password
            string password;
            // Salesforce.com user token
            string token;
 
            // Salesforce.com server URL
            string serverurl;
            // Salesforce.com session ID
            string sessionid;
 
            // default SoapAction value
            string soapaction = "default";
 
            // perform a logout when destroying the object
            bool force_logout = False;
 
public:
 
            const AuthorizationHash = {
                "username": True,
                "password": True,
                "token": True,
            };
 
            const AuthorizationOpts = AuthorizationHash.keys();
 
            const RequiredOpts = AuthorizationOpts + (
                "wsdl",
            );
 
 
        constructor(hash<auto> opts) ;
 
 
 
        destructor();
 
 
protected:
         processOpts(hash<auto> opts);
public:
 
 
        login();
 
 
        logout();
 
 
        disconnect();
 
 
 
        auto callOperation(string operation, auto args, *hash<auto> opts, *reference<auto> info);
 
 
 
protected:
         auto callIntern(string operation, auto args, *hash<auto> opts, *reference<auto> info);
public:
 
 
 
        auto call(string operation, auto args, *hash<auto> header);
 
 
 
        auto call(string operation, auto args, reference<auto> info);
 
 
 
        auto call(reference<auto> info, string operation, auto args, *hash<auto> header);
 
 
        nothing setWarningQueue(int warning_ms, int warning_bs, Queue queue, auto arg, timeout min_ms = 1s);
 
 
        nothing clearWarningQueue();
 
 
 
        auto methodGate(string op, auto arg);
 
 
protected:
         logoutIntern();
public:
 
 
        // must be called with the lock held
protected:
         loginIntern();
public:
 
    };
 
 
class SalesforceSoapConnection : public SoapConnection {
 
public:
            const Options = SoapConnection::Options + SalesforceSoapClient::AuthorizationHash;
 
protected:
            hash cache;
 
public:
 
 
        deprecated
        constructor(string name, string desc, string url, bool monitor, *hash opts, hash urlh)
 ;
 
 
 
        constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
 ;
 
 
private:
         constructorInit();
public:
 
 
        string getType();
 
 
 
protected:
         SalesforceSoapClient getImpl(bool connect = True, *hash<auto> rtopts);
public:
 
 
 
protected:
         WSDL::WebService getWsdl(string url);
public:
 
 
protected:
          synchronized WSDL::WebService getWsdlFromCache(string path);
public:
 
 
protected:
         WSDL::WebService getWebService(string url);
public:
 
 
        hash<auto> getOptions();
 
 
 
        *hash<auto> getRuntimeOptions();
 
 
 
        deprecated
          static SalesforceSoapConnection make(string name, string desc, string url, bool monitor, *hash opts, hash urlh);
    };
};