Package de.pisa.psa.rst.obj

Enum-Klasse PsaRstApiErrCod

java.lang.Object

java.lang.Enum<PsaRstApiErrCod>

de.pisa.psa.rst.obj.PsaRstApiErrCod

Alle implementierten Schnittstellen:

Serializable, Comparable<PsaRstApiErrCod>, Constable

public enum PsaRstApiErrCod
extends Enum<PsaRstApiErrCod>

REST API: error codes

Seit:

23.05.2023

Autor:

weiland

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	PsaRstApiErrCod.CustomStatus	Custom HTTP response status

Von Klasse geerbte verschachtelte Klassen/Schnittstellen java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum-Konstanten - Übersicht

Enum-Konstanten

Enum-Konstante	Beschreibung
CHECK_FAILED	[422] data validation failed
CONFIGURATION_AMBIGUOUS	[400] configuration ambiguous
CONFIGURATION_NOT_FOUND	[400] configuration not found
CREDENTIALS_AMBIGUOUS	[401] ambiguous credentials
CREDENTIALS_AUTH_MISSING	[401] authentication missing
CREDENTIALS_INVALID	[401] invalid credentials
CREDENTIALS_UNKNOWN_USER	[401] unknown user
INVALID_DATA	[400] invalid data
INVALID_FIELD	[400] invalid data object field
INVALID_ID	[400] invalid ID
JSON_PROCESSING_ERROR	[400] JSON processing error
MISSING_DATA	[400] missing data
MISSING_QUERY_BODY	[400] missing body
RECORD_ACCESS_NO_DELETE	[403] no delete access on the record
RECORD_ACCESS_NO_INSERT	[403] no insert access granted
RECORD_ACCESS_NO_READ	[403] no read access on the record
RECORD_ACCESS_NO_WRITE	[403] no write access on the record
RECORD_AMBIGUOUS	[404] record ambiguous
RECORD_NOT_FOUND	[404] record not found
UNEXPECTED_ERROR	[500] unexpected error
USER_UNKNOWN	[403] no read access on the record

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
PsaRstApiErrFac	factory()	create a factory for this error
String	getCode()	get the error code
String	getMessage()	get the error message
javax.ws.rs.core.Response.StatusType	getStatus()	get the associated status code
static PsaRstApiErrCod	valueOf(String name)	Gibt die Enum-Konstante dieser Klasse mit dem angegebenen Namen zurück.
static PsaRstApiErrCod[]	values()	Gibt ein Array mit den Konstanten dieser Enum-Klasse in der Reihenfolge ihrer Deklaration zurück.

Von Klasse geerbte Methoden java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Von Klasse geerbte Methoden java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum-Konstanten - Details

INVALID_ID

public static final PsaRstApiErrCod INVALID_ID

[400] invalid ID

MISSING_QUERY_BODY

public static final PsaRstApiErrCod MISSING_QUERY_BODY

[400] missing body

CONFIGURATION_NOT_FOUND

public static final PsaRstApiErrCod CONFIGURATION_NOT_FOUND

[400] configuration not found

CONFIGURATION_AMBIGUOUS

public static final PsaRstApiErrCod CONFIGURATION_AMBIGUOUS

[400] configuration ambiguous

INVALID_FIELD

public static final PsaRstApiErrCod INVALID_FIELD

[400] invalid data object field

MISSING_DATA

public static final PsaRstApiErrCod MISSING_DATA

[400] missing data

INVALID_DATA

public static final PsaRstApiErrCod INVALID_DATA

[400] invalid data

JSON_PROCESSING_ERROR

public static final PsaRstApiErrCod JSON_PROCESSING_ERROR

[400] JSON processing error

CREDENTIALS_INVALID

public static final PsaRstApiErrCod CREDENTIALS_INVALID

[401] invalid credentials

CREDENTIALS_AUTH_MISSING

public static final PsaRstApiErrCod CREDENTIALS_AUTH_MISSING

[401] authentication missing

CREDENTIALS_AMBIGUOUS

public static final PsaRstApiErrCod CREDENTIALS_AMBIGUOUS

[401] ambiguous credentials

CREDENTIALS_UNKNOWN_USER

public static final PsaRstApiErrCod CREDENTIALS_UNKNOWN_USER

[401] unknown user

RECORD_ACCESS_NO_READ

public static final PsaRstApiErrCod RECORD_ACCESS_NO_READ

[403] no read access on the record

RECORD_ACCESS_NO_WRITE

public static final PsaRstApiErrCod RECORD_ACCESS_NO_WRITE

[403] no write access on the record

RECORD_ACCESS_NO_DELETE

public static final PsaRstApiErrCod RECORD_ACCESS_NO_DELETE

[403] no delete access on the record

RECORD_ACCESS_NO_INSERT

public static final PsaRstApiErrCod RECORD_ACCESS_NO_INSERT

[403] no insert access granted

USER_UNKNOWN

public static final PsaRstApiErrCod USER_UNKNOWN

[403] no read access on the record

RECORD_NOT_FOUND

public static final PsaRstApiErrCod RECORD_NOT_FOUND

[404] record not found

RECORD_AMBIGUOUS

public static final PsaRstApiErrCod RECORD_AMBIGUOUS

[404] record ambiguous

CHECK_FAILED

public static final PsaRstApiErrCod CHECK_FAILED

[422] data validation failed

UNEXPECTED_ERROR

public static final PsaRstApiErrCod UNEXPECTED_ERROR

[500] unexpected error

Methodendetails

values

public static PsaRstApiErrCod[] values()

Gibt ein Array mit den Konstanten dieser Enum-Klasse in der Reihenfolge ihrer Deklaration zurück.

Gibt zurück:

ein Array mit den Konstanten dieser Enum-Klasse in der Reihenfolge ihrer Deklaration

valueOf

public static PsaRstApiErrCod valueOf(String name)

Gibt die Enum-Konstante dieser Klasse mit dem angegebenen Namen zurück. Die Zeichenfolge muss exakt mit einer ID übereinstimmen, mit der eine Enum-Konstante in dieser Klasse deklariert wird. (Zusätzliche Leerzeichen sind nicht zulässig.)

Parameter:

name - Name der zurückzugebenden Enumerationskonstante.

Gibt zurück:

Enumerationskonstante mit dem angegebenen Namen

Löst aus:

IllegalArgumentException - wenn diese Enum-Klasse keine Konstante mit dem angegebenen Namen enthält

NullPointerException - wenn das Argument nicht angegeben wird

getCode

public String getCode()

get the error code

Gibt zurück:

code

getMessage

public String getMessage()

get the error message

Gibt zurück:

message

getStatus

public javax.ws.rs.core.Response.StatusType getStatus()

get the associated status code

Gibt zurück:

status

factory

public PsaRstApiErrFac factory()

create a factory for this error

Gibt zurück:

factory