Package io.micronaut.http.client.netty

Class NettyClientHttpRequest<B>

java.lang.Object

io.micronaut.http.client.netty.NettyClientHttpRequest<B>

Type Parameters:

B - The request body

All Implemented Interfaces:

AttributeHolder, MutableAttributeHolder, ConversionServiceAware, HttpMessage<B>, HttpRequest<B>, MutableHttpMessage<B>, MutableHttpRequest<B>, NettyHttpRequestBuilder

@Internal
public class NettyClientHttpRequest<B>
extends Object
implements MutableHttpRequest<B>, NettyHttpRequestBuilder

Default implementation of MutableHttpRequest for the HttpClient.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields inherited from interface io.micronaut.http.HttpRequest

SCHEME_HTTP, SCHEME_HTTPS

Method Summary

Modifier and Type	Method	Description
<T> MutableHttpRequest<T>	body(T body)	Sets the body.
MutableHttpRequest<B>	cookie(Cookie cookie)	Sets the specified cookie on the request.
MutableHttpRequest<B>	cookies(Set<Cookie> cookies)	Sets the specified cookies on the request.
protected io.netty.handler.codec.http.QueryStringDecoder	createDecoder(URI uri)
MutableConvertibleValues<Object>	getAttributes()	A MutableConvertibleValues of the attributes for this HTTP message.
Optional<B>	getBody()
<T> Optional<T>	getBody(ArgumentConversionContext<T> conversionContext)	Return the body, will use the provided conversion context if needed.
<T> Optional<T>	getBody(Class<T> type)	Return the body as the given type.
Cookies	getCookies()
MutableHttpHeaders	getHeaders()
HttpMethod	getMethod()
String	getMethodName()
MutableHttpParameters	getParameters()
URI	getUri()
boolean	isStream()	Deprecated.
void	setConversionService(ConversionService conversionService)	Sets the conversion service.
@NonNull io.netty.handler.codec.http.FullHttpRequest	toFullHttpRequest()	Deprecated.
@NonNull io.netty.handler.codec.http.HttpRequest	toHttpRequest()	Deprecated.
io.netty.handler.codec.http.HttpRequest	toHttpRequestWithoutBody()	Convert this request to a netty request without the body.
@NonNull StreamedHttpRequest	toStreamHttpRequest()	Deprecated.
String	toString()
MutableHttpRequest<B>	uri(URI uri)	Sets the uri on the request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.micronaut.core.attr.AttributeHolder

getAttribute, getAttribute

Methods inherited from interface io.micronaut.http.HttpMessage

getBody, getBodyWriter, getCharacterEncoding, getContentLength, getContentType

Methods inherited from interface io.micronaut.http.HttpRequest

accept, getCertificate, getHttpVersion, getLocale, getOrigin, getPath, getRemoteAddress, getServerAddress, getServerName, getSslSession, getUserPrincipal, getUserPrincipal, isSecure, mutate, setAttribute, setUserPrincipal

Methods inherited from interface io.micronaut.core.attr.MutableAttributeHolder

removeAttribute

Methods inherited from interface io.micronaut.http.MutableHttpMessage

bodyWriter

Methods inherited from interface io.micronaut.http.MutableHttpRequest

accept, accept, basicAuth, bearerAuth, contentEncoding, contentLength, contentType, contentType, header, headers, headers, toMutableRequest, uri

Methods inherited from interface io.micronaut.http.netty.NettyHttpRequestBuilder

byteBodyDirect, toHttpRequestDirect

Method Details

getHeaders

public MutableHttpHeaders getHeaders()

Specified by:

getHeaders in interface HttpMessage<B>

Specified by:

getHeaders in interface MutableHttpMessage<B>

Specified by:

getHeaders in interface MutableHttpRequest<B>

Returns:

The HttpHeaders object

getAttributes

public MutableConvertibleValues<Object> getAttributes()

Description copied from interface: HttpMessage

A 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

Specified by:

getAttributes in interface AttributeHolder

Specified by:

getAttributes in interface HttpMessage<B>

Specified by:

getAttributes in interface MutableAttributeHolder

Returns:

The attributes of the message

cookie

public MutableHttpRequest<B> cookie(Cookie cookie)

Description copied from interface: MutableHttpRequest

Sets the specified cookie on the request.

Specified by:

cookie in interface MutableHttpRequest<B>

Parameters:

cookie - the Cookie to return to the client

Returns:

The http request

cookies

public MutableHttpRequest<B> cookies(Set<Cookie> cookies)

Description copied from interface: MutableHttpRequest

Sets the specified cookies on the request.

Specified by:

cookies in interface MutableHttpRequest<B>

Parameters:

cookies - the Cookies to return to the client

Returns:

The http request

uri

public MutableHttpRequest<B> uri(URI uri)

Description copied from interface: MutableHttpRequest

Sets the uri on the request.

Specified by:

uri in interface MutableHttpRequest<B>

Parameters:

uri - The uri to call

Returns:

The http request

getBody

public Optional<B> getBody()

Specified by:

getBody in interface HttpMessage<B>

Returns:

The request body

getBody

public <T> Optional<T> getBody(Class<T> type)

Description copied from interface: HttpMessage

Return the body as the given type.

Specified by:

getBody in interface HttpMessage<B>

Type Parameters:

T - The generic type

Parameters:

type - The type of the body

Returns:

An Optional of the type or Optional.empty() if the body cannot be returned as the given type

getBody

public <T> Optional<T> getBody(ArgumentConversionContext<T> conversionContext)

Description copied from interface: HttpMessage

Return the body, will use the provided conversion context if needed.

Specified by:

getBody in interface HttpMessage<B>

Type Parameters:

T - The generic type

Parameters:

conversionContext - The body conversion context

Returns:

An Optional of the type or Optional.empty() if the body cannot be returned as the given type

body

public <T> MutableHttpRequest<T> body(T body)

Description copied from interface: MutableHttpMessage

Sets the body.

Specified by:

body in interface MutableHttpMessage<B>

Specified by:

body in interface MutableHttpRequest<B>

Type Parameters:

T - The new body type

Parameters:

body - The body

Returns:

This message

getCookies

public Cookies getCookies()

Specified by:

getCookies in interface HttpRequest<B>

Returns:

The Cookies instance

getParameters

public MutableHttpParameters getParameters()

Specified by:

getParameters in interface HttpRequest<B>

Specified by:

getParameters in interface MutableHttpRequest<B>

Returns:

The HTTP parameters contained with the URI query string

getMethod

public HttpMethod getMethod()

Specified by:

getMethod in interface HttpRequest<B>

Returns:

The request method

getUri

public URI getUri()

Specified by:

getUri in interface HttpRequest<B>

Returns:

The full request URI

createDecoder

protected io.netty.handler.codec.http.QueryStringDecoder createDecoder(URI uri)

Parameters:

uri - The URI

Returns:

The query string decoder

toString

public String toString()

Overrides:

toString in class Object

getMethodName

public String getMethodName()

Specified by:

getMethodName in interface HttpRequest<B>

Returns:

The name of the method (same as HttpMethod value for standard http methods).

toFullHttpRequest

@NonNull
@Deprecated
public @NonNull io.netty.handler.codec.http.FullHttpRequest toFullHttpRequest()

Deprecated.

Description copied from interface: NettyHttpRequestBuilder

Converts this object to a full http request.

Specified by:

toFullHttpRequest in interface NettyHttpRequestBuilder

Returns:

a full http request

toStreamHttpRequest

@NonNull
@Deprecated
public @NonNull StreamedHttpRequest toStreamHttpRequest()

Deprecated.

Description copied from interface: NettyHttpRequestBuilder

Converts this object to a streamed http request.

Specified by:

toStreamHttpRequest in interface NettyHttpRequestBuilder

Returns:

The streamed request

toHttpRequest

@NonNull
@Deprecated
public @NonNull io.netty.handler.codec.http.HttpRequest toHttpRequest()

Deprecated.

Description copied from interface: NettyHttpRequestBuilder

Converts this object to the most appropriate http request type.

Specified by:

toHttpRequest in interface NettyHttpRequestBuilder

Returns:

The http request

toHttpRequestWithoutBody

public io.netty.handler.codec.http.HttpRequest toHttpRequestWithoutBody()

Description copied from interface: NettyHttpRequestBuilder

Convert this request to a netty request without the body. The caller will handle adding the body.

Specified by:

toHttpRequestWithoutBody in interface NettyHttpRequestBuilder

Returns:

The request excluding the body

isStream

@Deprecated
public boolean isStream()

Deprecated.

Specified by:

isStream in interface NettyHttpRequestBuilder

Returns:

Is the request a stream.

setConversionService

public void setConversionService(ConversionService conversionService)

Description copied from interface: ConversionServiceAware

Sets the conversion service.

Specified by:

setConversionService in interface ConversionServiceAware

Parameters:

conversionService - The conversion service