Class ErrorMap

All Implemented Interfaces:

public class ErrorMap extends Object implements Comparable<ErrorMap>
The 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.

  • Constructor Details

    • ErrorMap

      public ErrorMap(int version, int revision, Map<String,ErrorMap.ErrorCode> errors)
      Creates a new Error Map, usually called from jackson.
      version - the error map version.
      revision - the error map revision.
      errors - the full error section.
  • Method Details