ICredentialFactory Class Reference

A factory class used to create credentials objects. Each instance should only be used once to produce one set of credentials. The lifetime of the credential factory ends after successfully returning credentials or an error has been thrown. More...

List of all members.

Public Member Functions

virtual AutoPtr< ICredentialsGetAuthenticatedCredentials (AutoArrayPtr< simba_byte > in_inputToken, AutoArrayPtr< simba_byte > &out_outputToken)=0
 Processes security tokens received from a client in order to produce authenticated credentials for a remote client. This function typically must be called multiple times while exchanging tokens with a client until credentials are fully established.
virtual AutoPtr< ICredentialsGetLocalCredentials ()=0
 Gets a local credentials object for the current user. Cannot be used in combination with GetAuthenticatedCredentials.
virtual ~ICredentialFactory ()
 Destructor.

Protected Member Functions

 ICredentialFactory ()
 Constructor.

Detailed Description

A factory class used to create credentials objects. Each instance should only be used once to produce one set of credentials. The lifetime of the credential factory ends after successfully returning credentials or an error has been thrown.


Constructor & Destructor Documentation

virtual ~ICredentialFactory (  )  [inline, virtual]

Destructor.

ICredentialFactory (  )  [inline, protected]

Constructor.


Member Function Documentation

virtual AutoPtr<ICredentials> GetAuthenticatedCredentials ( AutoArrayPtr< simba_byte in_inputToken,
AutoArrayPtr< simba_byte > &  out_outputToken 
) [pure virtual]

Processes security tokens received from a client in order to produce authenticated credentials for a remote client. This function typically must be called multiple times while exchanging tokens with a client until credentials are fully established.

This method may return in one of three ways. 1. NULL return value with out_outputToken set - The authentication is to be continued by sending the token to the client and waiting for a response to call this function again. 2. ICredentials returned with out_outputToken set - The authentication is successfully completed on this end and there is one remaining token to send to the client. No response token is expected from the client. 3. ICredentials returned with NULL out_outputToken - The authentication is successfully completed and there are no additional tokens to send or receive.

Parameters:
in_inputToken A token received from a client.
out_outputToken Response token to send to the client to continue authentication.
Returns:
An ICredentials that represents the remote user that has been authenticated.(OWN)
virtual AutoPtr<ICredentials> GetLocalCredentials (  )  [pure virtual]

Gets a local credentials object for the current user. Cannot be used in combination with GetAuthenticatedCredentials.

Returns:
An ICredentials that represents the default credentials for the local user.(OWN)

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

Generated on Wed May 17 14:21:19 2017 for SimbaEngine 10.1.3.1011 by simba