/*
 * 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 MutableHttpRequest objects. 
Author:
Graeme Rocher
Since:
1.0/**
 * A factory interface for {@link MutableHttpRequest} objects.
 *
 * @author Graeme Rocher
 * @since 1.0
 */
public interface HttpRequestFactory {

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

    
Return a MutableHttpRequest that executes an HttpMethod.GET request for the given URI. 
Params:
uri – The URI
Type parameters:
<T> – The Http request type
Returns:
The MutableHttpRequest instance/**
     * Return a {@link MutableHttpRequest} that executes an {@link HttpMethod#GET} request for the given URI.
     *
     * @param uri The URI
     * @param <T> The Http request type
     * @return The {@link MutableHttpRequest} instance
     */
    <T> MutableHttpRequest<T> get(String uri);

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

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

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

    
Return a MutableHttpRequest that executes an HttpMethod.HEAD request for the given URI. 
Params:
uri – The URI
Type parameters:
<T> – The Http request type
Returns:
The MutableHttpRequest instance/**
     * Return a {@link MutableHttpRequest} that executes an {@link HttpMethod#HEAD} request for the given URI.
     *
     * @param uri The URI
     * @param <T> The Http request type
     * @return The {@link MutableHttpRequest} instance
     */
    <T> MutableHttpRequest<T> head(String uri);

    
Return a MutableHttpRequest that executes an HttpMethod.OPTIONS request for the given URI. 
Params:
uri – The URI
Type parameters:
<T> – The Http request type
Returns:
The MutableHttpRequest instance/**
     * Return a {@link MutableHttpRequest} that executes an {@link HttpMethod#OPTIONS} request for the given URI.
     *
     * @param uri The URI
     * @param <T> The Http request type
     * @return The {@link MutableHttpRequest} instance
     */
    <T> MutableHttpRequest<T> options(String uri);

    
Return a MutableHttpRequest that executes an HttpMethod.DELETE request for the given URI. 
Params:
uri –  The URI
body – an optional body
Type parameters:
<T> –  The body type
Returns:
The MutableHttpRequest instance/**
     * 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 <T>  The body type
     * @return The {@link MutableHttpRequest} instance
     */
    <T> MutableHttpRequest<T> delete(String uri, T body);

    
Create a new MutableHttpRequest for the given method and URI. 
Params:
httpMethod – The method
uri –        The URI
Type parameters:
<T> –        The Http request type
Returns:
The request/**
     * Create a new {@link MutableHttpRequest} for the given method and URI.
     *
     * @param httpMethod The method
     * @param uri        The URI
     * @param <T>        The Http request type
     * @return The request
     */
    <T> MutableHttpRequest<T> create(HttpMethod httpMethod, String uri);

    
Allows to create request including non-standard http methods.
Params:
httpMethod – The method
uri – The URI
httpMethodName – Method name. For standard http method equals to Enum<HttpMethod>.name()
Type parameters:
<T> – The http request type
Returns:
The request/**
     * 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 <T> The http request type
     * @return The request
     */
    default <T> MutableHttpRequest<T> create(HttpMethod httpMethod, String uri, String httpMethodName) {
        return create(httpMethod, uri);
    }
}