auth-foundation/com.okta.authfoundation.credential.kmp.storage/createTokenDatabase

createTokenDatabase

fun createTokenDatabase(context: Context, dbName: String = TokenDatabase.DB_NAME): TokenDatabase

Creates a TokenDatabase for Android applications, backed by Room's bundled SQLite driver.

Unlike the legacy SQLCipher-backed RoomTokenStorage, this database file itself is not whole-database encrypted — only the access-token column is encrypted, via whichever com.okta.authfoundation.credential.kmp.TokenEncryptionHandler is passed to RoomTokenStorage (see createEncryptedTokenStorage).

Return

a configured TokenDatabase instance.

Parameters

context

the Android application context.

dbName

the Room database file name. Defaults to TokenDatabase.DB_NAME.

fun createTokenDatabase(dbPath: String = ".okta"): TokenDatabase

Creates a TokenDatabase for JVM applications using file-based SQLite.

The database file is created at dbPath. Parent directories are created if they do not exist.

Return

a configured TokenDatabase instance.

Parameters

dbPath

the file system path for the database. Defaults to ~/.okta/common_token_database.