limal::url::UrlBase Class Reference

Generic Url base class. More...

#include <UrlBase.hpp>

List of all members.

Public Member Functions
virtual	~UrlBase ()
	UrlBase ()
	UrlBase (const UrlBase &url)
	UrlBase (const UrlComponents &components)
	Construct new object and initializes it with specified URL components.
	UrlBase (const BLOCXX_NAMESPACE::String &urlString)
UrlBase &	operator= (const UrlBase &url)
	Assign shared copy of url to the current object.
UrlBase &	operator= (const BLOCXX_NAMESPACE::String &urlString)
	Assigns parsed percent-encoded URL string to the object.
virtual void	clear ()
	Clears all data in the object.
virtual UrlBase *	clone () const
virtual void	init (const UrlComponents &components)
	Initializes current object with new URL components.
virtual BLOCXX_NAMESPACE::StringArray	getKnownSchemes () const
	Returns scheme names known by this object.
virtual bool	isKnownScheme (const BLOCXX_NAMESPACE::String &scheme) const
	Returns if scheme name is known to this object.
virtual bool	isValidScheme (const BLOCXX_NAMESPACE::String &scheme) const
	Verifies specified scheme name.
virtual bool	isValid () const
	Verifies the Url.
virtual BLOCXX_NAMESPACE::String	toString () const
virtual BLOCXX_NAMESPACE::String	toString (const limal::url::ViewOptions &opts) const
virtual BLOCXX_NAMESPACE::String	getScheme () const
virtual BLOCXX_NAMESPACE::String	getAuthority () const
virtual BLOCXX_NAMESPACE::String	getUsername (EEncoding eflag) const
virtual BLOCXX_NAMESPACE::String	getPassword (EEncoding eflag) const
virtual BLOCXX_NAMESPACE::String	getHost (EEncoding eflag) const
virtual BLOCXX_NAMESPACE::String	getPort () const
virtual BLOCXX_NAMESPACE::String	getPathData () const
virtual BLOCXX_NAMESPACE::String	getPathName (EEncoding eflag) const
virtual BLOCXX_NAMESPACE::String	getPathParams () const
virtual BLOCXX_NAMESPACE::StringArray	getPathParamsArray () const
virtual limal::url::ParamMap	getPathParamsMap (EEncoding eflag) const
virtual BLOCXX_NAMESPACE::String	getPathParam (const BLOCXX_NAMESPACE::String &param, EEncoding eflag) const
virtual BLOCXX_NAMESPACE::String	getQueryString () const
virtual BLOCXX_NAMESPACE::StringArray	getQueryStringArray () const
virtual limal::url::ParamMap	getQueryStringMap (EEncoding eflag) const
virtual BLOCXX_NAMESPACE::String	getQueryParam (const BLOCXX_NAMESPACE::String &param, EEncoding eflag) const
virtual BLOCXX_NAMESPACE::String	getFragment (EEncoding eflag) const
virtual void	setScheme (const BLOCXX_NAMESPACE::String &scheme)
	Set the scheme name in the URL.
virtual void	setAuthority (const BLOCXX_NAMESPACE::String &authority)
	Set the authority component in the URL.
virtual void	setUsername (const BLOCXX_NAMESPACE::String &user, EEncoding eflag)
	Set the username in the URL authority.
virtual void	setPassword (const BLOCXX_NAMESPACE::String &pass, EEncoding eflag)
	Set the password in the URL authority.
virtual void	setHost (const BLOCXX_NAMESPACE::String &host, EEncoding eflag)
	Set the hostname or IP in the URL authority.
virtual void	setPort (const BLOCXX_NAMESPACE::String &port)
	Set the port number in the URL authority.
virtual void	setPathData (const BLOCXX_NAMESPACE::String &pathdata)
	Set the path data component in the URL.
virtual void	setPathName (const BLOCXX_NAMESPACE::String &path, EEncoding eflag)
	Set the path name.
virtual void	setPathParams (const BLOCXX_NAMESPACE::String &params)
	Set the path parameters.
virtual void	setPathParamsArray (const BLOCXX_NAMESPACE::StringArray &parray)
	Set the path parameters.
virtual void	setPathParamsMap (const limal::url::ParamMap &pmap)
	Set the path parameters.
virtual void	setPathParam (const BLOCXX_NAMESPACE::String &param, const BLOCXX_NAMESPACE::String &value)
	Set or add value for the specified path parameter.
virtual void	setQueryString (const BLOCXX_NAMESPACE::String &querystr)
	Set the query string in the URL.
virtual void	setQueryStringArray (const BLOCXX_NAMESPACE::StringArray &qarray)
	Set the query parameters.
virtual void	setQueryStringMap (const limal::url::ParamMap &qmap)
	Set the query parameters.
virtual void	setQueryParam (const BLOCXX_NAMESPACE::String &param, const BLOCXX_NAMESPACE::String &value)
	Set or add value for the specified query parameter.
virtual void	setFragment (const BLOCXX_NAMESPACE::String &fragment, EEncoding eflag)
	Set the fragment string in the URL.
virtual void	configure ()
BLOCXX_NAMESPACE::String	config (const BLOCXX_NAMESPACE::String &opt) const
void	config (const BLOCXX_NAMESPACE::String &opt, const BLOCXX_NAMESPACE::String &val)
ViewOptions	getViewOptions () const
void	setViewOptions (const ViewOptions &vopts)

Protected Member Functions
virtual BLOCXX_NAMESPACE::String	cleanupPathName (const BLOCXX_NAMESPACE::String &path, bool authority) const
virtual BLOCXX_NAMESPACE::String	cleanupPathName (const BLOCXX_NAMESPACE::String &path) const
virtual void	checkValidScheme (const BLOCXX_NAMESPACE::String &scheme, EEncoding eflag) const
virtual void	checkValidUser (const BLOCXX_NAMESPACE::String &user, EEncoding eflag) const
virtual void	checkValidPass (const BLOCXX_NAMESPACE::String &pass, EEncoding eflag) const
virtual void	checkValidHost (const BLOCXX_NAMESPACE::String &host, EEncoding eflag) const
	Verifies specified host or IP.
virtual void	checkValidPort (const BLOCXX_NAMESPACE::String &port, EEncoding eflag) const
	Verifies if specified port number is in the range 0..65535.
virtual void	checkValidPathName (const BLOCXX_NAMESPACE::String &path, EEncoding eflag) const
virtual void	checkValidPathParams (const BLOCXX_NAMESPACE::String &params, EEncoding eflag) const
virtual void	checkValidQueryStr (const BLOCXX_NAMESPACE::String &querystr, EEncoding eflag) const
virtual void	checkValidFragment (const BLOCXX_NAMESPACE::String &fragment, EEncoding eflag) const

Private Attributes
BLOCXX_NAMESPACE::COWReference < UrlBaseData >	m_data

---

Detailed Description

Generic Url base class.

The UrlBase class implements default behaviour for URL manipulations and a base for implementation of scheme- specialized URL's for the Url class.

---

Constructor & Destructor Documentation

virtual limal::url::UrlBase::~UrlBase ( )

virtual

Destroys the current object.

limal::url::UrlBase::UrlBase

(

)

Create an empty Url object.

limal::url::UrlBase::UrlBase

(

const UrlBase &

url

)

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

Parameters:

url	The Url object to make a copy of.

limal::url::UrlBase::UrlBase

(

const UrlComponents &

components

)

Construct new object and initializes it with specified URL components.

Parameters:

components

The url main component string to use.

Exceptions:

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

limal::url::UrlBase::UrlBase

(

const BLOCXX_NAMESPACE::String &

urlString

)

Create a new Url object from from percent-encoded URL string.

Parameters:

urlString

The 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.

---

Member Function Documentation

virtual void limal::url::UrlBase::checkValidFragment ( const BLOCXX_NAMESPACE::String &  fragment, EEncoding  eflag  ) const

protectedvirtual

virtual void limal::url::UrlBase::checkValidHost ( const BLOCXX_NAMESPACE::String &  host, EEncoding  eflag  ) const

protectedvirtual

Verifies specified host or IP.

It verifies, if the specified host parameter contains a hostname, an IPv4 address in dotted-decimal form or an IPv6 address literal encapsulated within square brackets (RFC3513, Sect. 2.2).

A hostname in the host parameter, may contain national alphanumeric UTF8 characters (letters other than ASCII a-zA-Z) and allows to specify both, a encoded or decoded hostname.

This function does not perform any hostname lookups and supports only IPv6 addresses in "[ ... ]" notation. The "[v ... ]" square bracket format is not supported by this implementation.

Parameters:

host	The host name or IP to verify.

Exceptions:

UrlNotSupportedException	if the hostname is in the unsuported "[v ... ]" square bracket format.
UrlBadComponentException	if the hostname is invalid.

virtual void limal::url::UrlBase::checkValidPass ( const BLOCXX_NAMESPACE::String &  pass, EEncoding  eflag  ) const

protectedvirtual

virtual void limal::url::UrlBase::checkValidPathName ( const BLOCXX_NAMESPACE::String &  path, EEncoding  eflag  ) const

protectedvirtual

virtual void limal::url::UrlBase::checkValidPathParams ( const BLOCXX_NAMESPACE::String &  params, EEncoding  eflag  ) const

protectedvirtual

virtual void limal::url::UrlBase::checkValidPort ( const BLOCXX_NAMESPACE::String &  port, EEncoding  eflag  ) const

protectedvirtual

Verifies if specified port number is in the range 0..65535.

Parameters:

port	The port number to verify.

Exceptions:

UrlBadComponentException

if the port number is invalid.

virtual void limal::url::UrlBase::checkValidQueryStr ( const BLOCXX_NAMESPACE::String &  querystr, EEncoding  eflag  ) const

protectedvirtual

virtual void limal::url::UrlBase::checkValidScheme ( const BLOCXX_NAMESPACE::String &  scheme, EEncoding  eflag  ) const

protectedvirtual

virtual void limal::url::UrlBase::checkValidUser ( const BLOCXX_NAMESPACE::String &  user, EEncoding  eflag  ) const

protectedvirtual

virtual BLOCXX_NAMESPACE::String limal::url::UrlBase::cleanupPathName ( const BLOCXX_NAMESPACE::String &  path, bool  authority  ) const

protectedvirtual

Utility method to cleanup an encoded path name.

By default, this method makes sure, that the first slash in the path is not encoded, and that the second slash before the first path segment, is encoded (to "%2F"). It modifies the path in the url, for example: "ftp://host//aaa//bbb" to "ftp://host/%2Faaa//bbb" or as encoded path only also "%2f/name" to "/%2fname".

This operation is required to fulfill the path-absolute rule of RFC3986, if there is no authority. It avoids the missinterpretation of the path as an authority separator.

It is not required if there is an authority ("//" behind the "scheme:"), that is in the path-abempty rule, but it is used e.g. in ftp url's defined by RFC1738.

We apply this operation in both cases (for all paths), but if authority is true, the encoding of the second slash depends on the schema configuration (for ftp only).

Parameters:

path	The encoded path name to cleanup.
authority	Whether the url contains authority or not.

Returns:

A modified encoded path.

virtual BLOCXX_NAMESPACE::String limal::url::UrlBase::cleanupPathName ( const BLOCXX_NAMESPACE::String &  path ) const

protectedvirtual

Utility method to cleanup an encoded path name.

This variant of the method checks if the host component in the url is empty or not to differentiate if there is an authority.

Parameters:

path	The encoded path name to cleanup.

Returns:

A modified encoded path.

virtual void limal::url::UrlBase::clear ( )

virtual

Clears all data in the object.

virtual UrlBase* limal::url::UrlBase::clone ( ) const

virtual

Returns pointer to a copy of the current object.

Should be reimplemented by all derived object using the copy constructor of the derived class, e.g.:

   return new MyUrlDerivedFromUrlBase(*this);

Returns:

A pointer to a copy of the current object.

BLOCXX_NAMESPACE::String limal::url::UrlBase::config

(

const BLOCXX_NAMESPACE::String &

opt

)

const

Get the value of a UrlBase configuration variable.

See configure() method for names an purpose of the configuration variables used in UrlBase class.

Parameters:

opt	The name of the configuration variable.

Returns:

The value of the specified variable or empty string.

void limal::url::UrlBase::config	(	const BLOCXX_NAMESPACE::String &	opt,
		const BLOCXX_NAMESPACE::String &	val
	)

Set the value of a UrlBase configuration variable.

See configure() method for names an purpose of the configuration variables used in UrlBase class.

Parameters:

opt	The name of the configuration variable.
val	The new value for the configuration variable.

virtual void limal::url::UrlBase::configure ( )

virtual

Configures behaviour of the instance.

This method is called in UrlBase constructors before any URL components are applied. Derived classes may reimplement this method to change the behaviour of the object. Use the config() methods to query and change them.

The UrlBase class uses following config variables:

• Common path parameter separators:
  • sep_pathparams ";" Separator used to split path parameters from path name. Setting it to empty string disables splitting of path name and path parameters. Set also rx_pathparams to an empty string.
  • psep_pathparam "," Separator between path parameters.
  • vsep_pathparam "=" Separator between key and value of a path parameter.

• Common query string separators:
  • psep_querystr "&" Separator between query string parameters.
  • vsep_querystr "=" Separator between key and value of a query parameter.

• Characters in URL components, that are safe without URL percent-encoding (see limal::url::encode()).
  • safe_username
  • safe_password
  • safe_hostname
  • safe_pathname
  • safe_pathparams
  • safe_querystr
  • safe_fragment

• Regular expressions used to verify encoded URL components and their sub-components:
  • rx_username
  • rx_password
  • rx_pathname
  • rx_pathparams
  • rx_querystr
  • rx_fragment

virtual BLOCXX_NAMESPACE::String limal::url::UrlBase::getAuthority ( ) const

virtual

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.

virtual BLOCXX_NAMESPACE::String limal::url::UrlBase::getFragment ( EEncoding  eflag ) const

virtual

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:

UrlDecodingException

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

virtual BLOCXX_NAMESPACE::String limal::url::UrlBase::getHost ( EEncoding  eflag ) const

virtual

Returns the hostname or IP from the URL authority.

In case the Url contains an IPv6 number, it is 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:

UrlDecodingException

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

virtual BLOCXX_NAMESPACE::StringArray limal::url::UrlBase::getKnownSchemes ( ) const

virtual

Returns scheme names known by this object.

This method is used in the isValidScheme() method and is intended to be reimplemented by derived classes to return the scheme names it implements (is restricted or compatible to).

For example, if your derived class implements special features of LDAP URL's, this method may return "ldap" and "ldaps" scheme names.

The UrlBase class returns an empty array, that signals that it is useable with all URL's.

Returns:

An array with scheme names known by this object.

virtual BLOCXX_NAMESPACE::String limal::url::UrlBase::getPassword ( EEncoding  eflag ) const

virtual

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:

UrlDecodingException

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

virtual BLOCXX_NAMESPACE::String limal::url::UrlBase::getPathData ( ) const

virtual

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.

virtual BLOCXX_NAMESPACE::String limal::url::UrlBase::getPathName ( EEncoding  eflag ) const

virtual

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:

UrlDecodingException

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

virtual BLOCXX_NAMESPACE::String limal::url::UrlBase::getPathParam ( const BLOCXX_NAMESPACE::String &  param, EEncoding  eflag  ) const

virtual

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:

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

virtual BLOCXX_NAMESPACE::String limal::url::UrlBase::getPathParams ( ) const

virtual

Returns the encoded path parameters from the URL.

Returns:

The encoded path parameters from the URL.

virtual BLOCXX_NAMESPACE::StringArray limal::url::UrlBase::getPathParamsArray ( ) const

virtual

Returns an array with encoded 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 an array containing the substrings "foo=1" and "bar=2".

Returns:

The encoded path parameters array.

virtual limal::url::ParamMap limal::url::UrlBase::getPathParamsMap ( EEncoding  eflag ) const

virtual

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:

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

virtual BLOCXX_NAMESPACE::String limal::url::UrlBase::getPort ( ) const

virtual

Returns the port number from the URL authority.

Returns:

The port sub-component from the URL authority.

virtual BLOCXX_NAMESPACE::String limal::url::UrlBase::getQueryParam ( const BLOCXX_NAMESPACE::String &  param, EEncoding  eflag  ) const

virtual

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:

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

virtual BLOCXX_NAMESPACE::String limal::url::UrlBase::getQueryString ( ) const

virtual

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 URL's remains in the returned string.

Returns:

The encoded query string component of the URL.

virtual BLOCXX_NAMESPACE::StringArray limal::url::UrlBase::getQueryStringArray ( ) const

virtual

Returns an array 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 an array containing the substrings "foo=1" and "bar=2".

Returns:

The query string splited into an array of substrings.

virtual limal::url::ParamMap limal::url::UrlBase::getQueryStringMap ( EEncoding  eflag ) const

virtual

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:

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

virtual BLOCXX_NAMESPACE::String limal::url::UrlBase::getScheme ( ) const

virtual

Returns the scheme name of the URL.

Returns:

Scheme name of the current Url object.

virtual BLOCXX_NAMESPACE::String limal::url::UrlBase::getUsername ( EEncoding  eflag ) const

virtual

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:

UrlDecodingException

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

ViewOptions limal::url::UrlBase::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.

virtual void limal::url::UrlBase::init ( const UrlComponents &  components )

virtual

Initializes current object with new URL components.

Parameters:

components

The url main component string to use.

Exceptions:

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

virtual bool limal::url::UrlBase::isKnownScheme ( const BLOCXX_NAMESPACE::String &  scheme ) const

virtual

Returns if scheme name is known to this object.

Returns:

True, if scheme name is known to this object.

virtual bool limal::url::UrlBase::isValid ( ) const

virtual

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.

virtual bool limal::url::UrlBase::isValidScheme ( const BLOCXX_NAMESPACE::String &  scheme ) const

virtual

Verifies 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 (as in the UrlBase class).

Parameters:

scheme

The scheme name to verify.

Returns:

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

UrlBase& limal::url::UrlBase::operator=

(

const UrlBase &

url

)

Assign shared copy of url to the current object.

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

Parameters:

url	The UrlBase object to make a copy of.

Returns:

A reference to this object.

UrlBase& limal::url::UrlBase::operator=

(

const BLOCXX_NAMESPACE::String &

urlString

)

Assigns parsed percent-encoded URL string to the object.

In case of a parse failure, the object will remain unchanged.

Parameters:

urlString

A percent-encoded URL string.

Returns:

A reference to this object.

Exceptions:

url::UrlParsingException	if parsing of the url fails.
url::UrlNotAllowedException	if one of the components is not allowed for the scheme.
url::UrlNotSupportedException	if the format of one of the components is not supported (e.g. IPvFeature host).
url::UrlBadComponentException	if one of the components contains an invalid character.

virtual void limal::url::UrlBase::setAuthority ( const BLOCXX_NAMESPACE::String &  authority )

virtual

Set the authority component in the URL.

The authority string shoud not contain any leading "//" separator characters (just "user:pass@host:port").

Parameters:

authority

The authority component string.

Exceptions:

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

virtual void limal::url::UrlBase::setFragment ( const BLOCXX_NAMESPACE::String &  fragment, EEncoding  eflag  )

virtual

Set the fragment string in the URL.

Parameters:

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

Exceptions:

UrlBadComponentException

if the querystr contains an invalid character.

virtual void limal::url::UrlBase::setHost ( const BLOCXX_NAMESPACE::String &  host, EEncoding  eflag  )

virtual

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 registered hostname (dns hostname) may contain national alphanumeric UTF8 characters (letters other than ASCII a-zA-Z), that has to be percent-encoded.

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.
eflag	If the registered hostname is encoded or not.

Exceptions:

UrlNotAllowedException	if the host has to be empty in for the current scheme.
UrlBadComponentException	if the host is invalid.

virtual void limal::url::UrlBase::setPassword ( const BLOCXX_NAMESPACE::String &  pass, EEncoding  eflag  )

virtual

Set the password in the URL authority.

Parameters:

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

Exceptions:

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

virtual void limal::url::UrlBase::setPathData ( const BLOCXX_NAMESPACE::String &  pathdata )

virtual

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:

UrlBadComponentException

if the pathdata contains an invalid character.

virtual void limal::url::UrlBase::setPathName ( const BLOCXX_NAMESPACE::String &  path, EEncoding  eflag  )

virtual

Set the path name.

Parameters:

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

Exceptions:

UrlBadComponentException

if the path name contains an invalid character.

virtual void limal::url::UrlBase::setPathParam ( const BLOCXX_NAMESPACE::String &  param, const BLOCXX_NAMESPACE::String &  value  )

virtual

Set or add value for the specified path parameter.

Parameters:

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

Exceptions:

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

virtual void limal::url::UrlBase::setPathParams ( const BLOCXX_NAMESPACE::String &  params )

virtual

Set the path parameters.

Parameters:

params

The new encoded path parameter string.

Exceptions:

UrlBadComponentException

if the path params contains an invalid character.

virtual void limal::url::UrlBase::setPathParamsArray ( const BLOCXX_NAMESPACE::StringArray &  parray )

virtual

Set the path parameters.

Parameters:

parray

The array with encoded path parameters.

Exceptions:

UrlBadComponentException

if the parray contains an invalid character.

virtual void limal::url::UrlBase::setPathParamsMap ( const limal::url::ParamMap &  pmap )

virtual

Set the path parameters.

Parameters:

pmap	The map with decoded path parameters.

Exceptions:

UrlNotSupportedException

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

virtual void limal::url::UrlBase::setPort ( const BLOCXX_NAMESPACE::String &  port )

virtual

Set the port number in the URL authority.

Parameters:

port	The new port number.

Exceptions:

UrlNotAllowedException	if the port has to be empty in for the current scheme.
UrlBadComponentException	if the port is invalid.

virtual void limal::url::UrlBase::setQueryParam ( const BLOCXX_NAMESPACE::String &  param, const BLOCXX_NAMESPACE::String &  value  )

virtual

Set or add value for the specified query parameter.

Parameters:

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

Exceptions:

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

virtual void limal::url::UrlBase::setQueryString ( const BLOCXX_NAMESPACE::String &  querystr )

virtual

Set the query string in the URL.

The querystr string parameter is supposed to not to contain the "?" URL query separator character (use just a "foo=bar&x=22" instead of "?foo=bar&x=22").

Parameters:

querystr

The new encoded query string.

Exceptions:

UrlBadComponentException

if the querystr contains an invalid character.

virtual void limal::url::UrlBase::setQueryStringArray ( const BLOCXX_NAMESPACE::StringArray &  qarray )

virtual

Set the query parameters.

Parameters:

qarray

The array with encoded query parameters.

Exceptions:

UrlBadComponentException

if the qarray contains an invalid character.

virtual void limal::url::UrlBase::setQueryStringMap ( const limal::url::ParamMap &  qmap )

virtual

Set the query parameters.

Parameters:

qmap	The map with decoded query parameters.

Exceptions:

UrlNotSupportedException

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

virtual void limal::url::UrlBase::setScheme ( const BLOCXX_NAMESPACE::String &  scheme )

virtual

Set the scheme name in the URL.

Parameters:

scheme

The new scheme name.

Exceptions:

UrlBadComponentException

if the scheme contains an invalid character or is empty.

virtual void limal::url::UrlBase::setUsername ( const BLOCXX_NAMESPACE::String &  user, EEncoding  eflag  )

virtual

Set the username in the URL authority.

Parameters:

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

Exceptions:

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

void limal::url::UrlBase::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.

virtual BLOCXX_NAMESPACE::String limal::url::UrlBase::toString ( ) const

virtual

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.

virtual BLOCXX_NAMESPACE::String limal::url::UrlBase::toString ( const limal::url::ViewOptions &  opts ) const

virtual

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);

Parameters:

opts	A combination of view options.

Returns:

A string representation of the Url object.

---

Member Data Documentation

BLOCXX_NAMESPACE::COWReference<UrlBaseData> limal::url::UrlBase::m_data

private

---

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

• UrlBase.hpp