me.alidg.errors.HttpError Maven / Gradle / Ivy

Go to download
package me.alidg.errors;

import org.springframework.http.HttpStatus;
import org.springframework.lang.NonNull;
import org.springframework.lang.Nullable;

import java.util.Collections;
import java.util.List;
import java.util.Objects;

/**
 * Represents the error details that should be serialized inside a HTTP
 * response body.
 *
 * @author Ali Dehghani
 */
public class HttpError {

    /**
     * Collection of error codes alongside with their corresponding messages.
     */
    private final List errors;

    /**
     * The expected status code for the HTTP response.
     */
    private final HttpStatus httpStatus;

    /**
     * Unique fingerprint of the error.
     */
    @Nullable
    private String fingerprint;

    /**
     * Encapsulates the current and probably failed HTTP request. It's either a
     * {@link org.springframework.web.context.request.WebRequest} for Servlet requests
     * or {@link org.springframework.web.reactive.function.server.ServerRequest} for reactive
     * stack requests.
     */
    @Nullable
    private Object request;

    /**
     * Encapsulates the original exception raised while processing the HTTP request.
     */
    @Nullable
    private Throwable originalException;

    /**
     * Encapsulates the possible refined exception, if any.
     */
    @Nullable
    private Throwable refinedException;

    /**
     * Constructing a HTTP error instance.
     *
     * @param errors     Collection of codes/messages combinations.
     * @param httpStatus The expected status code.
     */
    public HttpError(List errors, HttpStatus httpStatus) {
        this.errors = errors;
        this.httpStatus = httpStatus;
    }

    /**
     * @return Collection of error codes/messages combinations.
     * @see #errors
     */
    public List getErrors() {
        return errors;
    }

    /**
     * Returns the current and probably failed HTTP request. It's either a
     * {@link org.springframework.web.context.request.WebRequest} for Servlet requests
     * or {@link org.springframework.web.reactive.function.server.ServerRequest} for reactive
     * stack requests.
     *
     * @return The current HTTP request.
     */
    public Object getRequest() {
        return request;
    }

    /**
     * @param request {@link #request}.
     */
    public void setRequest(Object request) {
        this.request = request;
    }

    /**
     * @return The original exception raised while processing the HTTP request.
     */
    public Throwable getOriginalException() {
        return originalException;
    }

    /**
     * @param originalException {@link #originalException}.
     */
    public void setOriginalException(Throwable originalException) {
        this.originalException = originalException;
    }

    /**
     * @return The possible refined exception, if any.
     */
    public Throwable getRefinedException() {
        return refinedException;
    }

    /**
     * @param refinedException {@link #refinedException}.
     */
    public void setRefinedException(Throwable refinedException) {
        this.refinedException = refinedException;
    }

    /**
     * @return The expected status code.
     * @see #httpStatus
     */
    public HttpStatus getHttpStatus() {
        return httpStatus;
    }

    /**
     * @return Error fingerprint. Helpful as a correlation ID.
     * @see #fingerprint
     */
    public String getFingerprint() {
        return fingerprint;
    }

    /**
     * @param fingerprint {@link #fingerprint}.
     */
    public void setFingerprint(String fingerprint) {
        this.fingerprint = fingerprint;
    }

    @Override
    public String toString() {
        return "HttpError{" +
            "errors=" + errors +
            ", httpStatus=" + httpStatus +
            ", fingerprint=" + fingerprint +
            '}';
    }

    /**
     * Represents an error code paired with its appropriate error message and exception arguments.
     */
    public static class CodedMessage {

        /**
         * The error code.
         */
        private final String code;

        /**
         * The error message.
         */
        private final String message;

        /**
         * Exception arguments.
         */
        private final List arguments;

        /**
         * Constructs a code-message pair along with possible arguments.
         *
         * @param code      The error code.
         * @param message   The error message.
         * @param arguments Exception arguments.
         */
        public CodedMessage(@NonNull String code, String message, @NonNull List arguments) {
            this.code = Objects.requireNonNull(code, "The error code is required");
            this.message = message;
            this.arguments = Objects.requireNonNull(arguments, "Arguments can not be null");
        }

        /**
         * @return The error code.
         * @see #code
         */
        public String getCode() {
            return code;
        }

        /**
         * @return The error message.
         * @see #message
         */
        public String getMessage() {
            return message;
        }

        /**
         * @return Exception arguments.
         * @see #arguments
         */
        public List getArguments() {
            return Collections.unmodifiableList(arguments);
        }

        @Override
        public boolean equals(Object o) {
            if (this == o)
                return true;

            if (!(o instanceof CodedMessage)) return false;

            CodedMessage that = (CodedMessage) o;
            return Objects.equals(getCode(), that.getCode()) &&
                Objects.equals(getMessage(), that.getMessage()) &&
                Objects.equals(getArguments(), that.getArguments());
        }

        @Override
        public int hashCode() {
            return Objects.hash(getCode(), getMessage(), getArguments());
        }

        @Override
        public String toString() {
            return "CodedMessage{" +
                "code='" + code + '\'' +
                ", message='" + message + '\'' +
                ", arguments=" + arguments +
                '}';
        }
    }
}