pulsar-client-cpp
Public Member Functions | Static Public Member Functions | List of all members
pulsar::AuthTls Class Reference

#include <Authentication.h>

Inheritance diagram for pulsar::AuthTls:
pulsar::Authentication

Public Member Functions

 AuthTls (AuthenticationDataPtr &)
 
const std::string getAuthMethodName () const
 
Result getAuthData (AuthenticationDataPtr &authDataTls)
 

Static Public Member Functions

static AuthenticationPtr create (ParamMap &params)
 
static AuthenticationPtr create (const std::string &authParamsString)
 
static AuthenticationPtr create (const std::string &certificatePath, const std::string &privateKeyPath)
 
- 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

TLS implementation of Pulsar client authentication

Member Function Documentation

◆ create() [1/3]

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

Create an AuthTls with an authentication parameter string

See also
Authentication::parseDefaultFormatAuthParams

◆ create() [2/3]

static AuthenticationPtr pulsar::AuthTls::create ( const std::string &  certificatePath,
const std::string &  privateKeyPath 
)
static

Create an AuthTls with the required parameters

Parameters
certificatePaththe file path for a client certificate
privateKeyPaththe file path for a client private key

◆ create() [3/3]

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

Create an AuthTls with a ParamMap

It is equal to create(params[“tlsCertFile”], params[“tlsKeyFile”])

See also
create(const std::string&, const std::string&)

◆ getAuthData()

Result pulsar::AuthTls::getAuthData ( AuthenticationDataPtr &  authDataTls)
virtual

Get AuthenticationData from the current instance

Parameters
[out]authDataTlsthe 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::AuthTls::getAuthMethodName ( ) const
virtual
Returns
“tls”

Implements pulsar::Authentication.


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