Record Class ProblemDetail

java.lang.Object

java.lang.Record

br.com.xadm.comum.web.ProblemDetail

Record Components:

type - URI do tipo do problema (about:blank por padrão).

title - resumo legível do tipo de erro (ex.: Conflict).

status - código HTTP (ex.: 409).

detail - mensagem específica desta ocorrência.

code - código estável legível por máquina (ex.: CONFLICT, invalid_token).

invalidParams - campos rejeitados (Bean Validation), ou null fora de validação.

public record ProblemDetail(String type, String title, int status, String detail, String code, List<ProblemDetail.InvalidParam> invalidParams)
extends Record

Corpo de erro no formato RFC 7807 / 9457 (application/problem+json) — o padrão da casa para erros de API. Substitui o envelope {message, _links, _embedded} do HateoasErrorResponseProcessor default do Micronaut: apoia-se no padrão IETF, interoperável e tooling-friendly.

Campos 7807: type (URI; about:blank quando não há tipo específico), title (resumo legível do status), status (código HTTP), detail (mensagem específica). O code é uma extensão (membro custom permitido pelo 7807) com o código estável legível por máquina (ex.: CONFLICT, invalid_token).

Serializa via micronaut-serde (serde build-time): o @Serdeable habilita o serializer gerado em tempo de compilação — gerado dentro do jar desta lib.

O membro invalidParams (serializado como invalid-params — extensão do apêndice RFC 7807/9457) lista os campos rejeitados nas falhas de Bean Validation; é null (e omitido do JSON) em qualquer outro erro. A estratégia de nomes KebabCaseStrategy só afeta esse membro composto — os demais são palavra única (kebab = identidade), então o contrato de wire dos campos existentes não muda.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ProblemDetail.InvalidParam	Um campo rejeitado por Bean Validation, no membro invalid-params.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE	Media type RFC 7807.

Constructor Summary

Constructors

Constructor	Description
ProblemDetail(String type, String title, int status, String detail, String code, List<ProblemDetail.InvalidParam> invalidParams)	Creates an instance of a ProblemDetail record class.

Method Summary

Modifier and Type	Method	Description
String	code()	Returns the value of the code record component.
String	detail()	Returns the value of the detail record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
List<ProblemDetail.InvalidParam>	invalidParams()	Returns the value of the invalidParams record component.
static ProblemDetail	of(io.micronaut.http.HttpStatus status, String code, String detail)	Constrói um ProblemDetail a partir do status, do código estável e do detalhe, com o title derivado da razão do status.
static ProblemDetail	of(io.micronaut.http.HttpStatus status, String code, String title, String detail)	Constrói um ProblemDetail com title explícito — usado quando a exceção (PortadoraDeProblema) carrega o título do tipo do problema (RFC 9457 §3.1.4).
static ProblemDetail	ofValidacao(io.micronaut.http.HttpStatus status, String code, String detail, List<ProblemDetail.InvalidParam> invalidParams)	Constrói um ProblemDetail de falha de validação — com a lista de campos rejeitados no membro invalid-params.
int	status()	Returns the value of the status record component.
String	title()	Returns the value of the title record component.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the value of the type record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

Media type RFC 7807.

See Also:

• Constant Field Values

Constructor Details

ProblemDetail

public ProblemDetail(String type,
 String title,
 int status,
 String detail,
 String code,
 List<ProblemDetail.InvalidParam> invalidParams)

Creates an instance of a ProblemDetail record class.

Parameters:

type - the value for the type record component

title - the value for the title record component

status - the value for the status record component

detail - the value for the detail record component

code - the value for the code record component

invalidParams - the value for the invalidParams record component

Method Details

of

public static ProblemDetail of(io.micronaut.http.HttpStatus status,
 String code,
 String detail)

Constrói um ProblemDetail a partir do status, do código estável e do detalhe, com o title derivado da razão do status.

Parameters:

status - status HTTP.

code - código estável legível por máquina.

detail - mensagem específica.

Returns:

o problem-detail montado (type=about:blank, title=razão do status).

of

public static ProblemDetail of(io.micronaut.http.HttpStatus status,
 String code,
 String title,
 String detail)

Constrói um ProblemDetail com title explícito — usado quando a exceção (PortadoraDeProblema) carrega o título do tipo do problema (RFC 9457 §3.1.4).

Parameters:

status - status HTTP.

code - código estável legível por máquina.

title - título do tipo do problema.

detail - mensagem específica da ocorrência.

Returns:

o problem-detail montado (type=about:blank).

ofValidacao

public static ProblemDetail ofValidacao(io.micronaut.http.HttpStatus status,
 String code,
 String detail,
 List<ProblemDetail.InvalidParam> invalidParams)

Constrói um ProblemDetail de falha de validação — com a lista de campos rejeitados no membro invalid-params. title deriva da razão do status.

Parameters:

status - status HTTP (tipicamente BAD_REQUEST).

code - código estável legível por máquina (uniforme, ex.: BAD_REQUEST).

detail - mensagem específica da ocorrência.

invalidParams - campos rejeitados (não-nulo).

Returns:

o problem-detail montado com invalid-params.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

type

public String type()

Returns the value of the type record component.

Returns:

the value of the type record component

title

public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

status

public int status()

Returns the value of the status record component.

Returns:

the value of the status record component

detail

public String detail()

Returns the value of the detail record component.

Returns:

the value of the detail record component

code

public String code()

Returns the value of the code record component.

Returns:

the value of the code record component

invalidParams

public List<ProblemDetail.InvalidParam> invalidParams()

Returns the value of the invalidParams record component.

Returns:

the value of the invalidParams record component