HttpAuthHeader

sealed class HttpAuthHeader

Describes an authentication header with a mandatory authScheme that usually is a standard AuthScheme.

This can be of type HttpAuthHeader.Single or HttpAuthHeader.Parameterized.

Inheritors

Types

Link copied to clipboard
object Companion
Link copied to clipboard
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.

Link copied to clipboard
object Parameters

Standard parameters for Parameterized.

Link copied to clipboard
class Single(val authScheme: String, val blob: String) : HttpAuthHeader

Describes an authentication header that is represented by a single blob.

Properties

Link copied to clipboard

auth scheme, usually one of AuthScheme

Functions

Link copied to clipboard
abstract fun render(): String

Encodes the header with the default HeaderValueEncoding for this header.

abstract fun render(encoding: HeaderValueEncoding): String

Encodes the header with a specified encoding.

Link copied to clipboard
open override fun toString(): String

Encodes the header with the default HeaderValueEncoding for this header.