auth-migration/com.pingidentity.auth.migration/LegacyAuthenticationConfig

LegacyAuthenticationConfig

class LegacyAuthenticationConfig(context: Context)

Configuration for the legacy FR Authenticator data migration.

Configure via the DSL block passed to AuthMigration.start. All properties have sensible defaults for standard FR Authenticator installations — no block is required for most apps.

Constructors

constructor(context: Context)

Properties

backup

var backup: (context: Context) -> Unit

An optional callback invoked during LegacyStorageProvider.cleanUp to back up legacy data before it is cleared. The callback receives the Android Context and is invoked by StorageClientProvider.cleanUp unconditionally — pass a no-op (the default) to skip backup. For custom LegacyStorageProvider implementations, the callback is forwarded via LegacyStorageProvider.cleanUp and it is the implementation's responsibility to invoke it.

legacyStorageProvider

var legacyStorageProvider: LegacyStorageProvider

Defines how the migration pipeline sources legacy data and performs cleanup. Defaults to StorageClientProvider, which reads directly from the legacy ForgeRock StorageClient. Override when your application stores authenticator data in a custom backend (e.g. a different org.forgerock.android.auth.StorageClient implementation, an encrypted database, or a remote store).

logger

var logger: Logger

Logger instance used throughout the migration pipeline. Defaults to Logger.STANDARD.

progress

var progress: FlowCollector<MigrationProgress>?

An optional FlowCollector that receives migration pipeline events.

LegacyAuthenticationConfig

See also

Constructors

Properties