typedrest-reactive/net.typedrest.endpoints.reactive/StreamingCollectionEndpointImpl

StreamingCollectionEndpointImpl

open class StreamingCollectionEndpointImpl<TEntity : Any> : GenericStreamingCollectionEndpointImpl<TEntity, ElementEndpoint<TEntity>> , StreamingCollectionEndpoint<TEntity>

Endpoint for a collection of TEntitys observable as an append-only stream using long-polling.

Use GenericStreamingCollectionEndpointImpl instead if you wish to customize the element endpoint type.

Type Parameters

TEntity

The type of individual elements in the collection.

Constructors

StreamingCollectionEndpointImpl

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

Creates a new element collection endpoint.

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

Creates a new element collection endpoint.

Properties

createAllAllowed

open override val createAllAllowed: Boolean?

createAllowed

open override val createAllowed: Boolean?

errorHandler

open override val errorHandler: ErrorHandler

httpClient

open override val httpClient: OkHttpClient

linkExtractor

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.

rangeUnit

var rangeUnit: String

readAllAllowed

open override val readAllAllowed: Boolean?

readRangeAllowed

open override var readRangeAllowed: Boolean?

responseCache

open override var responseCache: ResponseCache?

serializers

open override val serializers: List<Serializer>

setAllAllowed

open override val setAllAllowed: Boolean?

uri

open override val uri: URI

Functions

create

open override fun create(entity: TEntity): ElementEndpoint<TEntity>?

createAll

open override fun createAll(entities: Iterable<TEntity>)

deserialize

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

deserializeList

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

get

open operator override fun get(entity: TEntity): ElementEndpoint<TEntity>

operator fun get(id: String): ElementEndpoint<TEntity>

getLinks

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

getLinkTemplate

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

getObservable

open override fun getObservable(startIndex: Long = 0): Observable<TEntity>

Provides an observable stream of elements.

link

open override fun link(rel: String): URI

linkTemplate

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

readAll

open override fun readAll(): List<TEntity>

readRange

open override fun readRange(from: Long?, to: Long?): PartialResponse<TEntity>

serialize

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

serializeList

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

setAll

open override fun setAll(entities: Iterable<TEntity>)

setDefaultLink

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

setDefaultLinkTemplate

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