Stay organized with collections
Save and categorize content based on your preferences.
BackendBusyException
open class BackendBusyException : ProviderException
Indicates a transient error that prevented a key operation from being created. Callers should try again with a back-off period of getBackOffHintMillis() milliseconds.
Summary
| Public constructors |
|
Constructs a new BackendBusyException without detail message and cause.
|
|
Constructs a new BackendBusyException with the provided detail message and no cause.
|
|
Constructs a new BackendBusyException with the provided detail message and cause.
|
| Public methods |
| open Long |
When retrying to start a Keystore operation after receiving this exception, this can be used to determine how long to wait before retrying.
|
Public constructors
BackendBusyException
BackendBusyException(backOffHintMillis: Long)
Constructs a new BackendBusyException without detail message and cause.
| Parameters |
backOffHintMillis |
Long: Value is a non-negative duration in milliseconds. |
BackendBusyException
BackendBusyException(
backOffHintMillis: Long,
message: String)
Constructs a new BackendBusyException with the provided detail message and no cause.
| Parameters |
backOffHintMillis |
Long: Value is a non-negative duration in milliseconds. |
message |
String: This value cannot be null. |
BackendBusyException
BackendBusyException(
backOffHintMillis: Long,
message: String,
cause: Throwable)
Constructs a new BackendBusyException with the provided detail message and cause.
| Parameters |
backOffHintMillis |
Long: Value is a non-negative duration in milliseconds. |
message |
String: This value cannot be null. |
cause |
Throwable: This value cannot be null. |
Public methods
getBackOffHintMillis
open fun getBackOffHintMillis(): Long
When retrying to start a Keystore operation after receiving this exception, this can be used to determine how long to wait before retrying. It is not guaranteed that the operation will succeeds after this time. Multiple retries may be necessary if the system is congested.
Value is a non-negative duration in milliseconds.
| Return |
Long |
Number of milliseconds to back off before retrying. Value is a non-negative duration in milliseconds. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# BackendBusyException\n\nAdded in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nBackendBusyException\n====================\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/security/keystore/BackendBusyException \"View this page in Java\") \n\n```\nopen class BackendBusyException : ProviderException\n```\n\n|---|---|---|---|---|-----------------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||||||\n| ↳ | [kotlin.Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) |||||\n| | ↳ | [java.lang.Exception](../../../java/lang/Exception.html#) ||||\n| | | ↳ | [java.lang.RuntimeException](../../../java/lang/RuntimeException.html#) |||\n| | | | ↳ | [java.security.ProviderException](../../../java/security/ProviderException.html#) ||\n| | | | | ↳ | [android.security.keystore.BackendBusyException](#) |\n\nIndicates a transient error that prevented a key operation from being created. Callers should try again with a back-off period of [getBackOffHintMillis()](#getBackOffHintMillis()) milliseconds.\n\nSummary\n-------\n\n| Public constructors ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [BackendBusyException](#BackendBusyException(kotlin.Long))`(`backOffHintMillis:` `[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`)` Constructs a new `BackendBusyException` without detail message and cause. |\n| [BackendBusyException](#BackendBusyException(kotlin.Long,%20kotlin.String))`(`backOffHintMillis:` `[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `message:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` Constructs a new `BackendBusyException` with the provided detail message and no cause. |\n| [BackendBusyException](#BackendBusyException(kotlin.Long,%20kotlin.String,%20kotlin.Throwable))`(`backOffHintMillis:` `[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `message:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `cause:` `[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`)` Constructs a new `BackendBusyException` with the provided detail message and cause. |\n\n| Public methods ||\n|-----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| open [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | [getBackOffHintMillis](#getBackOffHintMillis())`()` When retrying to start a Keystore operation after receiving this exception, this can be used to determine how long to wait before retrying. |\n\nPublic constructors\n-------------------\n\n### BackendBusyException\n\nAdded in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nBackendBusyException(backOffHintMillis: Long)\n```\n\nConstructs a new `BackendBusyException` without detail message and cause.\n\n| Parameters ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------|\n| `backOffHintMillis` | [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html): Value is a non-negative duration in milliseconds. |\n\n### BackendBusyException\n\nAdded in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nBackendBusyException(\n backOffHintMillis: Long, \n message: String)\n```\n\nConstructs a new `BackendBusyException` with the provided detail message and no cause.\n\n| Parameters ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------|\n| `backOffHintMillis` | [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html): Value is a non-negative duration in milliseconds. |\n| `message` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html): This value cannot be `null`. |\n\n### BackendBusyException\n\nAdded in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nBackendBusyException(\n backOffHintMillis: Long, \n message: String, \n cause: Throwable)\n```\n\nConstructs a new `BackendBusyException` with the provided detail message and cause.\n\n| Parameters ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------|\n| `backOffHintMillis` | [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html): Value is a non-negative duration in milliseconds. |\n| `message` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html): This value cannot be `null`. |\n| `cause` | [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html): This value cannot be `null`. |\n\nPublic methods\n--------------\n\n### getBackOffHintMillis\n\nAdded in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun getBackOffHintMillis(): Long\n```\n\nWhen retrying to start a Keystore operation after receiving this exception, this can be used to determine how long to wait before retrying. It is not guaranteed that the operation will succeeds after this time. Multiple retries may be necessary if the system is congested. \nValue is a non-negative duration in milliseconds.\n\n| Return ||\n|------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|\n| [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | Number of milliseconds to back off before retrying. Value is a non-negative duration in milliseconds. |"]]
