io.micronaut.http.MutableHttpRequest 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.convert.ConversionServiceAware;
import io.micronaut.core.util.ArrayUtils;
import io.micronaut.http.cookie.Cookie;
import io.micronaut.http.uri.UriBuilder;

import java.net.URI;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.function.Consumer;

/**
 * An extended version of {@link HttpRequest} that allows mutating headers, the body etc.
 *
 * @param  The request body type
 * @author Graeme Rocher
 * @since 1.0
 */
public interface MutableHttpRequest extends HttpRequest, MutableHttpMessage, ConversionServiceAware {

    /**
     * Sets the specified cookie on the request.
     *
     * @param cookie the Cookie to return to the client
     * @return The http request
     */
    MutableHttpRequest cookie(Cookie cookie);

    /**
     * Sets the specified cookies on the request.
     *
     * @param cookies the Cookies to return to the client
     * @return The http request
     */
    default MutableHttpRequest cookies(Set cookies) {
        for (Cookie cookie: cookies) {
            cookie(cookie);
        }
        return this;
    }


    /**
     * Sets the uri on the request.
     *
     * @param uri The uri to call
     * @return The http request
     */
    MutableHttpRequest uri(URI uri);

    @Override
     MutableHttpRequest body(T body);

    @Override
    MutableHttpHeaders getHeaders();

    @Override
    MutableHttpParameters getParameters();

    /**
     * Alters the URI of the request with the given URI builder.
     *
     * @param consumer A consumer that accepts the URI
     * @return The modified request
     */
    default @NonNull MutableHttpRequest uri(@NonNull Consumer consumer) {
        Objects.requireNonNull(consumer, "URI builder cannot be null");
        UriBuilder builder = UriBuilder.of(getUri());
        consumer.accept(builder);
        return uri(builder.build());
    }

    /**
     * Sets the acceptable {@link MediaType} instances via the {@link HttpHeaders#ACCEPT} header.
     *
     * @param mediaTypes The media types
     * @return This request
     */
    default MutableHttpRequest accept(MediaType... mediaTypes) {
        if (ArrayUtils.isNotEmpty(mediaTypes)) {
            String acceptString = String.join(",", mediaTypes);
            header(HttpHeaders.ACCEPT, acceptString);
        }
        return this;
    }

    /**
     * Sets the acceptable {@link MediaType} instances via the {@link HttpHeaders#ACCEPT} header.
     *
     * @param mediaTypes The media types
     * @return This request
     */
    default MutableHttpRequest accept(CharSequence... mediaTypes) {
        if (ArrayUtils.isNotEmpty(mediaTypes)) {
            String acceptString = String.join(",", mediaTypes);
            header(HttpHeaders.ACCEPT, acceptString);
        }
        return this;
    }

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

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

    @Override
    default MutableHttpRequest basicAuth(CharSequence username, CharSequence password) {
        return (MutableHttpRequest) MutableHttpMessage.super.basicAuth(username, password);
    }

    @Override
    default MutableHttpRequest bearerAuth(CharSequence token) {
        return (MutableHttpRequest) MutableHttpMessage.super.bearerAuth(token);
    }

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

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

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

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

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

    @Override
    default MutableHttpRequest toMutableRequest() {
        return this;
    }
}