auth-migration/com.pingidentity.auth.migration/cleanupLegacyDataStep

cleanupLegacyDataStep

fun cleanupLegacyDataStep(provider: LegacyStorageProvider, backup: (context: Context) -> Unit = {}): <Error class: unknown class>

Creates the third and final migration step, which removes legacy authenticator data via the provided LegacyStorageProvider and closes the SQLite storage connections.

Execution order within this step:

  1. Calls LegacyStorageProvider.cleanUp passing the backup callback. StorageClientProvider always invokes the callback first, then iterates and removes all accounts and mechanisms via the org.forgerock.android.auth.StorageClient API. Pass a no-op callback (the default) to skip backup.

  2. Retrieves SQLOathStorage from the migration state and calls closeDatabase().

  3. Retrieves SQLPushStorage from the migration state and calls closeDatabase().

Any exception during cleanup is caught and logged — cleanup failures are non-critical and do not abort the migration or prevent the pipeline from emitting a success event.

Parameters

provider

The same LegacyStorageProvider passed to startMigrationStep, used here to perform the actual cleanup of the legacy storage backend.

backup

Forwarded from LegacyAuthenticationConfig.backup. Passed directly to LegacyStorageProvider.cleanUp so the provider can invoke it before clearing data. Defaults to a no-op, which skips backup.

See also