te::core::ProxyInfo Class Reference

#include <ProxyInfo.h>

Public Member Functions
std::string	getAuthentication () const
	Gets the proxy settings authentication component (user:password). More...
const std::string &	getHost () const
	Gets Proxy Host information. More...
std::string	getHostPort () const
	Gets the proxy settings host component (host:port). More...
const std::string &	getPassword () const
	Gets Proxy Password information. More...
int	getPort () const
	Gets Proxy Port information. More...
const std::string &	getUserName () const
	Gets Proxy UserName information. More...
bool	isAuthenticated () const
	Checks if the proxy settings has authentication information sets (userName and password). More...
bool	isEnabled () const
	Checks if the use of the proxy settings is enabled and must be used in requests. More...
	ProxyInfo ()
	Default constructor. More...
void	setEnabled (bool enabled)
	Sets Enabled or Disabled the use of the proxy settings. More...
void	setHost (const std::string &host)
	Sets Proxy Host information. More...
void	setPassword (const std::string &password)
	Sets Proxy Password information. More...
void	setPort (int port)
	Sets Proxy Port information. More...
void	setUserName (const std::string &userName)
	Sets Proxy User Name information. More...
std::string	toString () const
	Gets the proxy settings as a string. More...

Protected Attributes
std::string	m_host
	Stores information related to the proxy host. More...
bool	m_isEnabled
	Stores information related to the enabling of the use of these proxy settings. More...
std::string	m_password
	Stores information related to the proxy password. More...
int	m_port
	Stores information related to the proxy port. More...
std::string	m_userName
	Stores information related to the proxy user. More...

Detailed Description

Definition at line 47 of file ProxyInfo.h.

Constructor & Destructor Documentation

ProxyInfo()

te::core::ProxyInfo::ProxyInfo

(

)

Default constructor.

Member Function Documentation

getAuthentication()

std::string te::core::ProxyInfo::getAuthentication

(

)

const

Gets the proxy settings authentication component (user:password).

getHost()

const std::string& te::core::ProxyInfo::getHost

(

)

const

Gets Proxy Host information.

Returns

The Proxy Host information

getHostPort()

std::string te::core::ProxyInfo::getHostPort

(

)

const

Gets the proxy settings host component (host:port).

getPassword()

const std::string& te::core::ProxyInfo::getPassword

(

)

const

Gets Proxy Password information.

Returns

The Proxy Password information

getPort()

int te::core::ProxyInfo::getPort

(

)

const

Gets Proxy Port information.

Returns

The Proxy Port information

getUserName()

const std::string& te::core::ProxyInfo::getUserName

(

)

const

Gets Proxy UserName information.

Returns

The Proxy UserName information

isAuthenticated()

bool te::core::ProxyInfo::isAuthenticated

(

)

const

Checks if the proxy settings has authentication information sets (userName and password).

isEnabled()

bool te::core::ProxyInfo::isEnabled

(

)

const

Checks if the use of the proxy settings is enabled and must be used in requests.

Returns

TRUE if the of the proxy settings is enabled; FALSE otherwise

setEnabled()

void te::core::ProxyInfo::setEnabled

(

bool

enabled

)

Sets Enabled or Disabled the use of the proxy settings.

Parameters

enabled

The new state of the use of the proxy settings.

setHost()

void te::core::ProxyInfo::setHost

(

const std::string &

host

)

Sets Proxy Host information.

Parameters

host	The Proxy Host information

setPassword()

void te::core::ProxyInfo::setPassword

(

const std::string &

password

)

Sets Proxy Password information.

Parameters

password

The Proxy Password information

setPort()

void te::core::ProxyInfo::setPort

(

int

port

)

Sets Proxy Port information.

Parameters

port	The Proxy Port information

setUserName()

void te::core::ProxyInfo::setUserName

(

const std::string &

userName

)

Sets Proxy User Name information.

Parameters

userName

The Proxy User Name information

toString()

std::string te::core::ProxyInfo::toString

(

)

const

Gets the proxy settings as a string.

Returns

The proxy settings as a string.

Member Data Documentation

m_host

std::string te::core::ProxyInfo::m_host

protected

Stores information related to the proxy host.

Definition at line 120 of file ProxyInfo.h.

m_isEnabled

bool te::core::ProxyInfo::m_isEnabled

protected

Stores information related to the enabling of the use of these proxy settings.

Definition at line 124 of file ProxyInfo.h.

m_password

std::string te::core::ProxyInfo::m_password

protected

Stores information related to the proxy password.

Definition at line 123 of file ProxyInfo.h.

m_port

int te::core::ProxyInfo::m_port

protected

Stores information related to the proxy port.

Definition at line 121 of file ProxyInfo.h.

m_userName

std::string te::core::ProxyInfo::m_userName

protected

Stores information related to the proxy user.

Definition at line 122 of file ProxyInfo.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/core/uri/ProxyInfo.h