typedrest-reactive/net.typedrest.endpoints.reactive/PollingEndpointImpl

PollingEndpointImpl

open class PollingEndpointImpl<TEntity : Any>(referrer: Endpoint, relativeUri: URI, entityType: Class<TEntity>, endCondition: (TEntity) -> Boolean? = null) : ElementEndpointImpl<TEntity> , PollingEndpoint<TEntity>

Endpoint for a resource that can be polled for state changes.

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.

endCondition

A check to determine whether the entity has reached its final state and no further polling is required.

Type Parameters

TEntity

The type of entity the endpoint represents.

Constructors

PollingEndpointImpl

constructor(referrer: Endpoint, relativeUri: URI, entityType: Class<TEntity>, endCondition: (TEntity) -> Boolean? = null)

constructor(referrer: Endpoint, relativeUri: String, entityType: Class<TEntity>, endCondition: (TEntity) -> Boolean? = null)

Creates a new polling endpoint.

Properties

open override val errorHandler: ErrorHandler

open override val httpClient: OkHttpClient

isDeleteAllowed

open override val isDeleteAllowed: Boolean?

open override val isMergeAllowed: Boolean?

open override val isSetAllowed: Boolean?

open override val linkExtractor: LinkExtractor

pollingInterval

open override var pollingInterval: Duration

Interval in which requests are sent to the server. The server may update this interval via the Retry-After response header.

open override val response: TEntity?

open override var responseCache: ResponseCache?

open override val serializers: List<Serializer>

open override val uri: URI

Functions

open override fun delete()

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

deserializeList

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

open override fun exists(): Boolean

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

getLinkTemplate

fun getLinkTemplate(rel: String): com/damnhandy/uri/template/UriTemplate

open override fun getObservable(): Observable<TEntity>

Returns an Observable stream of entity states. Consecutive items are emitted only when the server-supplied entity differs from the previously emitted one according to Any.equals.

open override fun link(rel: String): URI

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

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

open override fun read(): TEntity

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

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

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

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

setDefaultLinkTemplate

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

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