pulsar-client-cpp
Loading...
Searching...
No Matches
Public Member Functions | List of all members
pulsar::CryptoKeyReader Class Referenceabstract

#include <CryptoKeyReader.h>

Inheritance diagram for pulsar::CryptoKeyReader:
pulsar::DefaultCryptoKeyReader

Public Member Functions

virtual Result getPublicKey (const std::string &keyName, std::map< std::string, std::string > &metadata, EncryptionKeyInfo &encKeyInfo) const =0
 
virtual Result getPrivateKey (const std::string &keyName, std::map< std::string, std::string > &metadata, EncryptionKeyInfo &encKeyInfo) const =0
 

Detailed Description

The abstract class that abstracts the access to a key store

Member Function Documentation

◆ getPrivateKey()

virtual Result pulsar::CryptoKeyReader::getPrivateKey ( const std::string &  keyName,
std::map< std::string, std::string > &  metadata,
EncryptionKeyInfo encKeyInfo 
) const
pure virtual
Parameters
keyNameUnique name to identify the key
metadataAdditional information needed to identify the key
encKeyInfoupdated with details about the private key
Returns
Result ResultOk is returned for success

Implemented in pulsar::DefaultCryptoKeyReader.

◆ getPublicKey()

virtual Result pulsar::CryptoKeyReader::getPublicKey ( const std::string &  keyName,
std::map< std::string, std::string > &  metadata,
EncryptionKeyInfo encKeyInfo 
) const
pure virtual

Return the encryption key corresponding to the key name in the argument

This method should be implemented to return the EncryptionKeyInfo. This method will be called at the time of producer creation as well as consumer receiving messages. Hence, application should not make any blocking calls within the implementation.

Parameters
keyNameUnique name to identify the key
metadataAdditional information needed to identify the key
encKeyInfoupdated with details about the public key
Returns
Result ResultOk is returned for success

Implemented in pulsar::DefaultCryptoKeyReader.


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