Represents the scope of an authentication request. More...

#include <luciad/loaders/ICredentialsProvider.h>

Public Member Functions
	AuthenticationScope (std::string host, int32_t port, std::string realm, std::string scheme, AuthenticationType type)
	Constructor for the scope of an authentication request. More...

AuthenticationType	getAuthenticationType () const
	Returns the authentication type, i.e., if it is needed for a server or a proxy. More...

const std::string &	getHost () const
	Returns the host name of the site or proxy for which authentication is requested. More...

int32_t	getPort () const
	Returns the port number of the connection. More...

const std::string &	getRealm () const
	Returns the realm of the authentication. More...

const std::string &	getScheme () const
	Returns the scheme of the authentication request. More...

bool	operator!= (const AuthenticationScope &other) const

bool	operator== (const AuthenticationScope &other) const

Detailed Description

Represents the scope of an authentication request.

Since: 2022.0

Constructor & Destructor Documentation

◆ AuthenticationScope()

luciad::AuthenticationScope::AuthenticationScope	(	std::string	host,
		int32_t	port,
		std::string	realm,
		std::string	scheme,
		AuthenticationType	type
	)

Constructor for the scope of an authentication request.

Parameters

host	the host name of the site or proxy.
port	the port number of the connection.
realm	the real of the authentication request.
scheme	the scheme of the authentication request.
type	whether the scope is a server or a proxy.

Member Function Documentation

◆ getAuthenticationType()

AuthenticationType luciad::AuthenticationScope::getAuthenticationType ( ) const

Returns the authentication type, i.e., if it is needed for a server or a proxy.

Returns: the authentication type, i.e., if it is needed for a server or a proxy.

◆ getHost()

const std::string & luciad::AuthenticationScope::getHost ( ) const

Returns the host name of the site or proxy for which authentication is requested.

Returns: the host name of the site or proxy for which authentication is requested.

◆ getPort()

int32_t luciad::AuthenticationScope::getPort ( ) const

Returns the port number of the connection.

If defined, it is a strict positive integer.

Returns: the port number of the connection.

◆ getRealm()

const std::string & luciad::AuthenticationScope::getRealm ( ) const

Returns the realm of the authentication.

Returns: the realm of the authentication.

◆ getScheme()

const std::string & luciad::AuthenticationScope::getScheme ( ) const

Returns the scheme of the authentication request.

This is one of Basic, Digest, ...

Returns: the scheme of the authentication request.

◆ operator!=()

bool luciad::AuthenticationScope::operator!= ( const AuthenticationScope & other ) const

◆ operator==()

bool luciad::AuthenticationScope::operator== ( const AuthenticationScope & other ) const

Public Member Functions