gemfire::AuthInitialize Class Reference

Inherits gemfire::SharedBase.


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.

Public Member Functions

virtual void close ()=0
 Invoked before the cache goes down.
virtual PropertiesPtr getCredentials (PropertiesPtr &securityprops, const char *server)=0
 initialize with the given set of security properties and return the credentials for the client as properties.
void preserveSB () const
 Atomically increment reference count.
int32_t refCount ()
 
Returns:
the reference count

void releaseSB () const
 Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.


Member Function Documentation

virtual void gemfire::AuthInitialize::close (  )  [pure virtual]

Invoked before the cache goes down.

virtual PropertiesPtr gemfire::AuthInitialize::getCredentials ( PropertiesPtr securityprops,
const char *  server 
) [pure virtual]

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

Parameters:
props the set of security properties provided to the DistributedSystem.connect method
server it 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.

void gemfire::SharedBase::preserveSB (  )  const [inherited]

Atomically increment reference count.

int32_t gemfire::SharedBase::refCount (  )  [inline, inherited]

Returns:
the reference count

void gemfire::SharedBase::releaseSB (  )  const [inherited]

Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.


GemFire C++ Cache API Documentation