AeroGear.Mobile.Auth.Authenticator.AbstractAuthenticator Class Reference

Abstract base class for authenticators. More...

Inheritance diagram for AeroGear.Mobile.Auth.Authenticator.AbstractAuthenticator:

Public Member Functions
	AbstractAuthenticator (AuthenticationConfig authenticationConfig, KeycloakConfig keycloakConfig, ICredentialManager credentialManager, IHttpServiceModule httpServiceModule, ILogger logger)
	Initializes a new instance of the T:AeroGear.Mobile.Auth.Authenticator.AbstractAuthenticator class. More...
async Task< bool >	Logout (User currentUser)
	Logout the specified currentUser. More...
abstract Task< User >	Authenticate (IAuthenticateOptions authenticateOptions)
	Perform the authentication request More...

Protected Attributes
readonly AuthenticationConfig	authenticationConfig
readonly KeycloakConfig	keycloakConfig
readonly ICredentialManager	credentialManager
readonly IHttpServiceModule	httpService
readonly ILogger	logger

Detailed Description

Abstract base class for authenticators.

Constructor & Destructor Documentation

AbstractAuthenticator()

AeroGear.Mobile.Auth.Authenticator.AbstractAuthenticator.AbstractAuthenticator	(	AuthenticationConfig	authenticationConfig,
		KeycloakConfig	keycloakConfig,
		ICredentialManager	credentialManager,
		IHttpServiceModule	httpServiceModule,
		ILogger	logger
	)

Initializes a new instance of the T:AeroGear.Mobile.Auth.Authenticator.AbstractAuthenticator class.

Parameters

authenticationConfig	Authentication config.
keycloakConfig	Keycloak config.
credentialManager	Credential manager.
httpServiceModule	Http service module.
logger	Logger.

Member Function Documentation

Authenticate()

abstract Task<User> AeroGear.Mobile.Auth.Authenticator.AbstractAuthenticator.Authenticate ( IAuthenticateOptions  authenticateOptions )

pure virtual

Perform the authentication request

Returns

The authenticated user

Parameters

authenticateOptions

Authenticate options. See IAuthenticateOptions

Implements AeroGear.Mobile.Auth.Authenticator.IAuthenticator.

Logout()

async Task<bool> AeroGear.Mobile.Auth.Authenticator.AbstractAuthenticator.Logout

(

User

currentUser

)

Logout the specified currentUser.

Returns

The logout result.

Parameters

currentUser

User to be logged out.

Implements AeroGear.Mobile.Auth.Authenticator.IAuthenticator.

Member Data Documentation

authenticationConfig

readonly AuthenticationConfig AeroGear.Mobile.Auth.Authenticator.AbstractAuthenticator.authenticationConfig

protected

credentialManager

readonly ICredentialManager AeroGear.Mobile.Auth.Authenticator.AbstractAuthenticator.credentialManager

protected

httpService

readonly IHttpServiceModule AeroGear.Mobile.Auth.Authenticator.AbstractAuthenticator.httpService

protected

keycloakConfig

readonly KeycloakConfig AeroGear.Mobile.Auth.Authenticator.AbstractAuthenticator.keycloakConfig

protected

logger

readonly ILogger AeroGear.Mobile.Auth.Authenticator.AbstractAuthenticator.logger

protected

---

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

• Auth/Auth/Authenticator/AbstractAuthenticator.cs