Package io.kvision.rest

RESTful API client with support for type-safe connectivity.

Types

BadGateway

class BadGateway(url: String, method: HttpMethod, message: String) : RemoteRequestException

BadRequest

class BadRequest(url: String, method: HttpMethod, message: String) : RemoteRequestException

Forbidden

class Forbidden(url: String, method: HttpMethod, message: String) : RemoteRequestException

HttpMethod

enum HttpMethod : Enum<HttpMethod>

NotAllowed

class NotAllowed(url: String, method: HttpMethod, message: String) : RemoteRequestException

NotFound

class NotFound(url: String, method: HttpMethod, message: String) : RemoteRequestException

NotImplemented

class NotImplemented(url: String, method: HttpMethod, message: String) : RemoteRequestException

RemoteRequestException

open class RemoteRequestException(code: Short, url: String, method: HttpMethod, message: String) : Throwable

Response

data class Response<T>(data: T, textStatus: String, jqXHR: <ERROR CLASS>)

A response wrapper

RestClient

open class RestClient(module: <ERROR CLASS>?)

An agent responsible for remote calls.

ServerError

class ServerError(url: String, method: HttpMethod, message: String) : RemoteRequestException

ServiceUnavailable

class ServiceUnavailable(url: String, method: HttpMethod, message: String) : RemoteRequestException

Unauthorized

class Unauthorized(url: String, method: HttpMethod, message: String) : RemoteRequestException

XHRError

class XHRError(url: String, method: HttpMethod, message: String) : RemoteRequestException

Code 0 does not represent any http status, it represent XHR error (e.g.

Properties

HTTP_BAD_GATEWAY

const val HTTP_BAD_GATEWAY: Short = 502

HTTP_BAD_REQUEST

const val HTTP_BAD_REQUEST: Short = 400

HTTP_FORBIDDEN

const val HTTP_FORBIDDEN: Short = 403

HTTP_NOT_ALLOWED

const val HTTP_NOT_ALLOWED: Short = 405

HTTP_NOT_FOUND

const val HTTP_NOT_FOUND: Short = 404

HTTP_NOT_IMPLEMENTED

const val HTTP_NOT_IMPLEMENTED: Short = 501

HTTP_SERVER_ERROR

const val HTTP_SERVER_ERROR: Short = 500

HTTP_SERVICE_UNAVAILABLE

const val HTTP_SERVICE_UNAVAILABLE: Short = 503

HTTP_UNAUTHORIZED

const val HTTP_UNAUTHORIZED: Short = 401

XHR_ERROR

const val XHR_ERROR: Short = 0