sword::URL Class Reference

URL provides URL parsing The URL class provides an interface to work on the data of an URL like "http://www.crosswire.org/index.jsp?page=test&user=nobody". More...

#include <url.h>

Collaboration diagram for sword::URL:

[legend]List of all members.


Public Types
typedef std::map< SWBuf, SWBuf >	ParameterMap
Public Member Functions
	URL (const char *url)
	Constructor.
const char *	getProtocol () const
	Get the protocol.
const char *	getHostName () const
	Get the hostname.
const char *	getPath () const
	Get the path.
const ParameterMap &	getParameters () const
	All available paramters.
const char *	getParameterValue (const char *name) const
	Returns the value of an URL parameter.
Static Public Member Functions
static const SWBuf	encode (const char *urlText)
	Encodes and URL Encodes a string into a valid URL, e.g.
static const SWBuf	decode (const char *encodedText)
Private Member Functions
void	parse ()
	Parse Parse the URL into protocol, hostname, path, page and paramters.
Private Attributes
SWBuf	url
SWBuf	protocol
SWBuf	hostname
SWBuf	path
ParameterMap	parameterMap

Detailed Description

URL provides URL parsing The URL class provides an interface to work on the data of an URL like "http://www.crosswire.org/index.jsp?page=test&user=nobody".

Definition at line 33 of file url.h.

Constructor & Destructor Documentation

sword::URL::URL ( const char * url )

Constructor.

Parameters:

url

The url string which should be parsed into protocol, hostname, path and paramters

Member Function Documentation

const char* sword::URL::getProtocol ( ) const

Get the protocol.

Returns:: The protocol, e.g. "http" for an url like "http://www.crosswire.org/index.jsp?page=help"

const char* sword::URL::getHostName ( ) const

Get the hostname.

Returns:: The hostname, e.g. "www.crosswire.org" for an url like "http://www.crosswire.org/index.jsp?page=help"

const char* sword::URL::getPath ( ) const

Get the path.

Returns:: The path, e.g. "/index.jsp" for an url like "http://www.crosswire.org/index.jsp?page=help"

const ParameterMap& sword::URL::getParameters ( ) const

All available paramters.

Returns:: The map which contains the parameters and their values

const char* sword::URL::getParameterValue ( const char * name ) const

Returns the value of an URL parameter.

For the URL "http://www.crosswire.org/index.jsp?page=test&user=nobody" the value of the parameter "page" would be "test". If the parameter is not set an empty string is returned.

Parameters:

name

The name of the paramter.