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

EntityTagVersion

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

This version checks etag value and pass it through conditions supplied by the remote client. Depending on conditions it produces 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). See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26 for more details

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

~~fun~~ ~~EntityTagVersion~~(~~etag~~: String)

EntityTagVersion

fun EntityTagVersion(etag: String, weak: Boolean)

Types

object Companion

Functions

appendHeadersTo

open override fun appendHeadersTo(builder: HeadersBuilder)

Appends relevant headers to the builder

open override fun check(requestHeaders: Headers): VersionCheckResult

Checks requestHeaders against this version and returns VersionCheckResult

fun match(other: EntityTagVersion): Boolean

Examine two entity-tags for match (strong).

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

If-Match logic using match function.

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

If-None-Match logic using match function.

Properties

val etag: String

val weak: Boolean