io.micronaut.http.MutableHttpResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-http Show documentation
Natively Cloud Native
The newest version!
/*
 * Copyright 2017-2020 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;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.http.cachecontrol.CacheControl;
import io.micronaut.http.cookie.Cookie;

import java.nio.charset.Charset;
import java.util.Collections;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.function.Consumer;

/**
 * A version of the {@link HttpResponse} interface that is mutable allowing the ability to set headers,
 * character encoding etc.
 *
 * @param  The body response type
 * @author Graeme Rocher
 * @since 1.0
 */
public interface MutableHttpResponse extends HttpResponse, MutableHttpMessage {

    /**
     * Adds the specified cookie to the response.  This method can be called multiple times to set more than one cookie.
     *
     * @param cookie the Cookie to return to the client
     * @return This response object
     */
    MutableHttpResponse cookie(Cookie cookie);

    /**
     * Adds the specified cookies to the response.
     *
     * @param cookies the Set of Cookies to return to the client
     * @return This response object
     */
    default MutableHttpResponse cookies(Set cookies) {
        for (Cookie cookie: cookies) {
            cookie(cookie);
        }
        return this;
    }

    /**
     * Sets the body.
     *
     * @param body The body
     * @return This response object
     */
    @Override
     MutableHttpResponse body(@Nullable T body);

    /**
     * Sets the response status.
     *
     * @param status  The status
     * @param message The message
     * @return This response object
     */
    default MutableHttpResponse status(HttpStatus status, CharSequence message) {
        if (message == null) {
            message = status.getReason();
        }
        return status(status.getCode(), message);
    }

    @Override
    default MutableHttpResponse headers(Consumer headers) {
        return (MutableHttpResponse) MutableHttpMessage.super.headers(headers);
    }

    @Override
    default MutableHttpResponse header(CharSequence name, CharSequence value) {
        return (MutableHttpResponse) MutableHttpMessage.super.header(name, value);
    }

    @Override
    default MutableHttpResponse headers(Map namesAndValues) {
        return (MutableHttpResponse) MutableHttpMessage.super.headers(namesAndValues);
    }

    /**
     * Sets the HTTP Cache-Control header.
     * @param cacheControl Cache Control
     * @return This response object
     * @since 4.9.0
     */
    @NonNull
    default MutableHttpResponse cacheControl(@NonNull CacheControl cacheControl) {
        return header(HttpHeaders.CACHE_CONTROL, Objects.requireNonNull(cacheControl, "Cache Control parameter cannot be null").toString());
    }

    /**
     * Sets the response encoding. Should be called after {@link #contentType(MediaType)}.
     *
     * @param encoding The encoding to use
     * @return This response object
     */
    default MutableHttpResponse characterEncoding(CharSequence encoding) {
        if (encoding != null) {
            getContentType().ifPresent(mediaType ->
                contentType(new MediaType(mediaType.toString(), Collections.singletonMap(MediaType.CHARSET_PARAMETER, encoding.toString())))
            );
        }
        return this;
    }

    /**
     * Sets the response encoding.
     *
     * @param encoding The encoding to use
     * @return The encoded reponse object
     */
    default MutableHttpResponse characterEncoding(Charset encoding) {
        return characterEncoding(encoding.toString());
    }

    @Override
    default MutableHttpResponse contentLength(long length) {
        return (MutableHttpResponse) MutableHttpMessage.super.contentLength(length);
    }

    @Override
    default MutableHttpResponse contentType(CharSequence contentType) {
        return (MutableHttpResponse) MutableHttpMessage.super.contentType(contentType);
    }

    @Override
    default MutableHttpResponse contentType(MediaType mediaType) {
        return (MutableHttpResponse) MutableHttpMessage.super.contentType(mediaType);
    }

    @Override
    default MutableHttpResponse contentEncoding(CharSequence encoding) {
        return (MutableHttpResponse) MutableHttpMessage.super.contentEncoding(encoding);
    }

    /**
     * Sets the locale to use and will apply the appropriate {@link HttpHeaders#CONTENT_LANGUAGE} header to the response.
     *
     * @param locale The locale
     * @return This response object
     */
    default MutableHttpResponse locale(Locale locale) {
        getHeaders().add(HttpHeaders.CONTENT_LANGUAGE, locale.toString());
        return this;
    }

    /**
     * Sets the response status.
     *
     * @param status The status
     * @return This response object
     */
    default MutableHttpResponse status(int status) {
        return status(status, null);
    }

    /**
     * Sets the response status.
     *
     * @param status  The status
     * @param message The message
     * @return This response object
     */
    MutableHttpResponse status(int status, CharSequence message);

    /**
     * Sets the response status.
     *
     * @param status The status
     * @return This response object
     */
    default MutableHttpResponse status(HttpStatus status) {
        return status(status, null);
    }

    /**
     * Sets an attribute on the response.
     * @param name The attribute name
     * @param value The attribute value
     * @return This response object
     */
    default MutableHttpResponse attribute(CharSequence name, Object value) {
        return (MutableHttpResponse) setAttribute(name, value);
    }

    @Override
    default MutableHttpResponse toMutableResponse() {
        return this;
    }
}