io.micronaut.http.server.exceptions.response.ErrorContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-http-server Show documentation
Natively Cloud Native
The newest version!
/*
 * Copyright 2017-2021 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.http.server.exceptions.response;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.http.HttpRequest;

import java.util.List;
import java.util.Optional;

/**
 * Contains methods to obtain {@link Error} and {@link Throwable} from an {@link HttpRequest}.
 */
public interface ErrorContext {

    /**
     * @return The request that caused the error
     */
    @NonNull
    HttpRequest getRequest();

    /**
     * @return The optional root cause exception
     */
    @NonNull
    Optional getRootCause();

    /**
     * @return The errors
     */
    @NonNull
    List getErrors();

    /**
     * @return True if there are errors present
     */
    default boolean hasErrors() {
        return !getErrors().isEmpty();
    }

    /**
     * Create a new context builder.
     *
     * @param request        The request
     * @return A new context builder
     */
    @NonNull
    static Builder builder(@NonNull HttpRequest request) {
        return DefaultErrorContext.builder(request);
    }

    /**
     * A builder for a {@link ErrorContext}.
     *
     * @author James Kleeh
     * @since 2.4.0
     */
    interface Builder {

        /**
         * Sets the root cause of the error(s).
         *
         * @param cause The root cause
         * @return This builder instance
         */
        @NonNull
        ErrorContext.Builder cause(@Nullable Throwable cause);

        /**
         * Adds an error to the context for the given message.
         *
         * @param message The message
         * @return This builder instance
         */
        @NonNull
        ErrorContext.Builder errorMessage(@NonNull String message);

        /**
         * Adds an error to the context.
         *
         * @param error The message
         * @return This builder instance
         */
        @NonNull
        ErrorContext.Builder error(@NonNull Error error);

        /**
         * Adds errors to the context for the given messages.
         *
         * @param errors The errors
         * @return This builder instance
         */
        @NonNull
        ErrorContext.Builder errorMessages(@NonNull List errors);

        /**
         * Adds the errors to the context.
         *
         * @param errors The errors
         * @return This builder instance
         */
        @NonNull
        ErrorContext.Builder errors(@NonNull List errors);

        /**
         * Builds the context.
         *
         * @return A new context
         */
        @NonNull
        ErrorContext build();
    }
}