ktor-http/io.ktor.http.content/EntityTagVersion

EntityTagVersion

data class EntityTagVersion(val etag: String, val weak: Boolean) : Version

This version checks the etag value and pass it through conditions supplied by the remote client. Depending on the conditions, it produces the return value of enum type VersionCheckResult.

It never handles If-None-Match: * as it is related to non-etag logic (for example, Last modified checks).

Return

VersionCheckResult.OK if all headers pass or there was no related headers, VersionCheckResult.NOT_MODIFIED for successful If-None-Match, VersionCheckResult.PRECONDITION_FAILED for failed If-Match

Parameters

etag

entity tag, for example file's content hash

weak

whether strong or weak validation should be applied

Constructors

EntityTagVersion

constructor(etag: String, weak: Boolean)

Types

Companion

object Companion

Properties

etag

val etag: String

weak

val weak: Boolean

Functions

appendHeadersTo

open override fun appendHeadersTo(builder: HeadersBuilder)

Appends relevant headers to the builder.

check

open override fun check(requestHeaders: Headers): VersionCheckResult

Checks requestHeaders against this version and returns VersionCheckResult.

match

fun match(other: EntityTagVersion): Boolean

Checks whether two entity-tags match (strong).

fun match(givenMatchEtags: List<EntityTagVersion>): VersionCheckResult

Specifies If-Match logic using the match function.

noneMatch

fun noneMatch(givenNoneMatchEtags: List<EntityTagVersion>): VersionCheckResult

Specifies If-None-Match logic using the match function.