io.micronaut.http.HttpRequestFactory 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;

/**
 * A factory interface for {@link MutableHttpRequest} objects.
 *
 * @author Graeme Rocher
 * @since 1.0
 */
public interface HttpRequestFactory {

    /**
     * The default {@link io.micronaut.http.cookie.CookieFactory} instance.
     */
    HttpRequestFactory INSTANCE = DefaultHttpFactories.resolveDefaultRequestFactory();

    /**
     * Return a {@link MutableHttpRequest} that executes an {@link HttpMethod#GET} request for the given URI.
     *
     * @param uri The URI
     * @param  The Http request type
     * @return The {@link MutableHttpRequest} instance
     */
     MutableHttpRequest get(String uri);

    /**
     * Return a {@link MutableHttpRequest} that executes an {@link HttpMethod#POST} request for the given URI.
     *
     * @param uri  The URI
     * @param body The body
     * @param   The body type
     * @return The {@link MutableHttpRequest} instance
     */
     MutableHttpRequest post(String uri, T body);

    /**
     * Return a {@link MutableHttpRequest} that executes an {@link HttpMethod#PUT} request for the given URI.
     *
     * @param uri  The URI
     * @param body The body
     * @param   The body type
     * @return The {@link MutableHttpRequest} instance
     */
     MutableHttpRequest put(String uri, T body);

    /**
     * Return a {@link MutableHttpRequest} that executes an {@link HttpMethod#PATCH} request for the given URI.
     *
     * @param uri  The URI
     * @param body The body
     * @param   The body type
     * @return The {@link MutableHttpRequest} instance
     */
     MutableHttpRequest patch(String uri, T body);

    /**
     * Return a {@link MutableHttpRequest} that executes an {@link HttpMethod#HEAD} request for the given URI.
     *
     * @param uri The URI
     * @param  The Http request type
     * @return The {@link MutableHttpRequest} instance
     */
     MutableHttpRequest head(String uri);

    /**
     * Return a {@link MutableHttpRequest} that executes an {@link HttpMethod#OPTIONS} request for the given URI.
     *
     * @param uri The URI
     * @param  The Http request type
     * @return The {@link MutableHttpRequest} instance
     */
     MutableHttpRequest options(String uri);

    /**
     * Return a {@link MutableHttpRequest} that executes an {@link HttpMethod#DELETE} request for the given URI.
     *
     * @param uri  The URI
     * @param body an optional body
     * @param   The body type
     * @return The {@link MutableHttpRequest} instance
     */
     MutableHttpRequest delete(String uri, T body);

    /**
     * Create a new {@link MutableHttpRequest} for the given method and URI.
     *
     * @param httpMethod The method
     * @param uri        The URI
     * @param         The Http request type
     * @return The request
     */
     MutableHttpRequest create(HttpMethod httpMethod, String uri);

    /**
     * Allows to create request including non-standard http methods.
     * @param httpMethod The method
     * @param uri The URI
     * @param httpMethodName Method name. For standard http method equals to {@link HttpMethod#name()}
     * @param  The http request type
     * @return The request
     */
    default  MutableHttpRequest create(HttpMethod httpMethod, String uri, String httpMethodName) {
        return create(httpMethod, uri);
    }
}