public class ErrorMap extends Object implements Comparable<ErrorMap>
ErrorMap
contains mappings from errors to their attributes, negotiated
between the client and the server.
From the documentation:
An Error Map is a mapping of error to their attributes and properties. It is used by
connected clients to handle error codes which they may otherwise not be aware of.
The error map solves the problem where clients would incorrectly handle newer error codes,
and/or where the server would disconnect the client because it needed to send it a new error code.
The solution via Error Map is to establish a contract between client and server about certain
attributes which each error code may have. These attributes indicate whether an error may be
passed through, whether the command is retriable and so on. When a client receives an error code
it does not know about it, it can look up its attributes and then determine the next course of
action.Modifier and Type | Class and Description |
---|---|
static class |
ErrorMap.ErrorAttribute |
static class |
ErrorMap.ErrorCode |
static class |
ErrorMap.RetrySpecification |
static class |
ErrorMap.RetryStrategy |
Constructor and Description |
---|
ErrorMap(int version,
int revision,
Map<String,ErrorMap.ErrorCode> errors) |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(ErrorMap o) |
Map<Short,ErrorMap.ErrorCode> |
errors() |
static ErrorMap |
fromJson(String json) |
int |
revision() |
String |
toString() |
int |
version() |
public ErrorMap(int version, int revision, Map<String,ErrorMap.ErrorCode> errors)
public static ErrorMap fromJson(String json) throws IOException
IOException
public int compareTo(ErrorMap o)
compareTo
in interface Comparable<ErrorMap>
public int version()
public int revision()
public Map<Short,ErrorMap.ErrorCode> errors()
Copyright © 2021 Couchbase, Inc.. All rights reserved.