me.alidg.errors

Class HttpError

java.lang.Object

me.alidg.errors.HttpError

public class HttpError
extends Object

Represents the error details that should be serialized inside a HTTP response body.

Author:

Ali Dehghani

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpError.CodedMessage Represents an error code paired with its appropriate error message and exception arguments.

Constructor Summary

Constructors

Constructor and Description
HttpError(List<HttpError.CodedMessage> errors, org.springframework.http.HttpStatus httpStatus) Constructing a HTTP error instance.

Method Summary

Modifier and Type	Method and Description
List<HttpError.CodedMessage>	getErrors()
String	getFingerprint()
org.springframework.http.HttpStatus	getHttpStatus()
Throwable	getOriginalException()
Throwable	getRefinedException()
Object	getRequest() Returns the current and probably failed HTTP request.
void	setFingerprint(String fingerprint)
void	setOriginalException(Throwable originalException)
void	setRefinedException(Throwable refinedException)
void	setRequest(Object request)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpError

public HttpError(List<HttpError.CodedMessage> errors,
                 org.springframework.http.HttpStatus httpStatus)

Constructing a HTTP error instance.

Parameters:

errors - Collection of codes/messages combinations.

httpStatus - The expected status code.

Method Detail

getErrors

public List<HttpError.CodedMessage> getErrors()

Returns:

Collection of error codes/messages combinations.

See Also:

errors

getRequest

public Object getRequest()

Returns the current and probably failed HTTP request. It's either a WebRequest for Servlet requests or ServerRequest for reactive stack requests.

Returns:

The current HTTP request.

setRequest

public void setRequest(Object request)

Parameters:

request - request.

getOriginalException

public Throwable getOriginalException()

Returns:

The original exception raised while processing the HTTP request.

setOriginalException

public void setOriginalException(Throwable originalException)

Parameters:

originalException - originalException.

getRefinedException

public Throwable getRefinedException()

Returns:

The possible refined exception, if any.

setRefinedException

public void setRefinedException(Throwable refinedException)

Parameters:

refinedException - refinedException.

getHttpStatus

public org.springframework.http.HttpStatus getHttpStatus()

Returns:

The expected status code.

See Also:

httpStatus

getFingerprint

public String getFingerprint()

Returns:

Error fingerprint. Helpful as a correlation ID.

See Also:

fingerprint

setFingerprint

public void setFingerprint(String fingerprint)

Parameters:

fingerprint - fingerprint.

toString

public String toString()

Overrides:

toString in class Object