Url manipulation class. More...

#include <Url.h>

Public Types
typedef zypp::url::EEncoding	EEncoding
	Encoding flags.

typedef zypp::url::ViewOptions	ViewOptions
	View options.

Public Member Functions
	~Url ()

	Url ()

	Url (const Url &url)
	Create a new Url object as shared copy of the given one.

	Url (const zypp::url::UrlRef &url)
	Create a new Url object as shared copy of the given reference.

	Url (const std::string &encodedUrl)
	Construct a Url object from percent-encoded URL string.

Url &	operator= (const std::string &encodedUrl)
	Assigns parsed percent-encoded URL string to the object.

Url &	operator= (const Url &url)
	Assign a shared copy of `url` to the current object.

zypp::url::UrlSchemes	getKnownSchemes () const
	Returns scheme names known to this object.

bool	isValidScheme (const std::string &scheme) const
	Verifies the specified scheme name.

bool	schemeIsLocal () const

bool	schemeIsRemote () const

bool	schemeIsVolatile () const

bool	schemeIsDownloading () const

bool	schemeIsPlugin () const

bool	isValid () const
	Verifies the Url.

std::string	asString () const
	Returns a default string representation of the Url object.

std::string	asString (const ViewOptions &opts) const
	Returns a string representation of the Url object.

std::string	asCompleteString () const
	Returns a complete string representation of the Url object.

std::string	getScheme () const
	Returns the scheme name of the URL.

std::string	getAuthority () const
	Returns the encoded authority component of the URL.

std::string	getUsername (EEncoding eflag=zypp::url::E_DECODED) const
	Returns the username from the URL authority.

std::string	getPassword (EEncoding eflag=zypp::url::E_DECODED) const
	Returns the password from the URL authority.

bool	hasCredentialsInAuthority () const
	Returns `true` if username and password are encoded in the authority component.

std::string	getHost (EEncoding eflag=zypp::url::E_DECODED) const
	Returns the hostname or IP from the URL authority.

std::string	getPort () const
	Returns the port from the URL authority.

std::string	getPathData () const
	Returns the encoded path component of the URL.

std::string	getPathName (EEncoding eflag=zypp::url::E_DECODED) const
	Returns the path name from the URL.

std::string	getPathParams () const
	Returns the path parameters from the URL.

zypp::url::ParamVec	getPathParamsVec () const
	Returns a vector with path parameter substrings.

zypp::url::ParamMap	getPathParamsMap (EEncoding eflag=zypp::url::E_DECODED) const
	Returns a string map with path parameter keys and values.

std::string	getPathParam (const std::string &param, EEncoding eflag=zypp::url::E_DECODED) const
	Return the value for the specified path parameter.

std::string	getQueryString () const
	Returns the encoded query string component of the URL.

zypp::url::ParamVec	getQueryStringVec () const
	Returns a vector with query string parameter substrings.

zypp::url::ParamMap	getQueryStringMap (EEncoding eflag=zypp::url::E_DECODED) const
	Returns a string map with query parameter and their values.

std::string	getQueryParam (const std::string &param, EEncoding eflag=zypp::url::E_DECODED) const
	Return the value for the specified query parameter.

std::string	getFragment (EEncoding eflag=zypp::url::E_DECODED) const
	Returns the encoded fragment component of the URL.

void	setScheme (const std::string &scheme)
	Set the scheme name in the URL.

void	setAuthority (const std::string &authority)
	Set the authority component in the URL.

void	setUsername (const std::string &user, EEncoding eflag=zypp::url::E_DECODED)
	Set the username in the URL authority.

void	setPassword (const std::string &pass, EEncoding eflag=zypp::url::E_DECODED)
	Set the password in the URL authority.

void	setHost (const std::string &host)
	Set the hostname or IP in the URL authority.

void	setPort (const std::string &port)
	Set the port number in the URL authority.

void	setPathData (const std::string &pathdata)
	Set the path data component in the URL.

void	setPathName (const std::string &path, EEncoding eflag=zypp::url::E_DECODED)
	Set the path name.

void	setPathName (const Pathname &path, EEncoding eflag=zypp::url::E_DECODED)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	setPathName (const char *path, EEncoding eflag=zypp::url::E_DECODED)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	appendPathName (const Pathname &path_r, EEncoding eflag_r=zypp::url::E_DECODED)
	Extend the path name.

void	setPathParams (const std::string &params)
	Set the path parameters.

void	setPathParamsVec (const zypp::url::ParamVec &pvec)
	Set the path parameters.

void	setPathParamsMap (const zypp::url::ParamMap &pmap)
	Set the path parameters.

void	setPathParam (const std::string &param, const std::string &value)
	Set or add value for the specified path parameter.

void	setQueryString (const std::string &querystr)
	Set the query string in the URL.

void	setQueryStringVec (const zypp::url::ParamVec &qvec)
	Set the query parameters.

void	setQueryStringMap (const zypp::url::ParamMap &qmap)
	Set the query parameters.

void	setQueryParam (const std::string &param, const std::string &value)
	Set or add value for the specified query parameter.

void	delQueryParam (const std::string &param)
	remove the specified query parameter.

void	setFragment (const std::string &fragment, EEncoding eflag=zypp::url::E_DECODED)
	Set the fragment string in the URL.

ViewOptions	getViewOptions () const
	Return the view options of the current object.

void	setViewOptions (const ViewOptions &vopts)
	Change the view options of the current object.

Static Public Member Functions
static url::UrlRef	parseUrl (const std::string &encodedUrl)
	Parse a percent-encoded URL string.

static bool	registerScheme (const std::string &scheme, url::UrlRef urlImpl)
	Register a scheme-specific implementation.

static zypp::url::UrlSchemes	getRegisteredSchemes ()
	Returns all registered scheme names.

static bool	isRegisteredScheme (const std::string &scheme)
	Returns if scheme name is registered.

static bool	schemeIsLocal (const std::string &scheme_r)
	hd cd dvd dir file iso

static bool	schemeIsRemote (const std::string &scheme_r)
	nfs nfs4 smb cifs http https ftp sftp tftp

static bool	schemeIsVolatile (const std::string &scheme_r)
	cd dvd

static bool	schemeIsDownloading (const std::string &scheme_r)
	http https ftp sftp tftp

static bool	schemeIsPlugin (const std::string &scheme_r)
	plugin

Private Attributes
url::UrlRef	m_impl

Friends
std::string	hotfix1050625::asString (const Url &url_r)

Detailed Description

Url manipulation class.

The generic URL (URI) syntax and its main components are defined in RFC3986 (http://rfc.net/rfc3986.html) Section 3, "Syntax Components". The scheme specific URL syntax and semantics is defined in the specification of the particular scheme. See also RFC1738 (http://rfc.net/rfc1738.html), that defines specific syntax for several URL schemes.

This class provides methods to access and manipulate generic and common scheme-specific URL components (or using the more general term, URI components). To consider the scheme-specifics of a URL, the Url class contains a reference object pointing to a UrlBase or derived object, that implements the scheme specifics.

Using the Url::registerScheme() method, it is possible to register a preconfigured or derived UrlBase object for a specific scheme name. The registered object will be cloned to handle all URLs containing the specified scheme name.

RFC3986, Syntax Components:

The generic URI syntax consists of a hierarchical sequence of components referred to as the scheme, authority, path, query, and fragment.

URI         = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
 
hier-part   = "//" authority path-abempty
            / path-absolute
            / path-rootless
            / path-empty

The scheme and path components are required, though the path may be empty (no characters). When authority is present, the path must either be empty or begin with a slash ("/") character. When authority is not present, the path cannot begin with two slash characters ("//"). These restrictions result in five different ABNF rules for a path (Section 3.3), only one of which will match any given URI reference.

The following are two example URIs and their component parts:

  foo://example.com:8042/over/there?name=ferret#nose
  \_/   \______________/\_________/ \_________/ \__/
   |           |            |            |        |
scheme     authority       path        query   fragment
   |   _____________________|__
  / \ /                        \
  urn:example:animal:ferret:nose

Definition at line 91 of file Url.h.

Member Typedef Documentation

◆ EEncoding

typedef zypp::url::EEncoding zypp::Url::EEncoding

Encoding flags.

Definition at line 97 of file Url.h.

◆ ViewOptions

typedef zypp::url::ViewOptions zypp::Url::ViewOptions

View options.

Definition at line 102 of file Url.h.

Constructor & Destructor Documentation

◆ ~Url()

zypp::Url::~Url ( )

Definition at line 282 of file Url.cc.

◆ Url() [1/4]

zypp::Url::Url ( )

Definition at line 288 of file Url.cc.

◆ Url() [2/4]

zypp::Url::Url ( const Url & url )

Create a new Url object as shared copy of the given one.

Upon return, both objects will point to the same underlying object. This state will remain until one of the object is modified.

Parameters

url	The Url object to make a copy of.

Exceptions

url::UrlException if copy fails (should not happen).

Definition at line 295 of file Url.cc.

◆ Url() [3/4]

zypp::Url::Url ( const zypp::url::UrlRef & url )

Create a new Url object as shared copy of the given reference.

Upon return, both objects will point to the same underlying object. This state will remain until one of the object is modified.

Parameters

url	The URL implementation reference to make a copy of.

Exceptions

url::UrlException if reference is empty.

Definition at line 308 of file Url.cc.

◆ Url() [4/4]

zypp::Url::Url ( const std::string & encodedUrl )

Construct a Url object from percent-encoded URL string.

Parses the encodedUrl string using the parseUrl() method and assigns the result to the newly created object.

Parameters

encodedUrl A percent-encoded URL string.

Exceptions

url::UrlParsingException	if parsing of the url fails.
url::UrlNotAllowedException	if one of the components is not allowed for the scheme.
url::UrlBadComponentException	if one of the components contains an invalid character.

Definition at line 321 of file Url.cc.

Member Function Documentation

◆ parseUrl()

UrlRef zypp::Url::parseUrl ( const std::string & encodedUrl )

static

Parse a percent-encoded URL string.

Tries to parse the given string into generic URL components and creates a clone of a scheme-specialized object or a new UrlBase object.

Parameters

encodedUrl A percent-encoded URL string.

Returns: A reference to a (derived) UrlBase object or empty reference if the encodedUrl string does not match the generic URL syntax.

Exceptions

url::UrlNotAllowedException	if one of the components is not allowed for the scheme.
url::UrlBadComponentException	if one of the components contains an invalid character.

Definition at line 371 of file Url.cc.

◆ operator=() [1/2]

Url & zypp::Url::operator= ( const std::string & encodedUrl )

Assigns parsed percent-encoded URL string to the object.

Parses encodedUrl string using the parseUrl() method and assigns the result to the current object.

Parameters

encodedUrl A percent-encoded URL string.

Returns: A reference to this Url object.

Exceptions

url::UrlParsingException	if parsing of the url fails.
url::UrlNotAllowedException	if one of the components is not allowed for the scheme.
url::UrlBadComponentException	if one of the components contains an invalid character.

Definition at line 335 of file Url.cc.

◆ operator=() [2/2]

Url & zypp::Url::operator= ( const Url & url )

Assign a shared copy of url to the current object.

Upon return, both objects will point to the same underlying object. This state will remain until one of the objects is modified.

Parameters

url	The Url object to make a copy of.

Returns: A reference to this Url object.

Definition at line 351 of file Url.cc.

◆ registerScheme()

bool zypp::Url::registerScheme	(	const std::string &	scheme,
		url::UrlRef	urlImpl
	)

static

Register a scheme-specific implementation.

Parameters

scheme	A name of a scheme.
urlImpl	A UrlBase object specialized for this scheme.

Returns: True, if the object claims to implement the scheme.

Definition at line 361 of file Url.cc.

◆ getRegisteredSchemes()

zypp::url::UrlSchemes zypp::Url::getRegisteredSchemes ( )

static

Returns all registered scheme names.

Returns: A vector with registered URL scheme names.

Definition at line 415 of file Url.cc.

◆ isRegisteredScheme()

bool zypp::Url::isRegisteredScheme ( const std::string & scheme )

static

Returns if scheme name is registered.

Returns: True, if scheme name is registered.

Definition at line 424 of file Url.cc.

◆ getKnownSchemes()

zypp::url::UrlSchemes zypp::Url::getKnownSchemes ( ) const

Returns scheme names known to this object.

Returns: A vector with scheme names known by this object.

Definition at line 432 of file Url.cc.

◆ isValidScheme()

bool zypp::Url::isValidScheme ( const std::string & scheme ) const

Verifies the specified scheme name.

Verifies the generic syntax of the specified scheme name and if it is contained in the current object's list of known schemes (see getKnownSchemes()) if the list is not empty.

The default implementation in the UrlBase class returns an emtpy list of known schemes, causing a check of the generic syntax only.

Returns: True, if generic scheme name syntax is valid and the scheme name is known to the current object.

Definition at line 281 of file Url.h.

◆ isValid()

bool zypp::Url::isValid ( ) const

Verifies the Url.

Verifies if the current object contains a non-empty scheme name. Additional semantical URL checks may be performed by derived UrlBase objects.

Returns: True, if the Url seems to be valid.

Definition at line 489 of file Url.cc.

◆ asString() [1/2]

std::string zypp::Url::asString ( ) const

Returns a default string representation of the Url object.

By default, a password in the URL will be hidden.

Returns: A default string representation of the Url object.

Definition at line 497 of file Url.cc.

◆ asString() [2/2]

std::string zypp::Url::asString ( const ViewOptions & opts ) const

Returns a string representation of the Url object.

To include a password in the resulting Url string, use:

url.asString(url.getViewOptions() +

url::ViewOptions::WITH_PASSWORD);

zypp::url::ViewOption::WITH_PASSWORD

static const ViewOption WITH_PASSWORD

Option to include password in the URL string.

Definition: UrlBase.h:67

Parameters

opts	A combination of view options.

Returns: A string representation of the Url object.

Definition at line 525 of file Url.cc.

◆ asCompleteString()

std::string zypp::Url::asCompleteString ( ) const

Returns a complete string representation of the Url object.

This function ignores the configuration of the view options in the current object (see setViewOption()) and forces to return a string with all URL components included.

Returns: A complete string representation of the Url object.

Definition at line 505 of file Url.cc.

◆ getScheme()

std::string zypp::Url::getScheme ( ) const

Returns the scheme name of the URL.

Returns: Scheme name of the current Url object.

Definition at line 533 of file Url.cc.

◆ getAuthority()

std::string zypp::Url::getAuthority ( ) const

Returns the encoded authority component of the URL.

The returned authority string does not contain the leading "//" separator characters, but just its "user:pass@host:port" content only.

Returns: The encoded authority component string.

Definition at line 541 of file Url.cc.

◆ getUsername()

std::string zypp::Url::getUsername ( EEncoding eflag = zypp::url::E_DECODED ) const

Returns the username from the URL authority.

Parameters

eflag Flag if the usename should be percent-decoded or not.

Returns: The username sub-component from the URL authority.

Exceptions

url::UrlDecodingException if the decoded result string would contain a '\0' character.

Definition at line 572 of file Url.cc.

◆ getPassword()

std::string zypp::Url::getPassword ( EEncoding eflag = zypp::url::E_DECODED ) const

Returns the password from the URL authority.

Parameters

eflag Flag if the password should be percent-decoded or not.

Returns: The password sub-component from the URL authority.

Exceptions

url::UrlDecodingException if the decoded result string would contain a '\0' character.

Definition at line 580 of file Url.cc.

◆ hasCredentialsInAuthority()

bool zypp::Url::hasCredentialsInAuthority ( ) const

inline

Returns true if username and password are encoded in the authority component.

Definition at line 380 of file Url.h.

◆ getHost()

std::string zypp::Url::getHost ( EEncoding eflag = zypp::url::E_DECODED ) const

Returns the hostname or IP from the URL authority.

In case the Url contains an IP number, it may be surrounded by "[" and "]" characters, for example "[::1]" for an IPv6 localhost address.

Parameters

eflag Flag if the host should be percent-decoded or not.

Returns: The host sub-component from the URL authority.

Exceptions

url::UrlDecodingException if the decoded result string would contain a '\0' character.

Definition at line 588 of file Url.cc.

◆ getPort()

std::string zypp::Url::getPort ( ) const

Returns the port from the URL authority.

Returns: The port sub-component from the URL authority.

Definition at line 596 of file Url.cc.

◆ getPathData()

std::string zypp::Url::getPathData ( ) const

Returns the encoded path component of the URL.

The path data contains the path name, optionally followed by path parameters separated with a ";" character, for example "/foo/bar;version=1.1".

Returns: The encoded path component of the URL.

Definition at line 548 of file Url.cc.

◆ getPathName()

std::string zypp::Url::getPathName ( EEncoding eflag = zypp::url::E_DECODED ) const

Returns the path name from the URL.

Parameters

eflag Flag if the path should be decoded or not.

Returns: The path name sub-component without path parameters from Path-Data component of the URL.

Exceptions

url::UrlDecodingException if the decoded result string would contain a '\0' character.

Definition at line 604 of file Url.cc.

◆ getPathParams()

std::string zypp::Url::getPathParams ( ) const

Returns the path parameters from the URL.

Returns: The encoded path parameters from the URL.

Definition at line 612 of file Url.cc.

◆ getPathParamsVec()

zypp::url::ParamVec zypp::Url::getPathParamsVec ( ) const

Returns a vector with path parameter substrings.

The default path parameter separator is the ',' character. A schema specific object may overide the default separators.

For example, the path parameters string "foo=1,bar=2" is splited by default into a vector containing the substrings "foo=1" and "bar=2".

Returns: The path parameters splited into a vector of substrings.

Definition at line 620 of file Url.cc.

◆ getPathParamsMap()

zypp::url::ParamMap zypp::Url::getPathParamsMap ( EEncoding eflag = zypp::url::E_DECODED ) const

Returns a string map with path parameter keys and values.

The default path parameter separator is the ',' character, the default key/value separator for the path parameters is the '=' character. A schema specific object may overide the default separators.

For example, the path parameters string "foo=1,bar=2" is splited into a map containing "foo" = "1" and "bar" = "2" by default.

Parameters

eflag Flag if the path parameter keys and values should be decoded or not.

Returns: The path parameters key and values as a string map.

Exceptions

url::UrlNotSupportedException	if parameter parsing is not supported for a URL (scheme).
url::UrlDecodingException	if the decoded result string would contain a '\0' character.

Definition at line 628 of file Url.cc.

◆ getPathParam()

std::string zypp::Url::getPathParam	(	const std::string &	param,
		EEncoding	eflag = `zypp::url::E_DECODED`
	)		const

Return the value for the specified path parameter.

For example, if the path parameters string is "foo=1,bar=2" the method will return the substring "1" for the param key "foo" and "2" for the param key "bar".

Parameters

param	The path parameter key.
eflag	Flag if the path parameter keys and values should be decoded or not.

Returns: The value for the path parameter key or empty string.

Exceptions

url::UrlNotSupportedException	if parameter parsing is not supported for a URL (scheme).
url::UrlDecodingException	if the decoded result string would contain a '\0' character.

Definition at line 636 of file Url.cc.

◆ getQueryString()

std::string zypp::Url::getQueryString ( ) const

Returns the encoded query string component of the URL.

The query string is returned without first "?" (separator) character. Further "?" characters as in e.g. LDAP URLs remain in the returned string.

Returns: The encoded query string component of the URL.

Definition at line 556 of file Url.cc.

◆ getQueryStringVec()

zypp::url::ParamVec zypp::Url::getQueryStringVec ( ) const

Returns a vector with query string parameter substrings.

The default query string parameter separator is the '&' character. A schema specific object may overide the default separators.

For example, the query string "foo=1&bar=2" is splited by default into a vector containing the substrings "foo=1" and "bar=2".

Returns: The query string splited into a vector of substrings.

Definition at line 644 of file Url.cc.

◆ getQueryStringMap()

zypp::url::ParamMap zypp::Url::getQueryStringMap ( EEncoding eflag = zypp::url::E_DECODED ) const

Returns a string map with query parameter and their values.

The default query string parameter separator is the ',' character, the default key/value separator the '=' character. A schema specific object may overide the default separators.

For example, the query string "foo=1&bar=2" is splited by default into a map containing "foo" = "1" and "bar" = "2".

Parameters

eflag Flag if the query string keys and values should be decoded or not.

Returns: The query string as a key/value string map.

Exceptions

url::UrlNotSupportedException	if parameter parsing is not supported for a URL (scheme).
url::UrlDecodingException	if the decoded result string would contain a '\0' character.

Definition at line 652 of file Url.cc.

◆ getQueryParam()

std::string zypp::Url::getQueryParam	(	const std::string &	param,
		EEncoding	eflag = `zypp::url::E_DECODED`
	)		const

Return the value for the specified query parameter.

For example, if the query string is "foo=1,bar=2" the method will return the substring "1" for the param key "foo" and "2" for the param key "bar".

Parameters

param	The query parameter key.
eflag	Flag if the query parameter keys and values should be decoded or not.

Returns: The value for the query parameter key or empty string.

Exceptions

url::UrlNotSupportedException	if parameter parsing is not supported for a URL (scheme).
url::UrlDecodingException	if the decoded result string would contain a '\0' character.

Definition at line 660 of file Url.cc.

◆ getFragment()

std::string zypp::Url::getFragment ( EEncoding eflag = zypp::url::E_DECODED ) const

Returns the encoded fragment component of the URL.

Parameters

eflag Flag if the fragment should be percent-decoded or not.

Returns: The encoded fragment component of the URL.

Exceptions

url::UrlDecodingException if the decoded result string would contain a '\0' character.

Definition at line 564 of file Url.cc.

◆ setScheme()

void zypp::Url::setScheme ( const std::string & scheme )

Set the scheme name in the URL.

Parameters

scheme The new scheme name.

Exceptions

url::UrlBadComponentException if the scheme contains an invalid character or is empty.

Definition at line 668 of file Url.cc.

◆ setAuthority()

void zypp::Url::setAuthority ( const std::string & authority )

Set the authority component in the URL.

The authority string shoud contain the "user:pass@host:port" sub-components without any leading "//" separator characters.

Parameters

authority The encoded authority component string.

Exceptions

url::UrlNotAllowedException	if the `authority` has to be empty in for the current scheme.
url::UrlBadComponentException	if the `authority` contains an invalid character.
url::UrlParsingException	if `authority` parsing fails.

Definition at line 698 of file Url.cc.

◆ setUsername()

void zypp::Url::setUsername	(	const std::string &	user,
		EEncoding	eflag = `zypp::url::E_DECODED`
	)

Set the username in the URL authority.

Parameters

user	The new username.
eflag	If the `username` is encoded or not.

Exceptions

url::UrlNotAllowedException	if the `user` has to be empty in for the current scheme
url::UrlBadComponentException	if the `user` contains an invalid character.

Definition at line 730 of file Url.cc.

◆ setPassword()

void zypp::Url::setPassword	(	const std::string &	pass,
		EEncoding	eflag = `zypp::url::E_DECODED`
	)

Set the password in the URL authority.

Parameters

pass	The new password.
eflag	If the `password` is encoded or not.

Exceptions

url::UrlNotAllowedException	if the `pass` has to be empty in for the current scheme.
url::UrlBadComponentException	if the `pass` contains an invalid character.

Definition at line 739 of file Url.cc.

◆ setHost()

void zypp::Url::setHost ( const std::string & host )

Set the hostname or IP in the URL authority.

The host parameter may contain a hostname, an IPv4 address in dotted-decimal form or an IPv6 address literal encapsulated within square brackets (RFC3513, Sect. 2.2).

A hostname may contain national alphanumeric UTF8 characters (letters other than ASCII a-z0-9), that will be encoded. This function allows to specify both, a encoded or decoded hostname.

Other IP literals in "[v ... ]" square bracket format are not supported by the implementation in UrlBase class.

Parameters

host	The new hostname or IP address.

Exceptions

url::UrlNotAllowedException	if the `host` (authority) has to be empty in for the current scheme.
url::UrlBadComponentException	if the `host` is invalid.

Definition at line 748 of file Url.cc.

◆ setPort()

void zypp::Url::setPort ( const std::string & port )

Set the port number in the URL authority.

Parameters

port	The new port number.

Exceptions

url::UrlNotAllowedException	if the `port` (authority) has to be empty in for the current scheme.
url::UrlBadComponentException	if the `port` is invalid.

Definition at line 756 of file Url.cc.

◆ setPathData()

void zypp::Url::setPathData ( const std::string & pathdata )

Set the path data component in the URL.

By default, the pathdata string may include path parameters separated by the ";" separator character.

Parameters

pathdata The encoded path data component string.

Exceptions

url::UrlBadComponentException if the pathdata contains an invalid character.

Definition at line 706 of file Url.cc.

◆ setPathName() [1/3]

void zypp::Url::setPathName	(	const std::string &	path,
		EEncoding	eflag = `zypp::url::E_DECODED`
	)

Set the path name.

Parameters

path	The new path name.
eflag	If the `path` name is encoded or not.

Exceptions

url::UrlBadComponentException if the path name contains an invalid character.

Definition at line 764 of file Url.cc.

◆ setPathName() [2/3]

void zypp::Url::setPathName	(	const Pathname &	path,
		EEncoding	eflag = `zypp::url::E_DECODED`
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 771 of file Url.cc.

◆ setPathName() [3/3]

void zypp::Url::setPathName	(	const char *	path,
		EEncoding	eflag = `zypp::url::E_DECODED`
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 778 of file Url.cc.

◆ appendPathName()

void zypp::Url::appendPathName	(	const Pathname &	path_r,
		EEncoding	eflag_r = `zypp::url::E_DECODED`
	)

Extend the path name.

Definition at line 786 of file Url.cc.

◆ setPathParams()

void zypp::Url::setPathParams ( const std::string & params )

Set the path parameters.

Parameters

params The new encoded path parameter string.

Exceptions

url::UrlBadComponentException if the path params contains an invalid character.

Definition at line 791 of file Url.cc.

◆ setPathParamsVec()

void zypp::Url::setPathParamsVec ( const zypp::url::ParamVec & pvec )

Set the path parameters.

Parameters

pvec	The vector with encoded path parameters.

Exceptions

url::UrlBadComponentException if the pvec contains an invalid character.

Definition at line 799 of file Url.cc.

◆ setPathParamsMap()

void zypp::Url::setPathParamsMap ( const zypp::url::ParamMap & pmap )

Set the path parameters.

Parameters

pmap	The map with decoded path parameters.

Exceptions

url::UrlNotSupportedException if parameter parsing is not supported for a URL (scheme).

Definition at line 807 of file Url.cc.

◆ setPathParam()

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

Set or add value for the specified path parameter.

Parameters

param	The decoded path parameter name.
value	The decoded path parameter value.

Exceptions

url::UrlNotSupportedException	if parameter parsing is not supported for a URL (scheme).
url::UrlDecodingException	if the decoded result string would contain a '\0' character.

Definition at line 815 of file Url.cc.

◆ setQueryString()

void zypp::Url::setQueryString ( const std::string & querystr )

Set the query string in the URL.

Parameters

querystr The new encoded query string.

Exceptions

url::UrlBadComponentException if the querystr contains an invalid character.

Definition at line 714 of file Url.cc.

◆ setQueryStringVec()

void zypp::Url::setQueryStringVec ( const zypp::url::ParamVec & qvec )

Set the query parameters.

Parameters

qvec	The vector with encoded query parameters.

Exceptions

url::UrlBadComponentException if the qvec contains an invalid character.

Definition at line 823 of file Url.cc.

◆ setQueryStringMap()

void zypp::Url::setQueryStringMap ( const zypp::url::ParamMap & qmap )

Set the query parameters.

Parameters

qmap	The map with decoded query parameters.

Exceptions

url::UrlNotSupportedException if parameter parsing is not supported for a URL (scheme).

Definition at line 831 of file Url.cc.

◆ setQueryParam()

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

Set or add value for the specified query parameter.

Parameters

param	The decoded query parameter name.
value	The decoded query parameter value.

Exceptions

url::UrlNotSupportedException	if parameter parsing is not supported for a URL (scheme).
url::UrlDecodingException	if the decoded result string would contain a '\0' character.

Definition at line 838 of file Url.cc.

◆ delQueryParam()

void zypp::Url::delQueryParam ( const std::string & param )

remove the specified query parameter.

Parameters

param The decoded query parameter name.

Exceptions

url::UrlNotSupportedException	if parameter parsing is not supported for a URL (scheme).
url::UrlDecodingException	if the decoded result string would contain a '\0' character.

Definition at line 845 of file Url.cc.

◆ setFragment()

void zypp::Url::setFragment	(	const std::string &	fragment,
		EEncoding	eflag = `zypp::url::E_DECODED`
	)

Set the fragment string in the URL.

Parameters

fragment	The new fragment string.
eflag	If the `fragment` is encoded or not.

Exceptions

url::UrlBadComponentException if the fragment contains an invalid character.

Definition at line 722 of file Url.cc.

◆ getViewOptions()

ViewOptions zypp::Url::getViewOptions ( ) const

Return the view options of the current object.

This method is used to query the view options used by the asString() method.

Returns: The current view option combination.

Definition at line 852 of file Url.cc.

◆ setViewOptions()

void zypp::Url::setViewOptions ( const ViewOptions & vopts )

Change the view options of the current object.

This method is used to change the view options used by the asString() method.

Parameters

vopts New view options combination.

Definition at line 859 of file Url.cc.

Friends And Related Function Documentation

◆ hotfix1050625::asString

std::string hotfix1050625::asString ( const Url & url_r )

friend

Member Data Documentation

◆ m_impl

url::UrlRef zypp::Url::m_impl

private

Definition at line 834 of file Url.h.

The documentation for this class was generated from the following files:

zypp/Url.h
zypp-core/Url.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ EEncoding

◆ ViewOptions

Constructor & Destructor Documentation

◆ ~Url()

◆ Url() [1/4]

◆ Url() [2/4]

◆ Url() [3/4]

◆ Url() [4/4]

Member Function Documentation

◆ parseUrl()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ registerScheme()

◆ getRegisteredSchemes()

◆ isRegisteredScheme()

◆ getKnownSchemes()

◆ isValidScheme()

◆ schemeIsLocal() [1/2]

◆ schemeIsLocal() [2/2]

◆ schemeIsRemote() [1/2]

◆ schemeIsRemote() [2/2]

◆ schemeIsVolatile() [1/2]

◆ schemeIsVolatile() [2/2]

◆ schemeIsDownloading() [1/2]

◆ schemeIsDownloading() [2/2]

◆ schemeIsPlugin() [1/2]

◆ schemeIsPlugin() [2/2]

◆ isValid()

◆ asString() [1/2]

◆ asString() [2/2]

◆ asCompleteString()

◆ getScheme()

◆ getAuthority()

◆ getUsername()

◆ getPassword()

◆ hasCredentialsInAuthority()

◆ getHost()

◆ getPort()

◆ getPathData()

◆ getPathName()

◆ getPathParams()

◆ getPathParamsVec()

◆ getPathParamsMap()

◆ getPathParam()

◆ getQueryString()

◆ getQueryStringVec()

◆ getQueryStringMap()

◆ getQueryParam()

◆ getFragment()

◆ setScheme()

◆ setAuthority()

◆ setUsername()

◆ setPassword()

◆ setHost()

◆ setPort()

◆ setPathData()

◆ setPathName() [1/3]

◆ setPathName() [2/3]

◆ setPathName() [3/3]

◆ appendPathName()

◆ setPathParams()

◆ setPathParamsVec()

◆ setPathParamsMap()

◆ setPathParam()

◆ setQueryString()

◆ setQueryStringVec()

◆ setQueryStringMap()

◆ setQueryParam()

◆ delQueryParam()

◆ setFragment()

◆ getViewOptions()

◆ setViewOptions()

Friends And Related Function Documentation