org.aerogear.mobile.auth.credentials

Class JwksManager

java.lang.Object

org.aerogear.mobile.auth.credentials.JwksManager

public class JwksManager
extends java.lang.Object

A class that is responsible for manage the Json Web Key Set(JWKS).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
JwksManager(android.content.Context context, org.aerogear.mobile.core.MobileCore mobileCore, AuthServiceConfiguration authServiceConfiguration)

Method Summary

Modifier and Type	Method and Description
void	fetchJwks(KeycloakConfiguration keycloakConfiguration, org.aerogear.mobile.core.Callback<org.jose4j.jwk.JsonWebKeySet> cb) Call the remote endpoint to load the JWKS and save it locally.
boolean	fetchJwksIfNeeded(KeycloakConfiguration keycloakConfiguration, boolean forceFetch) Fetch the JWKS from the server if necessary and save them locally.
org.jose4j.jwk.JsonWebKeySet	load(KeycloakConfiguration keyCloakConfig) Load the cached JWKS from the private storage of the app.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Constructor Detail

JwksManager

public JwksManager(@NonNull
                   android.content.Context context,
                   @NonNull
                   org.aerogear.mobile.core.MobileCore mobileCore,
                   @NonNull
                   AuthServiceConfiguration authServiceConfiguration)

Method Detail

load

public org.jose4j.jwk.JsonWebKeySet load(KeycloakConfiguration keyCloakConfig)

Load the cached JWKS from the private storage of the app. It will return null if there is no cached JWKS found. It will trigger a request to fetch the JWKS in the background if there is no cached key found, or AuthServiceConfiguration.getMinTimeBetweenJwksRequests() is passed since the key set is requested last time.

Parameters:

keyCloakConfig - the configuration to use to load the JWKS object

Returns:

the cached JWKS, or null if it doesn't exist

fetchJwksIfNeeded

public boolean fetchJwksIfNeeded(KeycloakConfiguration keycloakConfiguration,
                                 boolean forceFetch)

Fetch the JWKS from the server if necessary and save them locally. The request will be trigger if: 1. forceFetch is set to true, or 2. AuthServiceConfiguration.getMinTimeBetweenJwksRequests() is passed since the key set is requested last time.

Parameters:

keycloakConfiguration - the configuration of the keycloak server

forceFetch - if set to true, the request will be trigger immediately.

Returns:

whether the keys has been fetched or not.

fetchJwks

public void fetchJwks(@NonNull
                      KeycloakConfiguration keycloakConfiguration,
                      @Nullable
                      org.aerogear.mobile.core.Callback<org.jose4j.jwk.JsonWebKeySet> cb)

Call the remote endpoint to load the JWKS and save it locally.

Parameters:

keycloakConfiguration - the configuration of the keycloak server

cb - the callback function to be invoked when the request is completed. Can be null.