kotlin-odata/com.sap.cloud.mobile.kotlin.odata.http/HttpHeaders

HttpHeaders

open class HttpHeaders

Encapsulates a map of HTTP headers, allowing case-insensitive lookup.

Constructors

constructor()

Types

object Companion

Properties

open val isEmpty: Boolean

open val size: Int

Functions

open fun addAll(other: HttpHeaders)

Add all of the headers from another headers object into this headers object.

open fun clear()

Clear all the headers.

open fun concurrent(): HttpHeaders

Return this headers object, configured to allow safe concurrent read/write access.

open fun copy(): HttpHeaders

Return a copy of these headers.

open fun delete(name: String): Boolean

For internal use only.

open fun entries(): StringMap.EntryList

Return the header entries (name/value pairs).

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

Compare this HttpHeaders keys/values with another HttpHeaders keys/values for equality.

open fun get(name: String): String?

Return (nullable) The value of a header, or null if not found.

open fun has(name: String): Boolean

Return true if a specified header exists.

open override fun hashCode(): Int

Return a hash code for this HttpHeaders.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.core.PearsonHashing}.

open fun keys(): StringList

Return the header names.

open fun parse(text: String, request: HttpRequest?)

For internal use only.

open fun remove(name: String): Boolean

Remove the value of a header, if present.

open fun set(name: String, value: String)

Set the value of a header.

open fun sortedEntries(): StringMap.EntryList

Return the header entries (name/value pairs) sorted by name (case insensitive).

open fun sortedKeys(): StringList

Return the header names in sorted order.

open override fun toString(): String

Return headers as a JSON string.

toStringLowerCaseKeys

open fun toStringLowerCaseKeys(): String

Return headers as a JSON string, that the key field is lower case.

open fun with(name: String, value: String): HttpHeaders

Set the value of a header.

withClientCredentials

open fun withClientCredentials(credentials: StructureBase): HttpHeaders

Equivalent to withData("X-Client-Credentials", value).

withCreateParameters

open fun withCreateParameters(parameters: StructureBase): HttpHeaders

Equivalent to withData("X-Create-Parameters", value).

open fun withData(header: String, value: Any?): HttpHeaders

Convert value to OData 4.0 JSON format, then set a header with the JSON-encoded value as a data URI with media type "application/json" and base64-encoded data.

withDeleteParameters

open fun withDeleteParameters(parameters: StructureBase): HttpHeaders

Equivalent to withData("X-Delete-Parameters", parameters).

withUpdateParameters

open fun withUpdateParameters(parameters: StructureBase): HttpHeaders

Equivalent to withData("X-Update-Parameters", value).