reactor.netty.http.client

Interface HttpClientRequest

All Superinterfaces:

HttpInfos

public interface HttpClientRequest
extends HttpInfos

An Http Reactive client metadata contract for outgoing requests. It inherits several accessor related to HTTP flow : headers, params, URI, method, websocket...

Author:

Stephane Maldini, Simon Baslé

Method Summary

Modifier and Type	Method and Description
HttpClientRequest	addCookie(Cookie cookie) Add an outbound cookie
HttpClientRequest	addHeader(java.lang.CharSequence name, java.lang.CharSequence value) Add an outbound http header, appending the value if the header is already set.
boolean	hasSentHeaders() Return true if headers and status have been sent to the client
HttpClientRequest	header(java.lang.CharSequence name, java.lang.CharSequence value) Set an outbound header, replacing any pre-existing value.
HttpClientRequest	headers(HttpHeaders headers) Set outbound headers from the passed headers.
boolean	isFollowRedirect() Return true if redirected will be followed
HttpClientRequest	keepAlive(boolean keepAlive) set the request keepAlive if true otherwise remove the existing connection keep alive header
java.lang.String[]	redirectedFrom() Return the previous redirections or empty array
HttpHeaders	requestHeaders() Return outbound headers to be sent

Methods inherited from interface reactor.netty.http.HttpInfos

cookies, isKeepAlive, isWebsocket, method, path, uri, version

Method Detail

addCookie

HttpClientRequest addCookie(Cookie cookie)

Add an outbound cookie

Returns:

this outbound

addHeader

HttpClientRequest addHeader(java.lang.CharSequence name,
                            java.lang.CharSequence value)

Add an outbound http header, appending the value if the header is already set.

Parameters:

name - header name

value - header value

Returns:

this outbound

hasSentHeaders

boolean hasSentHeaders()

Return true if headers and status have been sent to the client

Returns:

true if headers and status have been sent to the client

header

HttpClientRequest header(java.lang.CharSequence name,
                         java.lang.CharSequence value)

Set an outbound header, replacing any pre-existing value.

Parameters:

name - headers key

value - header value

Returns:

this outbound

headers

HttpClientRequest headers(HttpHeaders headers)

Set outbound headers from the passed headers. It will however ignore HOST header key. Any pre-existing value for the passed headers will be replaced.

Parameters:

headers - a netty headers map

Returns:

this outbound

isFollowRedirect

boolean isFollowRedirect()

Return true if redirected will be followed

Returns:

true if redirected will be followed

keepAlive

HttpClientRequest keepAlive(boolean keepAlive)

set the request keepAlive if true otherwise remove the existing connection keep alive header

Returns:

this outbound

redirectedFrom

java.lang.String[] redirectedFrom()

Return the previous redirections or empty array

Returns:

the previous redirections or empty array

requestHeaders

HttpHeaders requestHeaders()

Return outbound headers to be sent

Returns:

outbound headers to be sent