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   LIMAL_URL_HPP
#define   LIMAL_URL_HPP

#include <limal/config.h>
#include <limal/UrlBase.hpp>


// -------------------------------------------------------------------
namespace LIMAL_NAMESPACE
{
namespace url
{

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

        typedef limal::url::ViewOptions  ViewOptions;


        ~Url();
        Url();

        Url(const Url &url);


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


        Url(const blocxx::String &urlString);


        // -----------------
        static url::UrlRef
        parseUrl(const blocxx::String &urlString);


        // -----------------
        Url&
        operator = (const blocxx::String &urlString);


        Url&
        operator = (const Url &url);


        // -----------------
        blocxx::StringArray
        getKnownSchemes() const;


        bool
        isValidScheme(const blocxx::String &scheme) const;


        bool
        isValid() const;


        // -----------------
        blocxx::String
        toString() const;

        blocxx::String
        toString(const ViewOptions &opts) const;

        blocxx::String
        toCompleteString() const;


        // -----------------
        blocxx::String
        getScheme() const;


        // -----------------
        blocxx::String
        getAuthority() const;

        blocxx::String
        getUsername(EEncoding eflag = limal::url::E_DECODED) const;

        blocxx::String
        getPassword(EEncoding eflag = limal::url::E_DECODED) const;

        blocxx::String
        getHost(EEncoding eflag = limal::url::E_DECODED) const;

        blocxx::String
        getPort() const;


        // -----------------
        blocxx::String
        getPathData() const;

        blocxx::String
        getPathName(EEncoding eflag = limal::url::E_DECODED) const;

        blocxx::String
        getPathParams() const;

        blocxx::StringArray
        getPathParamsArray() const;

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

        blocxx::String
        getPathParam(const blocxx::String &param,
                     EEncoding            eflag = limal::url::E_DECODED) const;


        // -----------------
        blocxx::String
        getQueryString() const;

        blocxx::StringArray
        getQueryStringArray() const;

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

        blocxx::String
        getQueryParam(const blocxx::String &param,
                      EEncoding            eflag = limal::url::E_DECODED) const;


        // -----------------
        blocxx::String
        getFragment(EEncoding eflag = limal::url::E_DECODED) const;


        // -----------------
        void
        setScheme(const blocxx::String &scheme);


        // -----------------
        void
        setAuthority(const blocxx::String &authority);

        void
        setUsername(const blocxx::String &user,
                    EEncoding            eflag = limal::url::E_DECODED);

        void
        setPassword(const blocxx::String &pass,
                    EEncoding            eflag = limal::url::E_DECODED);

        void
        setHost(const blocxx::String &host,
                EEncoding            eflag = limal::url::E_DECODED);

        void
        setPort(const blocxx::String &port);


        // -----------------
        void
        setPathData(const blocxx::String &pathdata);

        void
        setPathName(const blocxx::String &path,
                    EEncoding            eflag = limal::url::E_DECODED);

        void
        setPathParams(const blocxx::String &params);

        void
        setPathParamsArray(const blocxx::StringArray &parray);

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

        void
        setPathParam(const blocxx::String &param, const blocxx::String &value);


        // -----------------
        void
        setQueryString(const blocxx::String &querystr);

        void
        setQueryStringArray(const blocxx::StringArray &qarray);

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

        void
        setQueryParam(const blocxx::String &param, const blocxx::String &value);


        // -----------------
        void
        setFragment(const blocxx::String &fragment,
                    EEncoding            eflag = limal::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 LIMAL_NAMESPACE
#endif // LIMAL_URLUTILS_HPP
// vim: set ts=8 sts=8 sw=8 ai noet: