ktor-client-auth/io.ktor.client.features.auth.providers/DigestAuthProvider

DigestAuthProvider

class DigestAuthProvider(credentials: suspend () -> DigestAuthCredentials?, realm: String?, algorithmName: String) : AuthProvider

Client digest AuthProvider.

Constructors

DigestAuthProvider

~~fun~~ ~~DigestAuthProvider~~(~~username~~: String, ~~password~~: String, ~~realm~~: String? = ~~null~~, ~~algorithmName~~: String = ~~"MD5"~~)

DigestAuthProvider

fun DigestAuthProvider(credentials: suspend () -> DigestAuthCredentials?, realm: String? = null, algorithmName: String = "MD5")

Functions

addRequestHeaders

open suspend override fun addRequestHeaders(request: HttpRequestBuilder)

Add authentication method headers and creds.

open override fun isApplicable(auth: HttpAuthHeader): Boolean

Check if current provider is applicable to the request.

open suspend override fun refreshToken(response: HttpResponse): Boolean

Refresh token if required.

sendWithoutRequest

open override fun sendWithoutRequest(request: HttpRequestBuilder): Boolean

Properties

~~val~~ ~~algorithmName~~: String

~~val~~ ~~password~~: String

~~val~~ ~~realm~~: String? = ~~null~~

sendWithoutRequest

open override val sendWithoutRequest: Boolean

Wait for HttpStatusCode.Unauthorized to send credentials.

~~val~~ ~~username~~: String