com.wallee.android.sdk.request.icon

Interface IconCache

All Known Implementing Classes:

AbstractIconCache, InMemoryIconCache

public interface IconCache

The icon cache caches the downloaded payment method icons.

Depending on the payment method the icon has to be different. The payment methods are not fixed they are depend on the configuration of the space within the wallee backend. The icon itself can be also changed through the wallee backend. As such the icons depend on the configuration and cannot be delivered within the app or the SDK.

This cache should store the downloaded images so when they are reused a download is not required.

The implementor may choose different strategies to cache the images. This really depends on how often the images will be exchanged, how many images there are and how the user will use the app. A minimal implementation may use an in-memory cache which gets onResetView whenever the app is restarted. A file based approach may also be feasible however there has to be a retention strategy in place. To detect if a particular image has changed the PaymentMethodConfiguration.getVersion() can be tracked. Whenever the version changes the icon has been eventually changed.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_ICON_LOADING_TIMEOUT The default loading timeout of the icons in the payment method and token selection view.

Method Summary

Modifier and Type	Method and Description
void	fetchIcons(java.util.Collection<PaymentMethodConfiguration> paymentMethodConfigurations, AsynchronousCallback<java.util.Map<PaymentMethodConfiguration,PaymentMethodIcon>> callback) This method fetches for a collection of PaymentMethodConfiguration the associated icons.
void	loadIcon(PaymentMethodConfiguration methodConfiguration, RequestCallback<PaymentMethodIcon> callback) This method is invoked when for the methodConfiguration the images should be downloaded.

Field Detail

DEFAULT_ICON_LOADING_TIMEOUT

static final long DEFAULT_ICON_LOADING_TIMEOUT

The default loading timeout of the icons in the payment method and token selection view. This time is in milliseconds.

See Also:

Constant Field Values

Method Detail

loadIcon

void loadIcon(PaymentMethodConfiguration methodConfiguration,
              RequestCallback<PaymentMethodIcon> callback)

This method is invoked when for the methodConfiguration the images should be downloaded.

The implementor has to make sure that a parallel invocation of this method does not cause a memory leak. This means that a storage of the result should be implemented in a way that duplicate requests get detected and handled properly. For example by using a ConcurrentMap or some kind of AtomicReference.

The URL from which the icon should be downloaded from can be found on PaymentMethodConfiguration.getResolvedImageUrl().

There is also a IconRequestManager which helps with the invocation of the remote server.

Parameters:

methodConfiguration - the payment method configuration for which the icon should be provided for.

callback - the callback which should be invoked once the icon has been loaded either form the source or from the cache.

fetchIcons

void fetchIcons(java.util.Collection<PaymentMethodConfiguration> paymentMethodConfigurations,
                AsynchronousCallback<java.util.Map<PaymentMethodConfiguration,PaymentMethodIcon>> callback)

This method fetches for a collection of PaymentMethodConfiguration the associated icons.

The method will stop after a specified timeout. The resulting map will have no entry for those which could not be loaded within the timeout.

Parameters:

paymentMethodConfigurations - the configurations for which the icons should be loaded for.

callback - the callback which is invoked once the loading has completed or the timeout has been reached.