io.werval.api

Interface Errors

All Superinterfaces:

Iterable< Error>

public interface Errors
extends Iterable<Error>

Application errors.

Records errors happening in the application.

To prevent OOME when errors are frequent, it is possible to limit the amount of recorded errors with the `werval.errors.max` configuration property. This default to 100.

Errors is an Iterable<Error>. Implementations are required to provide predictible and sorted iteration starting with the last error and ending with the oldest recorded error.

Method Summary

Modifier and Type	Method and Description
List<Error>	asList() Get a list of all Errors.
void	clear() Clear recorded errors.
int	count()
Optional<Error>	get(String errorId) Get an Error by its identity.
Optional<Error>	last() Get last recorded Error.
Optional<Error>	lastOfRequest(String requestIdentity) Get last recorder error pertaining to a given request.
List<Error>	ofRequest(String requestId) Get a List<Error> containing only Errors pertaining to a given request.
Error	record(String requestId, String message, Throwable cause) Record a new Error.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

asList

List<Error> asList()

Get a list of all Errors.

Returns:

Immutable list of all Errors.

record

Error record(String requestId,
             String message,
             Throwable cause)

Record a new Error.

Parameters:

requestId - Request identitity

message - Error message

cause - Cause

Returns:

the recorded Error

count

int count()

Returns:

Count of recorded errors

clear

void clear()

Clear recorded errors.

get

Optional<Error> get(String errorId)

Get an Error by its identity.

Parameters:

errorId - Error identity

Returns:

Error, optional

last

Optional<Error> last()

Get last recorded Error.

Returns:

Last recorded Error, optional

ofRequest

List<Error> ofRequest(String requestId)

Get a List<Error> containing only Errors pertaining to a given request.

Parameters:

requestId - Request identity

Returns:

All recorded Errors pertaining to the given request

lastOfRequest

Optional<Error> lastOfRequest(String requestIdentity)

Get last recorder error pertaining to a given request.

Parameters:

requestIdentity - Request identity

Returns:

Last recorded Error pertaining to the given request, optional