io.ktor.http.auth

Class HttpAuthHeader.Parameterized

HttpAuthHeader

io.ktor.http.auth.HttpAuthHeader.Parameterized

Enclosing class:

HttpAuthHeader

public static class HttpAuthHeader.Parameterized
extends HttpAuthHeader

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

Nested Class Summary

Nested classes/interfaces inherited from class io.ktor.http.auth.HttpAuthHeader

HttpAuthHeader.Companion, HttpAuthHeader.Parameterized, HttpAuthHeader.Parameters, HttpAuthHeader.Single

Field Summary

Fields inherited from class io.ktor.http.auth.HttpAuthHeader

Companion

Constructor Summary

Constructors

Constructor and Description
Parameterized(java.lang.String authScheme, java.util.List<io.ktor.http.HeaderValueParam> parameters, HeaderValueEncoding encoding) Describes a parameterized authentication header that is represented by a set of parameters encoded with encoding.
Parameterized(java.lang.String authScheme, java.util.Map<java.lang.String,java.lang.String> parameters, HeaderValueEncoding encoding)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
HeaderValueEncoding	getEncoding() parameters encoding method,
java.util.List<io.ktor.http.HeaderValueParam>	getParameters() a list of auth parameters
int	hashCode()
java.lang.String	parameter(java.lang.String name) Tries to extract the first value of a parameter name. Returns null when not found.
java.lang.String	render(HeaderValueEncoding encoding) Encodes the header with a specified encoding.
java.lang.String	render() Encodes the header with the default enum HeaderValueEncoding for this header.
HttpAuthHeader.Parameterized	withParameter(java.lang.String name, java.lang.String value) Copies this class HttpAuthHeader.Parameterized appending a new parameter name.
HttpAuthHeader.Parameterized	withReplacedParameter(java.lang.String name, java.lang.String value) Copies this class HttpAuthHeader.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.

Methods inherited from class io.ktor.http.auth.HttpAuthHeader

getAuthScheme, render, render, toString

Constructor Detail

Parameterized

public Parameterized(java.lang.String authScheme,
                     java.util.List<io.ktor.http.HeaderValueParam> parameters,
                     HeaderValueEncoding encoding)

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

Parameters:

parameters - a list of auth parameters

encoding - parameters encoding method, one of enum HeaderValueEncoding

Parameterized

public Parameterized(java.lang.String authScheme,
                     java.util.Map<java.lang.String,java.lang.String> parameters,
                     HeaderValueEncoding encoding)

Method Detail

withParameter

public HttpAuthHeader.Parameterized withParameter(java.lang.String name,
                                                  java.lang.String value)

Copies this class HttpAuthHeader.Parameterized appending a new parameter name.

See Also:

class HttpAuthHeader.Parameterized

withReplacedParameter

public HttpAuthHeader.Parameterized withReplacedParameter(java.lang.String name,
                                                          java.lang.String value)

Copies this class HttpAuthHeader.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.

See Also:

class HttpAuthHeader.Parameterized

render

public java.lang.String render(HeaderValueEncoding encoding)

Encodes the header with a specified encoding.

parameter

public java.lang.String parameter(java.lang.String name)

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

render

public java.lang.String render()

Encodes the header with the default enum HeaderValueEncoding for this header.

See Also:

enum HeaderValueEncoding

equals

public boolean equals(java.lang.Object other)

hashCode

public int hashCode()

getParameters

public java.util.List<io.ktor.http.HeaderValueParam> getParameters()

a list of auth parameters

getEncoding

public HeaderValueEncoding getEncoding()

parameters encoding method,

one of enum HeaderValueEncoding

See Also:

enum HeaderValueEncoding