RestClient.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  RestClient.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
 
// require type definitions everywhere
 
// enable all warnings
 
// don't use "$" for vars, members, and methods, assume local variable scope
 
 
 
 
 
 
 
/*  Version History - see below in docs
*/
 
namespace RestClient {
 
public hashdecl AuthCodeInfo {
    string response_type = "code";
 
    *string redirect_uri;
 
    *list<string> scopes;
 
    *string state;
 
    *string code_verifier;
};
 
class RestClient : public Qore::HTTPClient, public Logger::LoggerWrapper, public ConnectionProvider::UpdateOptionsInterface, public ConnectionProvider::OptionHelper {
 
public:
        const DataSerializationSupport = ...;
 
 
        const DeserializeYaml = ...;
 
        const DeserializeXml = ...;
 
 
        const AcceptList = ...;
 
 
        const Accept = AcceptList.join(",");
 
        const AcceptMap = map {$1: True}, AcceptList;
 
        const Version = "2.2";
 
        const VersionString = sprintf("Qore-RestClient/%s", RestClient::Version);
 
        const DefaultHeaders = ...;
 
 
        const DefaultOAuth2RedirectUrl = "auto";
 
        const DefaultOptions = ...;
 
 
 
        const DataSerializationOptions = ...;
 
 
 
        const EncodingSupport = ...;
 
 
        const CompressionThreshold = 1024;
 
 
        const OAuth2GrantOptions = ...;
 
 
        const OAuth2AuthHeaders = ...;
 
 
        const MinimumTokenRefresh = 1m;
 
        const Oauth2TokenRefreshWindow = 10m;
 
        const CustomTokenOptions = ...;
 
 
        const PkceValueSet = ...;
 
 
protected:
        // headers to send with every request
        hash<auto> headers;
        // data serialization code
        string ds;
        // serialization content type
        string sct;
        // send content encoding hash
        *hash<auto> seh;
        // REST schema validator
        RestSchemaValidator::AbstractRestSchemaValidator validator;
        // no_charset option
        *bool noCharset;
 
        string username;
        string password;
 
        string oauth2_grant_type;
        string oauth2_client_id;
        string oauth2_client_secret;
        *softlist<string> oauth2_scopes;
        string oauth2_scope_separator_char;
        *hash<auto> oauth2_auth_args;
        *hash<auto> oauth2_token_args;
        string oauth2_auth_url;
        string oauth2_redirect_url;
        string oauth2_token_url;
        *hash<auto> oauth2_alt_url_subst;
        string oauth2_alt_token_url;
        string token_type;
        string token;
        string refresh_token;
        string token_api_key_header;
        bool oauth2_auto_refresh = True;
        bool oauth2_token_auth_secret_only = False;
        bool oauth2_token_use_basic_auth = False;
        int oauth2_token_expiry_hint;
        date oauth2_token_expiry;
 
        string oauth2_pkce;
 
        string oauth2_app;
        *hash<auto> rest_body_auth_error_check;
        date token_timestamp;
        bool allow_any_response;
 
 
        string custom_token_auth;
 
        string custom_token_location;
        string custom_token_method;
        string custom_token_path;
 
        transient *code alt_token_signer;
        transient *string alt_token_signer_header;
 
public:
 
 
    constructor(*hash<auto> opts, *softbool do_not_connect) ;
 
 
    setLogger(*LoggerInterface logger);
 
 
    bool needsRestBodyAuthErrorCheck();
 
 
 
    setOAuth2Options(hash<auto> new_opts);
 
 
 
    hash<auto> getOAuth2Options();
 
 
 
    clearConnectionPath();
 
 
 
    setSerialization(string data = 'auto');
 
 
 
    setSendEncoding(string enc = 'auto');
 
 
 
    setContentEncoding(string enc = 'auto');
 
 
 
    addDefaultHeaders(hash<auto> h);
 
 
 
    hash<auto> getDefaultHeaders();
 
 
 
    replaceDefaultHeaders(*hash<auto> hdr);
 
 
 
    *string getSendEncoding();
 
 
 
    string getSerialization();
 
 
 
    setAllowAnyResponse(bool val = True);
 
 
 
    bool getAllowAnyResponse();
 
 
 
    hash<auto> get(string path, auto body, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
    hash<auto> get(string path, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
    hash<auto> put(string path, auto body, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
    hash<auto> patch(string path, auto body, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
    hash<auto> post(string path, auto body, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
    hash<auto> del(string path, auto body, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
    RestSchemaValidator::AbstractRestSchemaValidator getValidator();
 
 
 
    setValidator(RestSchemaValidator::AbstractRestSchemaValidator validator);
 
 
 
    bool usingOAuth2();
 
 
 
    bool requiresOAuth2Token();
 
 
 
    bool requiresRefresh();
 
 
 
    setToken(string token_type, string token, *string refresh_token, *date token_expiry);
 
 
 
    string getTokenType();
 
 
 
    *string getToken();
 
 
 
    AbstractPollOperation startOAuth2PollSendRecv();
 
 
 
    AbstractPollOperation startPollCustomGetToken();
 
 
 
    AbstractPollOperation startOAuth2PollRefreshToken();
 
 
 
    hash<auto> doRequest(string m, string path, auto body, *reference<hash<auto>> info, softbool decode_errors = True, *hash<auto> hdr);
 
 
 
    hash<auto> doSignedRequest(string shdr, code signer, string m, string path, auto body, *reference<hash<auto>> info, softbool decode_errors = True, *hash<auto> hdr);
 
 
protected:
     bool needsRefresh(*hash<ExceptionInfo> ex, *hash<auto> info, *bool body_deserialized, auto body);
public:
 
 
 
    bool isAuthTokenError(int status_code, hash<auto> headers, *bool body_deserialized, *string body_content_type, auto body);
 
 
 
    hash<auto> getNewToken();
 
 
 
protected:
     *hash<auto> setupCustomGetToken(reference<hash<auto>> auth_hdr);
public:
 
 
 
protected:
     hash<auto> getNewTokenIntern(*reference<hash<auto>> info);
public:
 
 
 
protected:
     hash<auto> customGetTokenIntern(*reference<hash<auto>> info, *bool refresh);
public:
 
 
 
protected:
     hash<auto> refreshTokenIntern(*reference<hash<auto>> info);
public:
 
 
protected:
     hash<auto> doRequestIntern(string m, string path, auto body, *reference<hash<auto>> info, softbool decode_errors = True, *hash<auto> hdr, *string assume_content_type, *string shdr, *code signer, *bool no_auth_retry);
public:
 
 
 
    prepareToSend(string method, reference<string> path, reference<auto> body, *reference<hash<auto>> hdr);
 
 
 
    hash<auto> doValidatedRequest(string m, string path, auto body, *reference<hash<auto>> info, softbool decode_errors = True, *hash<auto> hdr);
 
 
 
    hash<auto> processRestResponse(hash<auto> resp, string method, string path, *reference<hash<auto>> info);
 
 
 
    hash<auto> gotOAuth2LoginInfo(hash<auto> h, *bool refresh);
 
 
 
    auto preprocessRequestBody(auto request_body);
 
 
    *LoggerInterface getLogger();
 
 
 
      static *string getScopeString(*list<auto> scopes, string separator = ' ');
 
 
    setAltTokenSigner(code signer, string signer_header);
 
 
 
    clearAltTokenSigner();
 
 
 
protected:
     setOAuth2LoginInfo(hash<auto> h);
public:
 
 
 
protected:
     *hash<auto> getUpdateOptionsAfterLogin(hash<auto> h, *bool refresh);
public:
 
 
 
protected:
     setupAuth(hash<auto> opts, *bool no_exceptions);
public:
 
 
    setupUserPassword(hash<auto> opts);
 
 
 
protected:
     checkOAuth2Options(hash<auto> opts, *bool no_exceptions);
public:
 
 
 
protected:
     hash<auto> loginIntern(*reference<hash<auto>> info);
public:
 
 
 
protected:
     AbstractPollOperation startOAuth2AuthPoll(hash<auto> login);
public:
 
 
 
protected:
     hash<auto> oauth2Auth(hash<auto> login, *reference<hash<auto>> info, *bool refresh);
public:
 
 
 
protected:
     hash<auto> oauth2AuthIntern(hash<auto> login, *reference<hash<auto>> info, *bool refresh);
public:
 
 
 
protected:
     hash<auto> doOAuth2LoginRequest(string url, hash<auto> login, *reference<hash<auto>> info, *string real_url);
public:
 
 
 
protected:
     *hash<auto> getOAuth2AuthHeaders();
public:
 
 
 
protected:
     hash<auto> getOAuth2LoginInfo(string grant_type);
public:
 
 
 
protected:
     hash<auto> getOAuth2RefreshInfo();
public:
 
 
protected:
     nothing prepareMsg(string method, string path, reference<auto> body, reference<hash<auto>> hdr, string ct = 'Content-Type');
public:
 
 
protected:
     nothing preparePath(reference<string> path);
public:
 
 
protected:
     checkLogin(*reference<hash<auto>> info);
public:
 
 
protected:
     hash<auto> sendAndDecodeResponse(*data body, string m, string path, hash<auto> hdr, *reference<hash<auto>> info, *softbool decode_errors, *string assume_content_type, *string shdr, *code signer, *bool no_auth_retry);
public:
 
 
protected:
     signRequest(string method, *string path, *data body, reference<hash<auto>> hdr);
public:
 
 
protected:
      static decodeError(hash<auto> h, *reference<hash<auto>> info);
public:
 
 
private:
      static tryDecodeErrorResponse(reference<hash<auto>> h, *reference<hash<auto>> info);
public:
 
}; // class RestClient
 
 
class RestConnection : public ConnectionProvider::HttpBasedConnection, public ConnectionProvider::UpdateOptionsInterface {
 
public:
        hash<auto> real_opts;
 
        bool needs_auth;
 
        const ConnectionScheme = ...;
 
 
        const Options = map {$1: True}, keys ConnectionScheme.options;
 
        const OptionList = keys ConnectionScheme.options;
 
        const OAuth2AuthRequestOptions = ...;
 
 
        const OAuth2Options = ...;
 
 
 
        const RCF_OAUTH2_AUTH_CODE = "oauth2-auth-code";
 
protected:
        transient *code alt_token_signer;
        transient *string alt_token_signer_header;
 
        hash<string, bool> features = {
            CF_LOGGER: True,
        };
 
public:
 
 
    constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
 ;
 
 
 
    constructor(hash<auto> config, *hash<auto> attr) ;
 
 
    setLogger(*LoggerInterface logger);
 
 
    *LoggerInterface getLogger();
 
 
 
    bool needsAuth();
 
 
 
    hash<auto> getExtendedInfo(*hash<auto> opts);
 
 
 
    hash<auto> getExtendedInfoAsData(*hash<auto> opts);
 
 
 
    authFailure();
 
 
 
    authSuccess();
 
 
 
    string getOAuth2OptionName(string opt);
 
 
 
    object getPollImpl();
 
 
 
    hash<auto> getOptions();
 
 
    string getType();
 
 
 
    hash<auto> getOAuth2Options();
 
 
 
    hash<auto> processOAuth2TokenResponse(hash<auto> resp);
 
 
 
    *hash<auto> getOAuth2AuthHeaders();
 
 
 
    DataProvider::AbstractDataProvider getDataProvider(*hash<auto> constructor_options);
 
 
 
    bool hasDataProvider();
 
 
 
    Qore::AbstractPollOperation startPollConnect(*Logger::LoggerInterface logger);
 
 
 
    persistInfo(RestConnection old);
 
 
 
      static hash<auto> processOptions(string name, *hash<auto> opts);
 
 
    string getAuthorizationCodeRequest(hash<AuthCodeInfo> info = <AuthCodeInfo>{});
 
 
      static string generatePkceChallenge();
 
    /*  @param allow_relative if @ref True then a relative URL (path only) can be returned; the default (@ref False)
        is to return a full URL
 
        @since %RestClient 2.0
    */
    string getAuthUrl(*bool allow_relative);
 
 
    /*  @param allow_relative if @ref True then a relative URL (path only) can be returned; the default (@ref False)
        is to return a full URL
 
        @since %RestClient 2.0
    */
    string getTokenUrl(*bool allow_relative);
 
 
    *hash<auto> getConnectionOptions(*hash<auto> rtopts);
 
 
 
    setAltTokenSigner(code signer, string signer_header);
 
 
 
    clearAltTokenSigner();
 
 
 
    RestClient get(bool connect = True, *hash<auto> rtopts);
 
 
 
protected:
     setupRest();
public:
 
 
 
protected:
     setFeatures();
public:
 
 
 
protected:
     checkCanConnect();
public:
 
 
    /*  @param opt the URL option name
        @param allow_relative if @ref True then a relative URL (path only) can be returned; the default (@ref False)
        is to return a full URL
 
        @since %RestClient 2.1.1
    */
protected:
     string getUrlOption(string opt, *bool allow_relative);
public:
 
 
    /*  @param uri the URL value
        @param allow_relative if @ref True then a relative URL (path only) can be returned; the default (@ref False)
        is to return a full URL
 
        @since %RestClient 2.2
    */
protected:
     string getUrlOptionIntern(string uri, *bool allow_relative);
public:
 
 
    /*
        @since %RestClient 2.0
    */
protected:
      static softstring getUriValue(auto v, string separator = ' ');
public:
 
 
protected:
     *hash<auto> processOAuth2TokenResponseImpl(hash<auto> resp);
public:
 
 
protected:
     checkAuthCodeFeature();
public:
 
 
 
protected:
     RestClient getImpl(bool connect = True, *hash<auto> rtopts);
public:
 
 
 
protected:
     RestClient setupRestClientConfig(RestClient rest);
public:
 
 
 
protected:
     pingImpl();
public:
 
 
protected:
     *string getPingPath();
public:
 
 
protected:
     auto getPingBody();
public:
 
 
 
protected:
     *hash<string, bool> getFeaturesImpl();
public:
 
 
protected:
     setChildCapabilities();
public:
 
 
protected:
     hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
public:
 
};
 
 
class RestPingPollOperation : public Qore::AbstractPollOperation {
 
public:
        const SPS_GET_SWAGGER = 'get-swagger';
 
        const SPS_OAUTH2_GET_TOKEN = "oauth2-get-token";
 
        const SPS_OAUTH2_REFRESH_TOKEN = "oauth2-refresh-token";
 
        const SPS_CUSTOM_GET_TOKEN = "custom-refresh";
 
        const SPS_REST_PING = "rest-ping";
 
        const SPS_COMPLETE = "complete";
 
protected:
        RestConnection conn;
 
        RestClient rc;
 
        hash<auto> real_opts;
 
        AbstractPollOperation poller;
 
        bool goal_reached = False;
 
        string method;
 
        string path;
 
        *auto body;
 
        *hash<auto> headers;
 
        string state;
 
        Mutex m();
 
        bool in_refresh;
 
        bool use_path_as_is;
 
public:
 
    constructor(RestConnection conn, RestClient rc, hash<auto> real_opts);
 
 
    destructor();
 
 
 
    string getGoal();
 
 
 
    string getState();
 
 
 
    bool goalReached();
 
 
    *hash<SocketPollInfo> continuePoll();
 
 
    abort();
 
 
protected:
     checkOtherStates();
public:
 
 
protected:
     gotOAuth2LoginInfo(hash<auto> h);
public:
 
 
protected:
     doStartGetToken();
public:
 
 
protected:
     doStartRefresh();
public:
 
 
protected:
     doStartPing();
public:
 
 
protected:
     checkUrl();
public:
 
};
};