typedrest-reactive/net.typedrest.endpoints.reactive/GenericStreamingCollectionEndpointImpl

GenericStreamingCollectionEndpointImpl

open class GenericStreamingCollectionEndpointImpl<TEntity : Any, TElementEndpoint : ElementEndpoint<TEntity>>(referrer: Endpoint, relativeUri: URI, entityType: Class<TEntity>, elementEndpointFactory: (referrer: Endpoint, relativeUri: URI) -> TElementEndpoint) : GenericCollectionEndpointImpl<TEntity, TElementEndpoint> , GenericStreamingCollectionEndpoint<TEntity, TElementEndpoint>

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

Use the more constrained StreamingCollectionEndpointImpl when possible.

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 individual elements in the collection.

elementEndpointFactory

The factory for constructing TElementEndpoints to provide for individual elements.

Type Parameters

TEntity

The type of individual elements in the collection.

TElementEndpoint

The type of ElementEndpoint to provide for individual TEntitys.

Inheritors

StreamingCollectionEndpointImpl

Constructors

GenericStreamingCollectionEndpointImpl

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

constructor(referrer: Endpoint, relativeUri: String, entityType: Class<TEntity>, elementEndpointFactory: (referrer: Endpoint, relativeUri: URI) -> TElementEndpoint)

Creates a new streaming collection endpoint.

Properties

createAllAllowed

open override val createAllAllowed: Boolean?

open override val createAllowed: Boolean?

open override val errorHandler: ErrorHandler

open override val httpClient: OkHttpClient

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.

var rangeUnit: String

open override val readAllAllowed: Boolean?

readRangeAllowed

open override var readRangeAllowed: Boolean?

open override var responseCache: ResponseCache?

open override val serializers: List<Serializer>

open override val setAllAllowed: Boolean?

open override val uri: URI

Functions

open override fun create(entity: TEntity): TElementEndpoint?

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

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

deserializeList

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

open operator override fun get(entity: TEntity): TElementEndpoint

operator fun get(id: String): TElementEndpoint

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

getLinkTemplate

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

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

Provides an observable stream of elements.

open override fun link(rel: String): URI

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

open override fun readAll(): List<TEntity>

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

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

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

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

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

setDefaultLinkTemplate

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