ms_http_client.hpp

/*
##############################################################################
# file: ms_http_client.hpp                                                 #
# 'msparser' toolkit                                                         #
# Represents a Mascot server, providing communication to that server         #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2013 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
 * @(#)$Source: parser/inc/ms_http_client.hpp $
 * @(#)$Revision: 1b450440f9c97e1e41d0fc6016a27d68951d4532 | MSPARSER_REL_3_0_0-2024-09-24-0-g93ebaeb4f4 $
 * @(#)$Date: 2018-07-30 16:23:53 +0100 $
##############################################################################
 */
 
#ifndef MS_HTTP_CLIENT_HPP
#define MS_HTTP_CLIENT_HPP
 
 
#include <string>
 
namespace matrix_science
{
    class ms_http_client_session;
 
 
    class MS_MASCOTRESFILE_API ms_http_client :
        public ms_errors
    {
        public:
 
            enum LoginResultCode
            {
                L_SUCCESS, 
                L_SECURITYDISABLED, 
                L_UNKNOWNUSER, 
                L_INCORRECTPASSWORD, 
                L_PASSWORDEXPIRED, 
                L_WEBAUTHENTICATIONFAILED, 
                L_GUESTLOGINDISABLED, 
                L_UNSPECIFIEDERROR 
            };
 
 
            enum ChangePasswordResultCode
            {
                CP_SUCCESS, 
                CP_UNKNOWNUSER, 
                CP_INCORRECTPASSWORD, 
                CP_BADNEWPASSWORD, 
                CP_UNSPECIFIEDERROR 
            };
 
#ifndef SWIG
            // C++ STL collection support
            ms_http_client();
#endif
            ms_http_client(const std::string & baseUrl, ms_connection_settings settings);
            virtual ~ms_http_client();
 
            ms_http_client(const ms_http_client & src);
#ifndef SWIG
            ms_http_client& operator=(const ms_http_client & right);
#endif
            void copyFrom(const ms_http_client * right);
 
            std::string baseUrl() const;
            ms_connection_settings connectionSettings() const;
 
            void setBaseUrl(const std::string & baseUrl);
            void setConnectionSettings(const ms_connection_settings & settings);
#ifndef SWIG
            bool getIsDatabaseActive(const std::string & databaseName, bool & returnIsActive);
 
            bool getVersion(int & major, int & minor, int & part3, int & part4);
 
            bool getOsName(std::string & osname);
 
#else // SWIG Multiple return values
            bool getIsDatabaseActive(const std::string & databaseName, bool & OUTPUT);
            bool getVersion(int & OUTPUT, int & OUTPUT, int & OUTPUT, int & OUTPUT);
            bool getOsName(std::string & OUTPUT);
#endif
            LoginResultCode userLogin(
                    const std::string & username,
                    const std::string & password,
                    ms_http_client_session & returnSession);
 
            ChangePasswordResultCode changePassword(
                    const std::string & userName,
                    const std::string & oldPassword,
                    const std::string & newPassword);
#ifndef SWIG
            bool getIsSecurityEnabled(bool & returnIsSecurityEnabled, std::string & returnUnsecuredSessionId);
 
            bool getIsWebAuthenticationEnabled(bool & returnIsWebAuthenticationEnabled, std::string & returnWebAuthenticatedSessionId);
#else // SWIG Multiple return values
            bool getIsSecurityEnabled(bool & OUTPUT, std::string & OUTPUT);
            bool getIsWebAuthenticationEnabled(bool & OUTPUT, std::string & OUTPUT);
#endif
 
        private:
            LoginResultCode secureGuestLogin(
                    ms_http_client_session & session);
            LoginResultCode secureUserLogin(
                    const std::string & username,
                    const std::string & password,
                    ms_http_client_session & returnSession);
            bool httpGetString(const std::string & action, std::string & returnString);
 
            ms_http_helper connection_;
    };
 // end of http_client_group
} // namespace matrix_science
 
#endif // MS_HTTP_CLIENT_HPP
 
/*------------------------------- End of File -------------------------------*/