typedrest/net.typedrest.endpoints.generic/ElementEndpointImpl

ElementEndpointImpl

open class ElementEndpointImpl<TEntity>(referrer: Endpoint, relativeUri: URI, entityType: Class<TEntity>) : AbstractCachingEndpoint, ElementEndpoint<TEntity>

Endpoint for an individual resource.

Parameters

referrer

The endpoint used to navigate to this one.

relativeUri

The URI of this endpoint relative to the referrer's.

entityType

The type of entity the endpoint represents.

TEntity

The type of entity the endpoint represents.

Constructors

ElementEndpointImpl

constructor(referrer: Endpoint, relativeUri: URI, entityType: Class<TEntity>)

constructor(referrer: Endpoint, relativeUri: String, entityType: Class<TEntity>)

Creates a new element endpoint.

Properties

errorHandler

open override val errorHandler: ErrorHandler

httpClient

open override val httpClient: OkHttpClient

isDeleteAllowed

open override val isDeleteAllowed: Boolean?

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

isMergeAllowed

open override val isMergeAllowed: Boolean?

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

isSetAllowed

open override val isSetAllowed: Boolean?

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

linkExtractor

open override val linkExtractor: LinkExtractor

response

open override val response: TEntity?

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

responseCache

open override var responseCache: ResponseCache?

A cached copy of the last response.

serializers

open override val serializers: List<Serializer>

uri

open override val uri: URI

Functions

delete

open override fun delete()

Deletes the element.

deserialize

fun <T> deserialize(body: ResponseBody, type: Class<T>): T?

Deserializes an entity using the first serializer that supports the body's content type.

deserializeList

fun <T> deserializeList(body: ResponseBody, type: Class<T>): List<T>?

Deserializes a list of entities using the first serializer that supports the body's content type.

exists

open override fun exists(): Boolean

Determines whether the element currently exists.

getLinks

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

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

getLinkTemplate

fun getLinkTemplate(rel: String): UriTemplate

Retrieves a link template with a specific relation type.

link

open override fun link(rel: String): URI

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

linkTemplate

open override 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

open override fun merge(entity: TEntity): TEntity?

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

read

open override fun read(): TEntity

Returns the entity.

serialize

fun <T> serialize(entity: T, type: Class<T>): RequestBody

Serializes an entity using the first serializer.

serializeList

fun <T> serializeList(entities: Iterable<T>, type: Class<T>): RequestBody

Serializes a list of entities using the first serializer.

set

open override fun set(entity: TEntity): TEntity?

Sets/replaces the entity.

setDefaultLink

fun setDefaultLink(rel: String, href: String?)

Registers one or more default links for a specific relation type.

setDefaultLinkTemplate

fun setDefaultLinkTemplate(rel: String, href: String?)

Registers a default link template for a specific relation type.

update

open override fun update(updateAction: (TEntity) -> TEntity, maxRetries: Int): TEntity?

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