Package de.pisa.psa.rst.obj

Enum Class PsaRstApiErrCod

java.lang.Object

java.lang.Enum<PsaRstApiErrCod>

de.pisa.psa.rst.obj.PsaRstApiErrCod

All Implemented Interfaces:

Serializable, Comparable<PsaRstApiErrCod>, Constable

public enum PsaRstApiErrCod
extends Enum<PsaRstApiErrCod>

REST API: error codes

Since:

23.05.2023

Author:

weiland

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PsaRstApiErrCod.CustomStatus	Custom HTTP response status

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
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] ambiguous unknown
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

Method Summary

Modifier and Type	Method	Description
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)	Returns the enum constant of this class with the specified name.
static PsaRstApiErrCod[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant 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] ambiguous unknown

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

Method Details

values

public static PsaRstApiErrCod[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PsaRstApiErrCod valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getCode

public String getCode()

get the error code

Returns:

code

getMessage

public String getMessage()

get the error message

Returns:

message

getStatus

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

get the associated status code

Returns:

status

factory

public PsaRstApiErrFac factory()

create a factory for this error

Returns:

factory