public static class HttpAuthHeader.Parameterized
extends HttpAuthHeader
Describes a parameterized authentication header that is represented by a set of parameters encoded with encoding.
HttpAuthHeader.Companion, HttpAuthHeader.Parameterized, HttpAuthHeader.Parameters, HttpAuthHeader.Single
Companion
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) |
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. |
getAuthScheme, render, render, toString
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
- a list of auth parametersencoding
- parameters encoding method, one of enum HeaderValueEncoding
public Parameterized(java.lang.String authScheme, java.util.Map<java.lang.String,java.lang.String> parameters, HeaderValueEncoding encoding)
public HttpAuthHeader.Parameterized withParameter(java.lang.String name, java.lang.String value)
Copies this class HttpAuthHeader.Parameterized
appending a new parameter name.
class HttpAuthHeader.Parameterized
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.
class HttpAuthHeader.Parameterized
public java.lang.String render(HeaderValueEncoding encoding)
Encodes the header with a specified encoding.
public java.lang.String parameter(java.lang.String name)
Tries to extract the first value of a parameter name. Returns null when not found.
public java.lang.String render()
Encodes the header with the default enum HeaderValueEncoding
for this header.
enum HeaderValueEncoding
public boolean equals(java.lang.Object other)
public int hashCode()
public java.util.List<io.ktor.http.HeaderValueParam> getParameters()
a list of auth parameters
public HeaderValueEncoding getEncoding()
parameters encoding method,
one of enum HeaderValueEncoding
enum HeaderValueEncoding