Stay organized with collections
Save and categorize content based on your preferences.
HttpRetryException
open class HttpRetryException : IOException
Thrown to indicate that a HTTP request needs to be retried but cannot be retried automatically, due to streaming mode being enabled.
Summary
| Public constructors |
|
Constructs a new HttpRetryException from the specified response code and exception detail message
|
|
Constructs a new HttpRetryException with detail message responseCode and the contents of the Location response header field.
|
| Public methods |
| open String! |
Returns the value of the Location header field if the error resulted from redirection.
|
| open String! |
Returns a string explaining why the http request could not be retried.
|
| open Int |
Returns the http response code
|
Public constructors
HttpRetryException
HttpRetryException(
detail: String!,
code: Int)
Constructs a new HttpRetryException from the specified response code and exception detail message
| Parameters |
detail |
String!: the detail message. |
code |
Int: the HTTP response code from server. |
HttpRetryException
HttpRetryException(
detail: String!,
code: Int,
location: String!)
Constructs a new HttpRetryException with detail message responseCode and the contents of the Location response header field.
| Parameters |
detail |
String!: the detail message. |
code |
Int: the HTTP response code from server. |
location |
String!: the URL to be redirected to |
Public methods
getLocation
open fun getLocation(): String!
Returns the value of the Location header field if the error resulted from redirection.
| Return |
String! |
The location string |
getReason
open fun getReason(): String!
Returns a string explaining why the http request could not be retried.
| Return |
String! |
The reason string |
responseCode
open fun responseCode(): Int
Returns the http response code
| Return |
Int |
The http response code. |
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,["# HttpRetryException\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nHttpRetryException\n==================\n\n```\nopen class HttpRetryException : IOException\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](../lang/Exception.html#) |||\n| | | ↳ | [java.io.IOException](../io/IOException.html#) ||\n| | | | ↳ | [java.net.HttpRetryException](#) |\n\nThrown to indicate that a HTTP request needs to be retried but cannot be retried automatically, due to streaming mode being enabled.\n\nSummary\n-------\n\n| Public constructors ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [HttpRetryException](#HttpRetryException(kotlin.String,%20kotlin.Int))`(`detail:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `code:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Constructs a new `HttpRetryException` from the specified response code and exception detail message |\n| [HttpRetryException](#HttpRetryException(kotlin.String,%20kotlin.Int,%20kotlin.String))`(`detail:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `code:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `location:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` Constructs a new `HttpRetryException` with detail message responseCode and the contents of the Location response header field. |\n\n| Public methods ||\n|----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|\n| open [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getLocation](#getLocation())`()` Returns the value of the Location header field if the error resulted from redirection. |\n| open [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getReason](#getReason())`()` Returns a string explaining why the http request could not be retried. |\n| open [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [responseCode](#responseCode())`()` Returns the http response code |\n\nPublic constructors\n-------------------\n\n### HttpRetryException\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nHttpRetryException(\n detail: String!, \n code: Int)\n```\n\nConstructs a new `HttpRetryException` from the specified response code and exception detail message\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------------|\n| `detail` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!: the detail message. |\n| `code` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): the HTTP response code from server. |\n\n### HttpRetryException\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nHttpRetryException(\n detail: String!, \n code: Int, \n location: String!)\n```\n\nConstructs a new `HttpRetryException` with detail message responseCode and the contents of the Location response header field.\n\n| Parameters ||\n|------------|-----------------------------------------------------------------------------------------------------------------|\n| `detail` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!: the detail message. |\n| `code` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): the HTTP response code from server. |\n| `location` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!: the URL to be redirected to |\n\nPublic methods\n--------------\n\n### getLocation\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun getLocation(): String!\n```\n\nReturns the value of the Location header field if the error resulted from redirection.\n\n| Return ||\n|-----------------------------------------------------------------------------------|---------------------|\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | The location string |\n\n### getReason\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun getReason(): String!\n```\n\nReturns a string explaining why the http request could not be retried.\n\n| Return ||\n|-----------------------------------------------------------------------------------|-------------------|\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | The reason string |\n\n### responseCode\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun responseCode(): Int\n```\n\nReturns the http response code\n\n| Return ||\n|----------------------------------------------------------------------------|-------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | The http response code. |"]]
