oid4vcwallet/dev.idfoundry.oid4vcwallet/WalletException

WalletException

class WalletException : Exception(source)

An error from OID4VCgo: a stable code, the issuer's, Authorization Server's or Verifier's own error code when it gave one (protocolError), and a message for logs: it never carries personal data, a remote party's own description, a URL's path or query, or control characters. description is a sentence fit to show the holder; isRetryable says whether trying the same step again may succeed.

Types

Code

@JvmInline

value class Code(val rawValue: String)

An error code, as the Go side names it.

Properties

cause

open val cause: Throwable?

code

val code: WalletException.Code

What kind of failure this is: stable across releases, so an app can act on it.

description

val description: String

A sentence fit to show the holder.

isRetryable

val isRetryable: Boolean

Whether the same step may succeed if tried again: the network failed or timed out, the service was unavailable, the issuer refused the PIN (invalid_grant, up to its limit) or a stale nonce (invalid_nonce: a retry fetches a fresh one), or asked to be tried later.

message

open override val message: String

Detail for logs: it never carries personal data, a remote party's own description, or a URL's path or query.

protocolError

val protocolError: String?

The remote party's OAuth error code, such as invalid_grant (a wrong PIN) or access_denied, when it gave one.

Functions

toString

open override fun toString(): String

The code, the remote party's error code if any, and the message, for logs.