typedrest/net.typedrest.endpoints.generic/ElementEndpoint

ElementEndpoint

interface ElementEndpoint<TEntity> : Endpoint

Endpoint for an individual resource.

Parameters

TEntity

The type of entity the endpoint represents.

Inheritors

ElementEndpointImpl

Properties

errorHandler

abstract val errorHandler: ErrorHandler

Handles errors in responses.

httpClient

abstract val httpClient: OkHttpClient

The HTTP client used to communicate with the remote resource.

isDeleteAllowed

abstract val isDeleteAllowed: Boolean?

Shows whether the server has indicated that delete is currently allowed.

isMergeAllowed

abstract val isMergeAllowed: Boolean?

Shows whether the server has indicated that merge is currently allowed.

isSetAllowed

abstract val isSetAllowed: Boolean?

Shows whether the server has indicated that set is currently allowed.

linkExtractor

abstract val linkExtractor: LinkExtractor

Extracts links from responses.

response

abstract val response: TEntity?

A cached copy of the entity as received from the server.

serializers

abstract val serializers: List<Serializer>

A list of serializers used for entities received from the server, sorted from most to least preferred. Always uses first for sending to the server.

uri

abstract val uri: URI

The HTTP URI of the remote resource.

Functions

delete

abstract fun delete()

Deletes the element.

exists

abstract fun exists(): Boolean

Determines whether the element currently exists.

getLinks

abstract fun getLinks(rel: String): List<Pair<URI, String?>>

Resolves all links with a specific relation type. Uses cached data from last response.

link

abstract fun link(rel: String): URI

Resolves a single link with a specific relation type. Uses cached data from last response if possible.

linkTemplate

abstract fun linkTemplate(rel: String, variables: Map<String, Any>): URI

Resolves a link template with a specific relation type. Uses cached data from last response if possible.

merge

abstract fun merge(entity: TEntity): TEntity?

Modifies an existing entity by merging changes on the server-side.

read

abstract fun read(): TEntity

Returns the entity.

set

abstract fun set(entity: TEntity): TEntity?

Sets/replaces the entity.

update

abstract fun update(updateAction: (TEntity) -> TEntity, maxRetries: Int = 3): TEntity?

Reads the current state of the entity, applies a change to it and stores the result. Applies optimistic concurrency using automatic retries.