android-sdk-core/com.mapsted.positioning.coreEngineImpl.modules.network.Login/AuthenticationManager

AuthenticationManager

Constructors

constructor(@NonNull context: Context, @NonNull webApiClient: WebApiClient)

Types

Listener notified when per-property roles are (re-)resolved on an online login response, so a host (MapstedCoreApi) can build and publish the active UserRoleAccess.

Properties

ROLE_CACHE_TTL_MILLIS

val ROLE_CACHE_TTL_MILLIS: Long = 86400000

Role cache time-to-live.

Functions

clearCachedRoles

open fun clearCachedRoles()

Wipe cached roles + lock list + timestamp.

getAllowedProperties

@Nullable

open fun getAllowedProperties(): HashSet<Integer>

getAllowedRoles

@NonNull

open fun getAllowedRoles(): Map<Integer, String>

Alias of getCachedRoles.

getAuthLoginRequest

@Nullable

open fun getAuthLoginRequest(): AuthLogin.Request

getCachedPropertiesWithLock

@NonNull

open fun getCachedPropertiesWithLock(): List<Integer>

Cached access-locked property list if the role cache is still within ROLE_CACHE_TTL_MILLIS; empty list if expired or never cached.

getCachedPropertiesWithLockRaw

@NonNull

open fun getCachedPropertiesWithLockRaw(): List<Integer>

Cached access-locked property list ignoring the role-cache TTL.

getCachedRoles

@NonNull

open fun getCachedRoles(): Map<Integer, String>

Cached roles if still within ROLE_CACHE_TTL_MILLIS; empty map if expired or never cached.

getLicenceId

@NonNull

open fun getLicenceId(): String

getLoggedInUsername

@Nullable

open fun getLoggedInUsername(): String

isLoggedIn

open fun isLoggedIn(): Boolean

isRoleCacheValid

open fun isRoleCacheValid(): Boolean

True if a cache exists AND (now - savedAt) <= ROLE_CACHE_TTL_MILLIS.

@UiThread

open fun login(@NonNull context: Context, @NonNull request: AuthLogin.Request, @Nullable callback: AuthLogin.Callback)

onDestroy

open fun onDestroy()

saveAllowedProperties

open fun saveAllowedProperties(@Nullable allowedProperties: List<Integer>)

saveAllowedRoles

open fun saveAllowedRoles(@NonNull propertyRoleMap: Map<Integer, String>)

Alias of saveCachedRoles.

saveAuthLoginRequest

open fun saveAuthLoginRequest(request: AuthLogin.Request)

saveCachedPropertiesWithLock

open fun saveCachedPropertiesWithLock(@Nullable propertiesWithLock: List<Integer>)

Persist the access-locked property list alongside the role cache.

saveCachedRoles

open fun saveCachedRoles(@NonNull propertyRoleMap: Map<Integer, String>)

Persist the user's allowed roles (propertyId -> accessRoleId) and stamp the TTL now.

setRoleAccessUpdateListener

open fun setRoleAccessUpdateListener(@Nullable listener: AuthenticationManager.RoleAccessUpdateListener)

setUserRolesSource

open fun setUserRolesSource(@Nullable source: UserRolesSource)

Inject the userRoleId -> accessRestrictionId resolution source.