com.palantir.conjure.java.api.errors

Class SerializableError

java.lang.Object

com.palantir.conjure.java.api.errors.SerializableError

All Implemented Interfaces:

java.io.Serializable

@Value.Immutable
public abstract class SerializableError
extends java.lang.Object
implements java.io.Serializable

A JSON-serializable representation of an exception/error, represented by its error code, an error name identifying the (specific sub-) type of error, an optional set of named parameters detailing the error condition. Intended to transport errors through RPC channels such as HTTP responses.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SerializableError.Builder

Constructor Summary

Constructors

Constructor and Description
SerializableError()

Method Summary

Modifier and Type	Method and Description
static SerializableError.Builder	builder()
java.lang.String	errorCode() A fixed code word identifying the type of error.
java.lang.String	errorInstanceId() A unique identifier for this error instance, typically used to correlate errors displayed in user-facing applications with richer backend-level error information.
java.lang.String	errorName() A fixed name identifying the error.
static SerializableError	forException(ServiceException exception) Creates a SerializableError representation of this exception that derives from the error code and message, as well as the safe and unsafe parameters.
abstract java.util.Map<java.lang.String,java.lang.String>	parameters() A set of parameters that further explain the error.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SerializableError

public SerializableError()

Method Detail

errorCode

@Value.Default
public java.lang.String errorCode()

A fixed code word identifying the type of error. For errors generated from ServiceException, this corresponds to the ErrorType.code() and is part of the service's API surface. Clients are given access to the server-side error code via RemoteException.getError() and typically switch&dispatch on the error code and/or name.

errorName

@Value.Default
public java.lang.String errorName()

A fixed name identifying the error. For errors generated from ServiceException, this corresponding to the ErrorType.name() and is part of the service's API surface. Clients are given access to the service-side error name via RemoteException.getError() and typically switch&dispatch on the error code and/or name.

errorInstanceId

@Value.Default
public java.lang.String errorInstanceId()

A unique identifier for this error instance, typically used to correlate errors displayed in user-facing applications with richer backend-level error information. In contrast to errorCode() and errorName(), the errorInstanceId() identifies a specific occurrence of an error, not a class of errors. By convention, this field is a UUID.

parameters

public abstract java.util.Map<java.lang.String,java.lang.String> parameters()

A set of parameters that further explain the error.

forException

public static SerializableError forException(ServiceException exception)

Creates a SerializableError representation of this exception that derives from the error code and message, as well as the safe and unsafe parameters.

builder

public static SerializableError.Builder builder()