io.micronaut.http.server.exceptions.response.ErrorResponseBodyProvider 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-2024 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.http.HttpResponse;

/**
 * Provides an HTTP Response body of an error response.
 * @author Sergio del Amo
 * @since 4.7.0
 * @param  The body type
 */
public interface ErrorResponseBodyProvider {
    /**
     *
     * @param errorContext Error Context
     * @param response Base HTTP Response
     * @return The HTTP Response Body
     */
    @NonNull
    T body(@NonNull ErrorContext errorContext, @NonNull HttpResponse response);

    /**
     * @return The content type of the HTTP response
     */
    @NonNull
    String contentType();

}