typedrest/net.typedrest.endpoints.rpc/FunctionEndpointImpl

FunctionEndpointImpl

open class FunctionEndpointImpl<TEntity, TResult>(referrer: Endpoint, relativeUri: URI, entityType: Class<TEntity>, resultType: Class<TResult>) : AbstractRpcEndpoint, FunctionEndpoint<TEntity, TResult>

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

Parameters

referrer

The endpoint used to navigate to this one.

relativeUri

The URI of this endpoint relative to the referrer's. Add a ./ prefix here to imply a trailing slash on referrer's URI.

entityType

The type of entity the endpoint takes as input.

resultType

The type of entity the endpoint returns as output.

TEntity

The type of entity the endpoint takes as input.

TResult

The type of entity the endpoint returns as output.

Constructors

FunctionEndpointImpl

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

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

Creates a new function endpoint.

Properties

errorHandler

open override val errorHandler: ErrorHandler

httpClient

open override val httpClient: OkHttpClient

isInvokeAllowed

open override val isInvokeAllowed: Boolean?

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

linkExtractor

open override val linkExtractor: LinkExtractor

serializers

open override val serializers: List<Serializer>

uri

open override val uri: URI

Functions

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.

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.

invoke

open override fun invoke(entity: TEntity): TResult

RpcEndpoint

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.

probe

open override fun probe()

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

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.

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.