typedrest/net.typedrest.endpoints/EntryEndpoint

EntryEndpoint

open class EntryEndpoint : AbstractEndpoint

Represents the top-level URI of an API. Derive from this open class and add your own set of child Endpoints as properties.

Constructors

constructor(uri: URI, httpClient: OkHttpClient, serializers: List<Serializer>, errorHandler: ErrorHandler = DefaultErrorHandler(), linkExtractor: LinkExtractor = AggregateLinkExtractor(HeaderLinkExtractor(), HalLinkExtractor()))

Creates a new entry endpoint.

constructor(uri: URI, httpClient: OkHttpClient, serializer: Serializer = KotlinxJsonSerializer(), errorHandler: ErrorHandler = DefaultErrorHandler(), linkExtractor: LinkExtractor = AggregateLinkExtractor(HeaderLinkExtractor(), HalLinkExtractor()))

Creates a new entry endpoint.

constructor(uri: URI, credentials: HttpCredentials? = null, serializer: Serializer = KotlinxJsonSerializer(), errorHandler: ErrorHandler = DefaultErrorHandler(), linkExtractor: LinkExtractor = AggregateLinkExtractor(HeaderLinkExtractor(), HalLinkExtractor()))

Creates a new entry endpoint.

Properties

open override val errorHandler: ErrorHandler

open override val httpClient: OkHttpClient

open override val linkExtractor: LinkExtractor

open override val serializers: List<Serializer>

open override val uri: URI

Functions

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.

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.

open override fun link(rel: String): URI

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

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.

Fetches metadata such as links from the server.

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

Serializes an entity using the first serializer.

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

Serializes a list of entities using the first serializer.

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.