io.micronaut.http

Interface HttpRequestFactory

All Known Implementing Classes:

NettyClientHttpRequestFactory, SimpleHttpRequestFactory

public interface HttpRequestFactory

A factory interface for MutableHttpRequest objects.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
static HttpRequestFactory	INSTANCE The default CookieFactory instance.

Method Summary

Modifier and Type	Method and Description
<T> MutableHttpRequest<T>	create(HttpMethod httpMethod, java.lang.String uri) Create a new MutableHttpRequest for the given method and URI.
default <T> MutableHttpRequest<T>	create(HttpMethod httpMethod, java.lang.String uri, java.lang.String httpMethodName) Allows to create request including non-standard http methods.
<T> MutableHttpRequest<T>	delete(java.lang.String uri, T body) Return a MutableHttpRequest that executes an HttpMethod.DELETE request for the given URI.
<T> MutableHttpRequest<T>	get(java.lang.String uri) Return a MutableHttpRequest that executes an HttpMethod.GET request for the given URI.
<T> MutableHttpRequest<T>	head(java.lang.String uri) Return a MutableHttpRequest that executes an HttpMethod.HEAD request for the given URI.
<T> MutableHttpRequest<T>	options(java.lang.String uri) Return a MutableHttpRequest that executes an HttpMethod.OPTIONS request for the given URI.
<T> MutableHttpRequest<T>	patch(java.lang.String uri, T body) Return a MutableHttpRequest that executes an HttpMethod.PATCH request for the given URI.
<T> MutableHttpRequest<T>	post(java.lang.String uri, T body) Return a MutableHttpRequest that executes an HttpMethod.POST request for the given URI.
<T> MutableHttpRequest<T>	put(java.lang.String uri, T body) Return a MutableHttpRequest that executes an HttpMethod.PUT request for the given URI.

Field Detail

INSTANCE

static final HttpRequestFactory INSTANCE

The default CookieFactory instance.

Method Detail

get

<T> MutableHttpRequest<T> get(java.lang.String uri)

Return a MutableHttpRequest that executes an HttpMethod.GET request for the given URI.

Type Parameters:

T - The Http request type

Parameters:

uri - The URI

Returns:

The MutableHttpRequest instance

post

<T> MutableHttpRequest<T> post(java.lang.String uri,
                               T body)

Return a MutableHttpRequest that executes an HttpMethod.POST request for the given URI.

Type Parameters:

T - The body type

Parameters:

uri - The URI

body - The body

Returns:

The MutableHttpRequest instance

put

<T> MutableHttpRequest<T> put(java.lang.String uri,
                              T body)

Return a MutableHttpRequest that executes an HttpMethod.PUT request for the given URI.

Type Parameters:

T - The body type

Parameters:

uri - The URI

body - The body

Returns:

The MutableHttpRequest instance

patch

<T> MutableHttpRequest<T> patch(java.lang.String uri,
                                T body)

Return a MutableHttpRequest that executes an HttpMethod.PATCH request for the given URI.

Type Parameters:

T - The body type

Parameters:

uri - The URI

body - The body

Returns:

The MutableHttpRequest instance

head

<T> MutableHttpRequest<T> head(java.lang.String uri)

Return a MutableHttpRequest that executes an HttpMethod.HEAD request for the given URI.

Type Parameters:

T - The Http request type

Parameters:

uri - The URI

Returns:

The MutableHttpRequest instance

options

<T> MutableHttpRequest<T> options(java.lang.String uri)

Return a MutableHttpRequest that executes an HttpMethod.OPTIONS request for the given URI.

Type Parameters:

T - The Http request type

Parameters:

uri - The URI

Returns:

The MutableHttpRequest instance

delete

<T> MutableHttpRequest<T> delete(java.lang.String uri,
                                 T body)

Return a MutableHttpRequest that executes an HttpMethod.DELETE request for the given URI.

Type Parameters:

T - The body type

Parameters:

uri - The URI

body - an optional body

Returns:

The MutableHttpRequest instance

create

<T> MutableHttpRequest<T> create(HttpMethod httpMethod,
                                 java.lang.String uri)

Create a new MutableHttpRequest for the given method and URI.

Type Parameters:

T - The Http request type

Parameters:

httpMethod - The method

uri - The URI

Returns:

The request

create

default <T> MutableHttpRequest<T> create(HttpMethod httpMethod,
                                         java.lang.String uri,
                                         java.lang.String httpMethodName)

Allows to create request including non-standard http methods.

Type Parameters:

T - The http request type

Parameters:

httpMethod - The method

uri - The URI

httpMethodName - Method name. For standard http method equals to Enum.name()

Returns:

The request