pulsar::Authentication Class Reference

Inheritance diagram for pulsar::Authentication:

Public Member Functions
virtual const std::string	getAuthMethodName () const =0
virtual Result	getAuthData (AuthenticationDataPtr &authDataContent)

Static Public Member Functions
static ParamMap	parseDefaultFormatAuthParams (const std::string &authParamsString)

Protected Attributes
AuthenticationDataPtr	authData_

Friends
class	ClientConfiguration

Member Function Documentation

getAuthData()

virtual Result pulsar::Authentication::getAuthData ( AuthenticationDataPtr &  authDataContent )

inlinevirtual

Get AuthenticationData from the current instance

Parameters

[out]

authDataContent

the shared pointer of AuthenticationData. The content of AuthenticationData is changed to the internal data of the current instance.

Returns

ResultOk or ResultAuthenticationError if authentication failed

Reimplemented in pulsar::AuthAthenz, pulsar::AuthBasic, pulsar::AuthOauth2, pulsar::AuthTls, and pulsar::AuthToken.

getAuthMethodName()

virtual const std::string pulsar::Authentication::getAuthMethodName ( ) const

pure virtual

Returns

the authentication method name supported by this provider

Implemented in pulsar::AuthTls, pulsar::AuthToken, pulsar::AuthAthenz, pulsar::AuthOauth2, and pulsar::AuthBasic.

parseDefaultFormatAuthParams()

static ParamMap pulsar::Authentication::parseDefaultFormatAuthParams ( const std::string &  authParamsString )

static

Parse the authentication parameter string to a map whose key and value are both strings

The parameter string can have multiple lines. The format of each line is a comma-separated “key:value” string.

For example, “k1:v1,k2:v2” is parsed to two key-value pairs (k1, v1) and (k2, v2).

Parameters

authParamsString

the authentication parameter string to be parsed

Returns

the parsed map whose key and value are both strings

---

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

• include/pulsar/Authentication.h