Apache Geode Native C++ Reference  1.14.0
apache::geode::client::AuthInitialize Class Referenceabstract

Specifies the mechanism to obtain credentials for a client. More...

Public Member Functions

virtual void close ()=0
 Invoked before the cache goes down. More...
 
virtual std::shared_ptr< PropertiesgetCredentials (const std::shared_ptr< Properties > &securityprops, const std::string &server)=0
 initialize with the given set of security properties and return the credentials for the client as properties. More...
 

Detailed Description

Specifies the mechanism to obtain credentials for a client.

It is mandantory for clients when the server is running in secure mode having a security-client-authenticator module specified. Implementations should register the library path as security-client-auth-library system property and factory function (a zero argument function returning pointer to an AuthInitialize object) as the security-client-auth-factory system property.

Member Function Documentation

◆ close()

virtual void apache::geode::client::AuthInitialize::close ( )
pure virtual

Invoked before the cache goes down.

◆ getCredentials()

virtual std::shared_ptr<Properties> apache::geode::client::AuthInitialize::getCredentials ( const std::shared_ptr< Properties > &  securityprops,
const std::string &  server 
)
pure virtual

initialize with the given set of security properties and return the credentials for the client as properties.

Parameters
securitypropsthe set of security properties provided to the DistributedSystem.connect method
serverit is the ID of the current endpoint. The format expected is "host:port".
Returns
the credentials to be used for the given server
Remarks
This method can modify the given set of properties. For example it may invoke external agents or even interact with the user.

Apache Geode C++ Cache API Documentation