ktor-http/io.ktor.http.auth/HttpAuthHeader/Parameterized

Parameterized

class Parameterized(val authScheme: String, val parameters: List<HeaderValueParam>, val encoding: HeaderValueEncoding = HeaderValueEncoding.QUOTED_WHEN_REQUIRED) : HttpAuthHeader

Describes a parameterized authentication header that is represented by a set of parameters encoded with encoding.

Constructors

Parameterized

fun Parameterized(authScheme: String, parameters: Map<String, String>, encoding: HeaderValueEncoding = HeaderValueEncoding.QUOTED_WHEN_REQUIRED)

Parameterized

fun Parameterized(authScheme: String, parameters: List<HeaderValueParam>, encoding: HeaderValueEncoding = HeaderValueEncoding.QUOTED_WHEN_REQUIRED)

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

parameter

fun parameter(name: String): String?

Tries to extract the first value of a parameter name. Returns null when not found.

render

open override fun render(): String

Encodes the header with the default HeaderValueEncoding for this header.

open override fun render(encoding: HeaderValueEncoding): String

Encodes the header with a specified encoding.

toString

open override fun toString(): String

Encodes the header with the default HeaderValueEncoding for this header.

withParameter

fun withParameter(name: String, value: String): HttpAuthHeader.Parameterized

Copies this Parameterized appending a new parameter name.

withReplacedParameter

fun withReplacedParameter(name: String, value: String): HttpAuthHeader.Parameterized

Copies this Parameterized replacing parameters with name assigning new value or appending if no such parameters found. If there were several pairs they will be reduced into a single pair at position of first occurrence discarding following pairs with this name.

Properties

authScheme

val authScheme: String

auth scheme, usually one of AuthScheme

encoding

val encoding: HeaderValueEncoding

parameters encoding method, one of HeaderValueEncoding

parameters

val parameters: List<HeaderValueParam>

a list of auth parameters