ProducerEndpoint

RPC endpoint that takes no input and returns TResult as output when invoked.

TResult

The type of entity the endpoint returns as output.

Properties

Handles errors in responses.

abstract val httpClient: OkHttpClient

The HTTP client used to communicate with the remote resource.

Indicates whether the server has specified the invoke method is currently allowed.

Extracts links from responses.

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.

abstract val uri: URI

The HTTP URI of the remote resource.

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

abstract fun invoke(): TResult

Gets a result from the producer.

abstract fun link(rel: String): URI

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

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.

abstract fun probe()

Queries the server about capabilities of the endpoint without performing any action.