Apache::Geode::Client::IAuthInitialize Interface Reference

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

#include <IAuthInitialize.hpp>

Public Member Functions
void	Close ()
	Invoked before the cache goes down. More...
Properties< String^, Object^> ^	GetCredentials (Properties< String^, String^>^ props, String^ server)
	Initialize with the given set of security properties 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.

For a managed class implementing IAuthInitialize the fully qualified name of the factory function should be provided in the form {Namespace}.{Class Name}.{Method Name} as the security-client-auth-factory property.

Member Function Documentation

Close()

void Apache::Geode::Client::IAuthInitialize::Close

(

)

Invoked before the cache goes down.

GetCredentials()

Properties< String^, Object^> ^ Apache::Geode::Client::IAuthInitialize::GetCredentials	(	Properties< String^, String^>^	props,
		String^	server
	)

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

Parameters

props	the set of security-* properties provided to the DistributedSystem.connect method
server	the ID of the current endpoint in the format "host:port"

Returns

the credentials to be used for the given server

This method can modify the given set of properties. For example it may invoke external agents or even interact with the user.