pulsar::AuthAthenz Class Reference

#include <Authentication.h>

Inheritance diagram for pulsar::AuthAthenz:

Public Member Functions
	AuthAthenz (AuthenticationDataPtr &)
const std::string	getAuthMethodName () const
Result	getAuthData (AuthenticationDataPtr &authDataAthenz)

Static Public Member Functions
static AuthenticationPtr	create (ParamMap &params)
static AuthenticationPtr	create (const std::string &authParamsString)
Static Public Member Functions inherited from pulsar::Authentication
static ParamMap	parseDefaultFormatAuthParams (const std::string &authParamsString)

Additional Inherited Members
Protected Attributes inherited from pulsar::Authentication
AuthenticationDataPtr	authData_

Detailed Description

Athenz implementation of Pulsar client authentication

Member Function Documentation

create() [1/2]

static AuthenticationPtr pulsar::AuthAthenz::create ( const std::string &  authParamsString )

static

Create an AuthAthenz with an authentication parameter string

See also

Authentication::parseDefaultFormatAuthParams

create() [2/2]

static AuthenticationPtr pulsar::AuthAthenz::create ( ParamMap &  params )

static

Create an AuthAthenz with a ParamMap

The required parameter keys are “tenantDomain”, “tenantService”, “providerDomain”, “privateKey”, and “ztsUrl”

Parameters

params

the key-value to construct ZTS client

See also

http://pulsar.apache.org/docs/en/security-athenz/

getAuthData()

Result pulsar::AuthAthenz::getAuthData ( AuthenticationDataPtr &  authDataAthenz )

virtual

Get AuthenticationData from the current instance

Parameters

[out]

authDataAthenz

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

Returns

ResultOk

Reimplemented from pulsar::Authentication.

getAuthMethodName()

const std::string pulsar::AuthAthenz::getAuthMethodName ( ) const

virtual

Returns

“athenz”

Implements pulsar::Authentication.

---

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

• include/pulsar/Authentication.h