Skip navigation links
A B C D E F G H I J K L N O P R S T U V W 

A

AbstractAuthenticator - Class in org.aerogear.mobile.auth.authenticator
Base class for all authenticators
AbstractAuthenticator(ServiceConfiguration) - Constructor for class org.aerogear.mobile.auth.authenticator.AbstractAuthenticator
 
accessToken - Variable in class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 
APPLICATION_ID - Static variable in class org.aerogear.android.auth.BuildConfig
 
AuthConfigurationBuilder() - Constructor for class org.aerogear.mobile.auth.configuration.AuthServiceConfiguration.AuthConfigurationBuilder
 
authenticate(AuthenticateOptions, Callback<UserPrincipal>) - Method in class org.aerogear.mobile.auth.authenticator.AbstractAuthenticator
This method must be overridden with the custom authentication for the given credential.
authenticate(AuthenticateOptions, Callback<UserPrincipal>) - Method in class org.aerogear.mobile.auth.authenticator.oidc.OIDCAuthenticatorImpl
Builds a new OIDCUserPrincipalImpl object after the user's credential has been authenticated
AuthenticateOptions - Interface in org.aerogear.mobile.auth.authenticator
Represents options for an authentication action.
AuthenticationException - Exception in org.aerogear.mobile.auth
Exception thrown when an error occurs authenticating a user.
AuthenticationException(Throwable) - Constructor for exception org.aerogear.mobile.auth.AuthenticationException
 
AuthenticationException(String) - Constructor for exception org.aerogear.mobile.auth.AuthenticationException
 
AuthenticationException(String, Throwable) - Constructor for exception org.aerogear.mobile.auth.AuthenticationException
 
AuthorizationServiceFactory - Class in org.aerogear.mobile.auth.authenticator
Factory class used to create the 'openid' classes.
AuthorizationServiceFactory(Context) - Constructor for class org.aerogear.mobile.auth.authenticator.AuthorizationServiceFactory
Builds a new AuthorizationServiceFactory
AuthorizationServiceFactory.ServiceWrapper - Class in org.aerogear.mobile.auth.authenticator
Wrapper class for all the objects used to perform OIDC authentication through the usage of the `openid` library.
AuthService - Class in org.aerogear.mobile.auth
Entry point for authenticating users.
AuthService() - Constructor for class org.aerogear.mobile.auth.AuthService
Instantiates a new AuthService object
AuthServiceConfiguration - Class in org.aerogear.mobile.auth.configuration
This represents an authentication config provided by the developer.
AuthServiceConfiguration.AuthConfigurationBuilder - Class in org.aerogear.mobile.auth.configuration
Builds and returns an AuthServiceConfiguration object.
AuthStateManager - Class in org.aerogear.mobile.auth
Saves, retrieves and delete a token.

B

build() - Method in class org.aerogear.mobile.auth.authenticator.DefaultAuthenticateOptions.Builder
 
build() - Method in class org.aerogear.mobile.auth.configuration.AuthServiceConfiguration.AuthConfigurationBuilder
 
build() - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 
BUILD_TYPE - Static variable in class org.aerogear.android.auth.BuildConfig
 
BuildConfig - Class in org.aerogear.android.auth
 
BuildConfig() - Constructor for class org.aerogear.android.auth.BuildConfig
 
Builder() - Constructor for class org.aerogear.mobile.auth.authenticator.DefaultAuthenticateOptions.Builder
 
Builder() - Constructor for class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 

C

checkValidAuth() - Method in class org.aerogear.mobile.auth.credentials.OIDCCredentials
Check whether the user is authorized and not expired.
clear() - Method in class org.aerogear.mobile.auth.AuthStateManager
Deletes a token
configure(MobileCore, ServiceConfiguration) - Method in class org.aerogear.mobile.auth.AuthService
 
createAuthorizationService(KeycloakConfiguration, AuthServiceConfiguration) - Method in class org.aerogear.mobile.auth.authenticator.AuthorizationServiceFactory
Creates and initializes a new AuthorizationService ready to be used for authenticating with Keycloak.
currentUser() - Method in class org.aerogear.mobile.auth.AuthService
Return the user that is currently logged and is still valid.

D

DEBUG - Static variable in class org.aerogear.android.auth.BuildConfig
 
DefaultAuthenticateOptions - Class in org.aerogear.mobile.auth.authenticator
 
DefaultAuthenticateOptions(Activity, int) - Constructor for class org.aerogear.mobile.auth.authenticator.DefaultAuthenticateOptions
 
DefaultAuthenticateOptions.Builder - Class in org.aerogear.mobile.auth.authenticator
 
deleteTokens() - Method in class org.aerogear.mobile.auth.authenticator.oidc.OIDCAuthenticatorImpl
Delete the the current tokens/authentication state.
deleteTokens() - Method in class org.aerogear.mobile.auth.AuthService
Delete the the current tokens/authentication state.
deserialize(String) - Static method in class org.aerogear.mobile.auth.credentials.OIDCCredentials
Return a new credential from the output of OIDCCredentials.serialize()

E

email - Variable in class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 
equals(Object) - Method in class org.aerogear.mobile.auth.credentials.OIDCCredentials
 
equals(Object) - Method in class org.aerogear.mobile.auth.user.UserRole
Compares UserRole objects for equality.

F

fetchJwks(KeycloakConfiguration, Callback<JsonWebKeySet>) - Method in class org.aerogear.mobile.auth.credentials.JwksManager
Call the remote endpoint to load the JWKS and save it locally.
fetchJwksIfNeeded(KeycloakConfiguration, boolean) - Method in class org.aerogear.mobile.auth.credentials.JwksManager
Fetch the JWKS from the server if necessary and save them locally.
firstName - Variable in class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 
FLAVOR - Static variable in class org.aerogear.android.auth.BuildConfig
 

G

getAccessToken() - Method in class org.aerogear.mobile.auth.credentials.OIDCCredentials
 
getAccessToken() - Method in interface org.aerogear.mobile.auth.user.UserPrincipal
Returns the token that will allow access to other services.
getAccessToken() - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
Returns the access token for the current logged user.
getAuthenticationEndpoint() - Method in class org.aerogear.mobile.auth.configuration.KeycloakConfiguration
Get the URI for the Keycloak authentication endpoint
getAuthorizationRequest() - Method in class org.aerogear.mobile.auth.authenticator.AuthorizationServiceFactory.ServiceWrapper
 
getAuthorizationService() - Method in class org.aerogear.mobile.auth.authenticator.AuthorizationServiceFactory.ServiceWrapper
 
getAuthState() - Method in class org.aerogear.mobile.auth.authenticator.AuthorizationServiceFactory.ServiceWrapper
 
getCustomBooleanAttribute(String) - Method in interface org.aerogear.mobile.auth.user.UserPrincipal
Returns the custom user attribute of type boolean.
getCustomBooleanAttribute(String) - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
Returns the custom user attribute of type boolean.
getCustomIntegerAttribute(String) - Method in interface org.aerogear.mobile.auth.user.UserPrincipal
Returns the custom user attribute of type int.
getCustomIntegerAttribute(String) - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
Returns the custom user attribute of type int.
getCustomLongAttribute(String) - Method in interface org.aerogear.mobile.auth.user.UserPrincipal
Returns the custom user attribute of type long.
getCustomLongAttribute(String) - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
Returns the custom user attribute of type long.
getCustomStringAttribute(String) - Method in interface org.aerogear.mobile.auth.user.UserPrincipal
Returns the custom user attribute of type string.
getCustomStringAttribute(String) - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
Returns the custom user attribute of type string.
getEmail() - Method in interface org.aerogear.mobile.auth.user.UserPrincipal
Returns the email
getEmail() - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
 
getFirstName() - Method in interface org.aerogear.mobile.auth.user.UserPrincipal
Returns the first name of the user.
getFirstName() - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
 
getFromActivity() - Method in class org.aerogear.mobile.auth.authenticator.DefaultAuthenticateOptions
 
getHostUrl() - Method in class org.aerogear.mobile.auth.configuration.KeycloakConfiguration
Get the URL string of the Keycloak singleThreadService
getIdentityToken() - Method in class org.aerogear.mobile.auth.credentials.OIDCCredentials
 
getIdentityToken() - Method in interface org.aerogear.mobile.auth.user.UserPrincipal
Returns the users identity token.
getIdentityToken() - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
Returns the identity token.
getInstance() - Static method in class org.aerogear.mobile.auth.AuthStateManager
 
getIssuer() - Method in class org.aerogear.mobile.auth.configuration.KeycloakConfiguration
Returns the JWT Issuer
getIssuerHostname() - Method in class org.aerogear.mobile.auth.configuration.KeycloakConfiguration
Get the Auth Server URL string of the Keycloak singleThreadService This URL should only be used to get the issuer field for token verification.
getJwksUrl() - Method in class org.aerogear.mobile.auth.configuration.KeycloakConfiguration
Returns the URL where keys can be retrieved.
getLastName() - Method in interface org.aerogear.mobile.auth.user.UserPrincipal
Returns the last name of the user.
getLastName() - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
 
getLogoutUrl(String, String) - Method in class org.aerogear.mobile.auth.configuration.KeycloakConfiguration
Get the logout URL string
getMinTimeBetweenJwksRequests() - Method in class org.aerogear.mobile.auth.configuration.AuthServiceConfiguration
 
getName() - Method in interface org.aerogear.mobile.auth.user.UserPrincipal
Returns the full name of the user.
getName() - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
 
getName() - Method in class org.aerogear.mobile.auth.user.UserRole
Get's the name of the role.
getNamespace() - Method in class org.aerogear.mobile.auth.user.UserRole
Get's the namespace/client ID of the role.
getNeedsRenewal() - Method in class org.aerogear.mobile.auth.credentials.OIDCCredentials
Check whether new access token is needed.
getRealmName() - Method in class org.aerogear.mobile.auth.configuration.KeycloakConfiguration
Get the realm name of the Keycloak singleThreadService
getRealmRoles() - Method in interface org.aerogear.mobile.auth.user.UserPrincipal
Returns the realm roles associated with this principal
getRealmRoles() - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
Get's the user realm roles
getRedirectUri() - Method in class org.aerogear.mobile.auth.configuration.AuthServiceConfiguration
 
getRefreshToken() - Method in class org.aerogear.mobile.auth.credentials.OIDCCredentials
 
getRefreshToken() - Method in interface org.aerogear.mobile.auth.user.UserPrincipal
Returns the users refresh token.
getRefreshToken() - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
Returns the refresh token.
getResourceId() - Method in class org.aerogear.mobile.auth.configuration.KeycloakConfiguration
Get the resource id
getResourceRoles() - Method in interface org.aerogear.mobile.auth.user.UserPrincipal
Returns the resource roles associated with this principal
getResourceRoles() - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
Get's the user resource roles
getResultCode() - Method in class org.aerogear.mobile.auth.authenticator.DefaultAuthenticateOptions
 
getRoles() - Method in interface org.aerogear.mobile.auth.user.UserPrincipal
Returns the roles associated with this principal
getRoles() - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
Get's user roles
getScopes() - Method in class org.aerogear.mobile.auth.configuration.AuthServiceConfiguration
 
getServiceConfig() - Method in class org.aerogear.mobile.auth.authenticator.AbstractAuthenticator
Returns the authentication singleThreadService configuration
getSkipCertificatePinningChecks() - Method in class org.aerogear.mobile.auth.authenticator.DefaultAuthenticateOptions
 
getTokenEndpoint() - Method in class org.aerogear.mobile.auth.configuration.KeycloakConfiguration
Get the URI for the token exchange endpoint
getType() - Method in class org.aerogear.mobile.auth.user.UserRole
Get's the type of the role.
getUsername() - Method in interface org.aerogear.mobile.auth.user.UserPrincipal
Returns the username
getUsername() - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
 

H

handleAuthResult(Intent) - Method in class org.aerogear.mobile.auth.authenticator.oidc.OIDCAuthenticatorImpl
 
handleAuthResult(Intent) - Method in class org.aerogear.mobile.auth.AuthService
This function should be called in the start activity's "onActivityResult" method to allow the SDK to process the response from the authentication server.
hashCode() - Method in class org.aerogear.mobile.auth.credentials.OIDCCredentials
 
hashCode() - Method in class org.aerogear.mobile.auth.user.UserRole
Generates hashcode value from the UserRole name UserRole.name and type UserRole.type
hasRealmRole(String) - Method in interface org.aerogear.mobile.auth.user.UserPrincipal
Checks if the user has the specified Realm role.
hasRealmRole(String) - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
Checks if the user has the specified Realm role.
hasResourceRole(String, String) - Method in interface org.aerogear.mobile.auth.user.UserPrincipal
Checks if the user has the specified Resource role.
hasResourceRole(String, String) - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
Checks if the user has the specified Resource role.

I

idToken - Variable in class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 
init(Context, AuthServiceConfiguration) - Method in class org.aerogear.mobile.auth.AuthService
Initialize the module.
isAuthorized() - Method in class org.aerogear.mobile.auth.credentials.OIDCCredentials
Check if the user is authenticated/authorized.
isExpired() - Method in class org.aerogear.mobile.auth.credentials.OIDCCredentials
Returns whether this token is expired or not.

J

JwksException - Exception in org.aerogear.mobile.auth.credentials
 
JwksException(Throwable) - Constructor for exception org.aerogear.mobile.auth.credentials.JwksException
 
JwksException(String) - Constructor for exception org.aerogear.mobile.auth.credentials.JwksException
 
JwksManager - Class in org.aerogear.mobile.auth.credentials
A class that is responsible for manage the Json Web Key Set(JWKS).
JwksManager(Context, MobileCore, AuthServiceConfiguration) - Constructor for class org.aerogear.mobile.auth.credentials.JwksManager
 

K

KeycloakConfiguration - Class in org.aerogear.mobile.auth.configuration
A class to represent the configuration options of the Keycloak singleThreadService
KeycloakConfiguration(ServiceConfiguration) - Constructor for class org.aerogear.mobile.auth.configuration.KeycloakConfiguration
Create a new instance of the Keycloak configuration from the given instance of ServiceConfiguration.

L

lastName - Variable in class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 
load() - Method in class org.aerogear.mobile.auth.AuthStateManager
Reads credentials from storage.
load(KeycloakConfiguration) - Method in class org.aerogear.mobile.auth.credentials.JwksManager
Load the cached JWKS from the private storage of the app.
login(DefaultAuthenticateOptions, Callback<UserPrincipal>) - Method in class org.aerogear.mobile.auth.AuthService
Log in the user with the given authentication options.
logout(UserPrincipal, Callback<UserPrincipal>) - Method in class org.aerogear.mobile.auth.authenticator.AbstractAuthenticator
Logout the given principal
logout(UserPrincipal, Callback<UserPrincipal>) - Method in class org.aerogear.mobile.auth.authenticator.oidc.OIDCAuthenticatorImpl
 
logout(UserPrincipal, Callback<UserPrincipal>) - Method in class org.aerogear.mobile.auth.AuthService
Log out the given principal.

N

newBuilder() - Static method in class org.aerogear.mobile.auth.authenticator.DefaultAuthenticateOptions
 
newUser() - Static method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
 

O

OIDCAuthenticatorImpl - Class in org.aerogear.mobile.auth.authenticator.oidc
Authenticates the user by using OpenID Connect.
OIDCAuthenticatorImpl(ServiceConfiguration, AuthServiceConfiguration, AuthStateManager, AuthorizationServiceFactory, JwksManager, HttpServiceModule) - Constructor for class org.aerogear.mobile.auth.authenticator.oidc.OIDCAuthenticatorImpl
Creates a new OIDCAuthenticatorImpl object
OIDCCredentials - Class in org.aerogear.mobile.auth.credentials
Credentials for OIDC based authentication
OIDCCredentials(String) - Constructor for class org.aerogear.mobile.auth.credentials.OIDCCredentials
OpenID Connect credentials containing the identity, refresh and access tokens provided on a successful authentication with OpenID Connect.
OIDCCredentials() - Constructor for class org.aerogear.mobile.auth.credentials.OIDCCredentials
 
org.aerogear.android.auth - package org.aerogear.android.auth
 
org.aerogear.mobile.auth - package org.aerogear.mobile.auth
 
org.aerogear.mobile.auth.authenticator - package org.aerogear.mobile.auth.authenticator
 
org.aerogear.mobile.auth.authenticator.oidc - package org.aerogear.mobile.auth.authenticator.oidc
 
org.aerogear.mobile.auth.configuration - package org.aerogear.mobile.auth.configuration
 
org.aerogear.mobile.auth.credentials - package org.aerogear.mobile.auth.credentials
 
org.aerogear.mobile.auth.user - package org.aerogear.mobile.auth.user
 
org.aerogear.mobile.auth.utils - package org.aerogear.mobile.auth.utils
 

P

parseUser() - Method in class org.aerogear.mobile.auth.utils.UserIdentityParser
 
PROJECT_ROOT - Static variable in class org.aerogear.android.auth.BuildConfig
 

R

refreshToken - Variable in class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 
renew() - Method in class org.aerogear.mobile.auth.credentials.OIDCCredentials
Renew the token.
requiresConfiguration() - Method in class org.aerogear.mobile.auth.AuthService
 
roles - Variable in class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 
RoleType - Enum in org.aerogear.mobile.auth.user
Keycloak role types

S

save(OIDCCredentials) - Method in class org.aerogear.mobile.auth.AuthStateManager
Saves a token
serialize() - Method in class org.aerogear.mobile.auth.credentials.OIDCCredentials
Returns stringified JSON for the OIDCCredential.
setFromActivity(Activity) - Method in class org.aerogear.mobile.auth.authenticator.DefaultAuthenticateOptions.Builder
 
setNeedsRenewal() - Method in class org.aerogear.mobile.auth.credentials.OIDCCredentials
Force request of new access token.
setResultCode(int) - Method in class org.aerogear.mobile.auth.authenticator.DefaultAuthenticateOptions.Builder
 
setSkipCertificatePinningChecks(boolean) - Method in class org.aerogear.mobile.auth.authenticator.DefaultAuthenticateOptions.Builder
 

T

TAG - Static variable in class org.aerogear.mobile.auth.credentials.JwksManager
 
toString() - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl
 
toString() - Method in class org.aerogear.mobile.auth.user.UserRole
 
type() - Method in class org.aerogear.mobile.auth.AuthService
 

U

UserIdentityParser - Class in org.aerogear.mobile.auth.utils
 
UserIdentityParser(OIDCCredentials, KeycloakConfiguration) - Constructor for class org.aerogear.mobile.auth.utils.UserIdentityParser
 
username - Variable in class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 
UserPrincipal - Interface in org.aerogear.mobile.auth.user
Public interface for user principals.
UserPrincipalImpl - Class in org.aerogear.mobile.auth.user
This class represent an authenticated user
UserPrincipalImpl(String, String, String, String, Set<UserRole>, String, String, String) - Constructor for class org.aerogear.mobile.auth.user.UserPrincipalImpl
Builds a new UserPrincipalImpl object
UserPrincipalImpl.Builder - Class in org.aerogear.mobile.auth.user
Builds and return a UserPrincipalImpl object
UserRole - Class in org.aerogear.mobile.auth.user
Represents a user's keycloak roles information.
UserRole(String, RoleType, String) - Constructor for class org.aerogear.mobile.auth.user.UserRole
Creates a new UserRole object.

V

valueOf(String) - Static method in enum org.aerogear.mobile.auth.user.RoleType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.aerogear.mobile.auth.user.RoleType
Returns an array containing the constants of this enum type, in the order they are declared.
verifyClaims(JsonWebKeySet, KeycloakConfiguration) - Method in class org.aerogear.mobile.auth.credentials.OIDCCredentials
Verify the token and its claims against the given Keycloak configuration
VERSION_CODE - Static variable in class org.aerogear.android.auth.BuildConfig
 
VERSION_NAME - Static variable in class org.aerogear.android.auth.BuildConfig
 

W

withAccessToken(String) - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 
withEmail(String) - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 
withFirstName(String) - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 
withIdentityToken(String) - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 
withLastName(String) - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 
withMinTimeBetweenJwksRequests(int) - Method in class org.aerogear.mobile.auth.configuration.AuthServiceConfiguration.AuthConfigurationBuilder
 
withRedirectUri(String) - Method in class org.aerogear.mobile.auth.configuration.AuthServiceConfiguration.AuthConfigurationBuilder
Allow specify the value of the redirect uri
withRefreshToken(String) - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 
withRoles(Set<UserRole>) - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 
withScopes(String) - Method in class org.aerogear.mobile.auth.configuration.AuthServiceConfiguration.AuthConfigurationBuilder
Allow specifying the OIDC scopes of the auth request
withUsername(String) - Method in class org.aerogear.mobile.auth.user.UserPrincipalImpl.Builder
 
A B C D E F G H I J K L N O P R S T U V W 
Skip navigation links