ms_connection_settings.hpp

/*
##############################################################################
# file: ms_connection_settings.hpp                                           #
# 'msparser' toolkit                                                         #
# Holds the proxy server and Mascot sessionID string                         #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2005 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
#    $Source: parser/inc/ms_connection_settings.hpp $ #
#     $Author: villek@matrixscience.com $                                                      #
#       $Date: 2018-07-30 16:23:53 +0100 $                                         #
#   $Revision: 1b450440f9c97e1e41d0fc6016a27d68951d4532 | MSPARSER_REL_3_0_0-2024-09-24-0-g93ebaeb4f4 $                                                        #
# $NoKeywords::                                                            $ #
##############################################################################
*/
 
 
 
#if !defined(ms_connection_settings_INCLUDED_)
#define ms_connection_settings_INCLUDED_
 
 
// Includes from the standard template library
#include <string>
 
 
namespace matrix_science {
    class ms_mascotoptions;
 
 
    class MS_MASCOTRESFILE_API ms_connection_settings
    {
 
    public:
 
        enum PROXY_TYPE
        {
            PROXY_TYPE_NO_PROXY       = 0x0000, 
            PROXY_TYPE_FROM_REGISTRY  = 0x0001, 
            PROXY_TYPE_SPECIFY        = 0x0002, 
            PROXY_TYPE_WPAD           = 0x0003, 
            PROXY_TYPE_ENVIRONMENT    = 0x0004, 
            PROXY_TYPE_AUTO           = 0x0005  
        };
 
        enum HTTP_PROTOCOL
        {
            HTTP_1_0                = 0x0000, 
            HTTP_1_1                = 0x0001, 
            HTTP_SYSTEM_DEFAULT     = 0x0002  
        };
 
        enum REDIRECT_POLICY
        {
            REDIRECT_POLICY_ALWAYS                 = 0x0000, 
            REDIRECT_POLICY_DISALLOW_HTTPS_TO_HTTP = 0x0001, 
            REDIRECT_POLICY_NEVER                  = 0x0002  
        };
 
        ms_connection_settings();
 
        ms_connection_settings(const std::string sessionID,
                               const std::string proxyServer,
                               const std::string proxyUserName,
                               const std::string proxyUserPassword);
 
        ~ms_connection_settings();
 
        void defaultValues();
 
        void copyFrom(const ms_connection_settings* right);
 
#ifndef SWIG
        ms_connection_settings& operator=(const ms_connection_settings & right);
#endif
        void setSessionID(const std::string sessionID);
 
        void setProxyServerType(ms_connection_settings::PROXY_TYPE proxyType);
 
        ms_connection_settings::PROXY_TYPE getProxyServerType() const;
 
        void setHttpProtocol(ms_connection_settings::HTTP_PROTOCOL httpProtocol);
 
        ms_connection_settings::HTTP_PROTOCOL getHttpProtocol() const;
 
        void setProxyServer(const std::string proxyServer); 
 
        void setProxyUsername(const std::string proxyUserName); 
 
        void setProxyPassword(const std::string proxyUserPassword); 
 
        void setUserAgent(const std::string userAgent);
 
        void setUseHTTPProxyForFTP(bool value);
 
        void setUseHTTPProxyForHTTPS(bool value);
 
        std::string getSessionID() const;
 
        std::string getProxyServer() const; 
 
        std::string getProxyUsername() const; 
        
        std::string getProxyPassword() const; 
 
        std::string getProxyUserAndPassword() const;
 
        std::string getUserAgent() const;
 
        bool isUseHTTPProxyForFTP() const;
 
        bool isUseHTTPProxyForHTTPS() const;
 
        void setConnectionTimeout(int timeout);
 
        int getConnectionTimeout() const;
 
        void setHttpUsername(const std::string httpUsername); 
 
        std::string getHttpUsername() const; 
 
        void setHttpPassword(const std::string httpPassword); 
 
        std::string getHttpPassword() const; 
 
        void setRedirectPolicy(ms_connection_settings::REDIRECT_POLICY redirectPolicy);
 
        ms_connection_settings::REDIRECT_POLICY getRedirectPolicy() const;
 
        void getProxySettings(const ms_mascotoptions &opts);
 
        static int proxyTypeStringToEnum(std::string str);
 
        static std::string proxyTypeToString(int type);
 
    private:
        std::string sessionID_;
        std::string proxyServer_;
        std::string proxyUserName_;
        std::string proxyUserPassword_;
        bool useHTTPProxyForFTP_;
        bool useHTTPProxyForHTTPS_;
        std::string userAgent_;
        PROXY_TYPE proxyType_;
        HTTP_PROTOCOL httpProtocol_;
        int connectionTimeout_;
        std::string httpUsername_;
        std::string httpPassword_;
        REDIRECT_POLICY redirectPolicy_;
 
        struct proxy_type_strings_t {
            const char *str;
            const char *pretty_str;
            int type;
        };
 
        static const struct proxy_type_strings_t proxy_type_strings[];
    }; // end of http_client_groupp
}
#endif // !defined(ms_connection_settings_INCLUDED_)