Karbone/com.ekino.oss.karbone/KarboneError

KarboneError

sealed interface KarboneError

Every way a Karbone call can fail, as a value.

Inheritors

Types

Api

sealed interface Api : KarboneError

Errors reported by the Carbone API. message is the raw error text from the response, never rewritten.

BadRequest

data class BadRequest(val status: Int, val message: String?, val code: String? = null) : KarboneError.Api

HTTP 400 or 422: rejected metadata, invalid JSON, missing field, empty template...

Companion

object Companion

InvalidRequest

data class InvalidRequest(val reason: String) : KarboneError

A request rejected client-side before any call.

PayloadTooLarge

data class PayloadTooLarge(val message: String?, val status: Int = HTTP_PAYLOAD_TOO_LARGE, val code: String? = null) : KarboneError.Api

HTTP 413: the template or document sent exceeds Carbone's size limit.

RenderFailed

data class RenderFailed(val message: String?, val status: Int = HTTP_SERVER_ERROR, val code: String? = null) : KarboneError.Api

HTTP 500 on a render endpoint.

RenderNotFound

data class RenderNotFound(val id: RenderId, val message: String?, val status: Int = HTTP_NOT_FOUND, val code: String? = null) : KarboneError.Api

HTTP 404 when the requested render id is unknown, expired, or already downloaded once.

Serialization

data class Serialization(val cause: Throwable, val body: String?) : KarboneError

A response body that could not be parsed.

TemplateNotFound

data class TemplateNotFound(val id: TemplateId, val message: String?, val status: Int = HTTP_NOT_FOUND, val code: String? = null) : KarboneError.Api

HTTP 404 when the requested template id is unknown to Carbone.

TemplateRead

data class TemplateRead(val source: TemplateSource.Content, val cause: Throwable) : KarboneError

Local template content could not be read.

Transport

data class Transport(val cause: Throwable) : KarboneError

Connection, timeout or I/O failure.

Unauthorized

data class Unauthorized(val message: String?, val status: Int = HTTP_UNAUTHORIZED, val code: String? = null) : KarboneError.Api

HTTP 401, or a malformed bearer token (carbone-ee answers HTTP 500 "Invalid JSON Web Token").

Unexpected

data class Unexpected(val status: Int, val message: String?, val body: String?, val code: String? = null) : KarboneError.Api

Any other non-2xx status, or a 2xx with success: false.

UnsupportedTemplateFormat

data class UnsupportedTemplateFormat(val message: String?, val status: Int = HTTP_UNSUPPORTED_MEDIA, val code: String? = null) : KarboneError.Api

HTTP 415: Carbone cannot process the template's file format.

Functions

describe

abstract fun describe(): String

Human-readable summary of this error, used as the message of KarboneException.