com.microstrategy.usher

Class KeyManager

java.lang.Object

com.microstrategy.usher.KeyManager

All Implemented Interfaces:

android.arch.lifecycle.LifecycleObserver

public class KeyManager
extends java.lang.Object
implements android.arch.lifecycle.LifecycleObserver

The KeyManager class collects all of the use cases related to key management. Key management includes saving keys, fetching keys, and using keys for physical access. All of these methods will be executed on a background thread and will return the result on the main thread. To receive the result, a SingleCallback or CompleteCallback must be provided.

To save keys, call save(List, int, SingleCallback) to save the List of KeyEntity objects to the server by badge ID. The keys can then be fetched by calling list(int, SingleCallback) or list(int, boolean, SingleCallback) and providing the badge ID and optional parameter for a force refresh, depending on whether or not the keys should be retrieved from the cache or from the server.

To use a key for physical access, call access(KeyParam, SingleCallback) and provide a valid KeyParam object.

Constructor Summary

Constructors

Constructor and Description
KeyManager(android.support.v7.app.AppCompatActivity appCompatActivity) Constructor for an KeyManager object with the lifecycle set.
KeyManager(android.support.v4.app.Fragment fragment) Constructor for an KeyManager object with the lifecycle set.
KeyManager(android.arch.lifecycle.Lifecycle lifecycle) Constructor for an KeyManager object with the lifecycle set.

Method Summary

Modifier and Type	Method and Description
void	access(KeyParam keyParam, SingleCallback<PairEntity<java.lang.Boolean,java.lang.String>> callback) Returns a PairEntity object that includes the access success result and the name of the key after attempting physical access.
void	list(int badgeId, boolean forceRefresh, SingleCallback<java.util.List<KeyEntity>> callback) Returns the List of KeyEntity objects for a badge.
void	list(int badgeId, SingleCallback<java.util.List<KeyEntity>> callback) Returns the List of KeyEntity objects for a badge.
void	save(java.util.List<KeyEntity> param, int badgeId, SingleCallback<java.lang.Boolean> callback) Returns a boolean that represents whether or not saving the List of KeyEntity objects to server was successful.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyManager

public KeyManager(android.arch.lifecycle.Lifecycle lifecycle)

Constructor for an KeyManager object with the lifecycle set.

Parameters:

lifecycle - See Lifecycle

KeyManager

public KeyManager(android.support.v7.app.AppCompatActivity appCompatActivity)

Constructor for an KeyManager object with the lifecycle set.

Parameters:

appCompatActivity - See AppCompatActivity

KeyManager

public KeyManager(android.support.v4.app.Fragment fragment)

Constructor for an KeyManager object with the lifecycle set.

Parameters:

fragment - See Fragment

Method Detail

save

public void save(java.util.List<KeyEntity> param,
                 int badgeId,
                 SingleCallback<java.lang.Boolean> callback)

Returns a boolean that represents whether or not saving the List of KeyEntity objects to server was successful. XXX todo should not provide such method.

Parameters:

param - the List of KeyEntity objects to be saved

badgeId - the identification number of the badge for which the List of KeyEntity objects will be saved

callback - the callback to receive the boolean result: true if the key save is successful; false otherwise

list

public void list(int badgeId,
                 boolean forceRefresh,
                 SingleCallback<java.util.List<KeyEntity>> callback)

Returns the List of KeyEntity objects for a badge. May be retrieved from the server or from the cache.

Parameters:

badgeId - the identification number of the badge

forceRefresh - true if the List of KeyEntity objects should be fetched from the server; false if the List of KeyEntity objects should be retrieved from the cache

callback - the callback to receive the List of KeyEntity objects for a badge

list

public void list(int badgeId,
                 SingleCallback<java.util.List<KeyEntity>> callback)

Returns the List of KeyEntity objects for a badge. These will be retrieved from the cache.

Parameters:

badgeId - the identification number of the bage

callback - the callback to receive the List of KeyEntity objects for a badge

access

public void access(KeyParam keyParam,
                   SingleCallback<PairEntity<java.lang.Boolean,java.lang.String>> callback)

Returns a PairEntity object that includes the access success result and the name of the key after attempting physical access.

Parameters:

keyParam - See KeyParam

callback - the callback to receive result of attempting physical access