Url.hpp

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                                                                      |
|                     _     _   _   _     __     _                     |
|                    | |   | | | \_/ |   /  \   | |                    |
|                    | |   | | | |_| |  / /\ \  | |                    |
|                    | |__ | | | | | | / ____ \ | |__                  |
|                    |____||_| |_| |_|/ /    \ \|____|                 |
|                                                                      |
|                             core library                             |
|                                                                      |
|                                         (C) SUSE Linux Products GmbH |
\----------------------------------------------------------------------/

  File:       Url.hpp

  Author:     Marius Tomaschewski
  Maintainer: Marius Tomaschewski

/-*/
#ifndef   CA_MGM_URL_HPP
#define   CA_MGM_URL_HPP

#include <ca-mgm/config.h>
#include <ca-mgm/UrlBase.hpp>


// -------------------------------------------------------------------
namespace CA_MGM_NAMESPACE
{
namespace url
{

class Url
{
public:
        typedef ca_mgm::url::EEncoding    EEncoding;

        typedef ca_mgm::url::ViewOptions  ViewOptions;


        ~Url();
        Url();

        Url(const Url &url);


        Url(const ca_mgm::url::UrlRef &url);


        Url(const std::string &urlString);


        // -----------------
        static url::UrlRef
        parseUrl(const std::string &urlString);


        // -----------------
        Url&
        operator = (const std::string &urlString);


        Url&
        operator = (const Url &url);


        // -----------------
        std::vector<std::string>
        getKnownSchemes() const;


        bool
        isValidScheme(const std::string &scheme) const;


        bool
        isValid() const;


        // -----------------
        std::string
        toString() const;

        std::string
        toString(const ViewOptions &opts) const;

        std::string
        toCompleteString() const;


        // -----------------
        std::string
        getScheme() const;


        // -----------------
        std::string
        getAuthority() const;

        std::string
        getUsername(EEncoding eflag = ca_mgm::url::E_DECODED) const;

        std::string
        getPassword(EEncoding eflag = ca_mgm::url::E_DECODED) const;

        std::string
        getHost(EEncoding eflag = ca_mgm::url::E_DECODED) const;

        std::string
        getPort() const;


        // -----------------
        std::string
        getPathData() const;

        std::string
        getPathName(EEncoding eflag = ca_mgm::url::E_DECODED) const;

        std::string
        getPathParams() const;

        std::vector<std::string>
        getPathParamsArray() const;

        ca_mgm::url::ParamMap
        getPathParamsMap(EEncoding eflag = ca_mgm::url::E_DECODED) const;

        std::string
        getPathParam(const std::string &param,
                     EEncoding            eflag = ca_mgm::url::E_DECODED) const;


        // -----------------
        std::string
        getQueryString() const;

        std::vector<std::string>
        getQueryStringArray() const;

        ca_mgm::url::ParamMap
        getQueryStringMap(EEncoding eflag = ca_mgm::url::E_DECODED) const;

        std::string
        getQueryParam(const std::string &param,
                      EEncoding            eflag = ca_mgm::url::E_DECODED) const;


        // -----------------
        std::string
        getFragment(EEncoding eflag = ca_mgm::url::E_DECODED) const;


        // -----------------
        void
        setScheme(const std::string &scheme);


        // -----------------
        void
        setAuthority(const std::string &authority);

        void
        setUsername(const std::string &user,
                    EEncoding            eflag = ca_mgm::url::E_DECODED);

        void
        setPassword(const std::string &pass,
                    EEncoding            eflag = ca_mgm::url::E_DECODED);

        void
        setHost(const std::string &host,
                EEncoding            eflag = ca_mgm::url::E_DECODED);

        void
        setPort(const std::string &port);


        // -----------------
        void
        setPathData(const std::string &pathdata);

        void
        setPathName(const std::string &path,
                    EEncoding            eflag = ca_mgm::url::E_DECODED);

        void
        setPathParams(const std::string &params);

        void
        setPathParamsArray(const std::vector<std::string> &parray);

        void
        setPathParamsMap(const ca_mgm::url::ParamMap &pmap);

        void
        setPathParam(const std::string &param, const std::string &value);


        // -----------------
        void
        setQueryString(const std::string &querystr);

        void
        setQueryStringArray(const std::vector<std::string> &qarray);

        void
        setQueryStringMap(const ca_mgm::url::ParamMap &qmap);

        void
        setQueryParam(const std::string &param, const std::string &value);


        // -----------------
        void
        setFragment(const std::string &fragment,
                    EEncoding            eflag = ca_mgm::url::E_DECODED);


        // -----------------
        ViewOptions
        getViewOptions() const;

        void
        setViewOptions(const ViewOptions &vopts);

        friend std::ostream &
        operator<<(std::ostream &os, const Url &url);

private:
        url::UrlRef m_impl;
};


// -------------------------------------------------------------------
}      // End url namespace
}      // End of CA_MGM_NAMESPACE
#endif // CA_MGM_URLUTILS_HPP
// vim: set ts=8 sts=8 sw=8 ai noet: