All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • io.micronaut.http.HttpMessage Maven / Gradle / Ivy

    /*
 * 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.attr.MutableAttributeHolder;
import io.micronaut.core.convert.ArgumentConversionContext;
import io.micronaut.core.convert.ConversionContext;
import io.micronaut.core.convert.ConversionService;
import io.micronaut.core.convert.value.MutableConvertibleValues;
import io.micronaut.core.type.Argument;
import io.micronaut.core.util.ArgumentUtils;
import io.micronaut.http.body.MessageBodyWriter;
import io.micronaut.http.util.HttpUtil;

import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.Locale;
import java.util.Optional;

/**
 * Common interface for HTTP messages.
 *
 * @param  The body type
 * @author Graeme Rocher
 * @see HttpRequest
 * @see HttpResponse
 * @since 1.0
 */
public interface HttpMessage extends MutableAttributeHolder {

    /**
     * @return The {@link HttpHeaders} object
     */
    @NonNull HttpHeaders getHeaders();

    /**
     * 
    A {@link MutableConvertibleValues} of the attributes for this HTTP message.
    
     *
     * 
    Attributes are designed for internal data sharing and hence are isolated from headers and parameters which are client supplied
    
     *
     * @return The attributes of the message
     */
    @Override
    @NonNull MutableConvertibleValues getAttributes();

    /**
     * @return The request body
     */
    @NonNull Optional getBody();

    /**
     * @return The body writer.
     * @since 4.0.0
     */
    @SuppressWarnings({"rawtypes", "unchecked"})
    default Optional> getBodyWriter() {
        return (Optional) getAttribute(HttpAttributes.MESSAGE_BODY_WRITER, MessageBodyWriter.class);
    }

    /**
     * @return The request character encoding. Defaults to {@link StandardCharsets#UTF_8}
     */
    default @NonNull Charset getCharacterEncoding() {
        return HttpUtil.getCharset(this);
    }

    @Override
    default @NonNull HttpMessage setAttribute(@NonNull CharSequence name, Object value) {
        return (HttpMessage) MutableAttributeHolder.super.setAttribute(name, value);
    }

    /**
     * Return the body as the given type.
     *
     * @param type The type of the body
     * @param   The generic type
     * @return An {@link Optional} of the type or {@link Optional#empty()} if the body cannot be returned as the given type
     */
    default @NonNull  Optional getBody(@NonNull Argument type) {
        return getBody(ConversionContext.of(type));
    }

    /**
     * Return the body, will use the provided conversion context if needed.
     *
     * @param conversionContext The body conversion context
     * @param                The generic type
     * @return An {@link Optional} of the type or {@link Optional#empty()} if the body cannot be returned as the given type
     * @since 4.0.0
     */
    default @NonNull  Optional getBody(@NonNull ArgumentConversionContext conversionContext) {
        ArgumentUtils.requireNonNull("conversionContext", conversionContext);
        return getBody().flatMap(b -> ConversionService.SHARED.convert(b, conversionContext));
    }

    /**
     * Return the body as the given type.
     *
     * @param type The type of the body
     * @param   The generic type
     * @return An {@link Optional} of the type or {@link Optional#empty()} if the body cannot be returned as the given type
     */
    default @NonNull  Optional getBody(@NonNull Class type) {
        ArgumentUtils.requireNonNull("type", type);
        return getBody(Argument.of(type));
    }

    /**
     * @return The locale of the message
     */
    default @NonNull Optional getLocale() {
        return getHeaders().findFirst(HttpHeaders.CONTENT_LANGUAGE)
            .map(Locale::new);
    }

    /**
     * @return The value of the Content-Length header or -1L if none specified
     */
    default long getContentLength() {
        return getHeaders()
            .contentLength()
            .orElse(-1L);
    }

    /**
     * The request or response content type.
     *
     * @return The content type
     */
    default @NonNull Optional getContentType() {
        return getHeaders().contentType();
    }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy