org.aerogear.mobile.auth.authenticator

Class AbstractAuthenticator

java.lang.Object

org.aerogear.mobile.auth.authenticator.AbstractAuthenticator

Direct Known Subclasses:

OIDCAuthenticatorImpl

public abstract class AbstractAuthenticator
extends java.lang.Object

Base class for all authenticators

Constructor Summary

Constructors

Constructor and Description
AbstractAuthenticator(org.aerogear.mobile.core.configuration.ServiceConfiguration serviceConfig)

Method Summary

Modifier and Type	Method and Description
abstract void	authenticate(AuthenticateOptions authOptions, Callback<UserPrincipal> callback) This method must be overridden with the custom authentication for the given credential.
protected org.aerogear.mobile.core.configuration.ServiceConfiguration	getServiceConfig() Returns the authentication singleThreadService configuration
abstract void	logout(UserPrincipal principal, Callback<UserPrincipal> callback) Logout the given principal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAuthenticator

public AbstractAuthenticator(@NonNull
                             org.aerogear.mobile.core.configuration.ServiceConfiguration serviceConfig)

Method Detail

authenticate

public abstract void authenticate(AuthenticateOptions authOptions,
                                  Callback<UserPrincipal> callback)

This method must be overridden with the custom authentication for the given credential.

Parameters:

authOptions - the options for the authenticate action

callback - the callback function to be invoked

logout

public abstract void logout(UserPrincipal principal,
                            Callback<UserPrincipal> callback)

Logout the given principal

Parameters:

principal - principal to be log out

callback - the callback function to be invoked

getServiceConfig

protected org.aerogear.mobile.core.configuration.ServiceConfiguration getServiceConfig()

Returns the authentication singleThreadService configuration

Returns:

the authentication singleThreadService configuration