io.vertx.rxjava3.httpproxy

Class ProxyResponse

java.lang.Object

io.vertx.rxjava3.httpproxy.ProxyResponse

public class ProxyResponse
extends Object

Handles the interoperability of the response between the origin and the user agent.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field and Description
static io.vertx.lang.rx.TypeArg<ProxyResponse>	__TYPE_ARG

Constructor Summary

Constructors

Constructor and Description
ProxyResponse(Object delegate)
ProxyResponse(ProxyResponse delegate)

Method Summary

Modifier and Type	Method and Description
ProxyResponse	bodyFilter(java.util.function.Function<ReadStream<Buffer>,Flowable<Buffer>> filter) Set a body filter.
boolean	equals(Object o)
String	etag()
Body	getBody() Get the body of the response.
ProxyResponse	getDelegate()
int	getStatusCode() Get the status code.
String	getStatusMessage() Get the status message.
int	hashCode()
MultiMap	headers()
long	maxAge()
static ProxyResponse	newInstance(ProxyResponse arg)
boolean	publicCacheControl()
ProxyResponse	release() Release the proxy response.
ProxyRequest	request() Return the corresponding ProxyRequest.
Completable	rxSend() Send the proxy response to the user agent.
Completable	send() Send the proxy response to the user agent.
ProxyResponse	setBody(Body body) Set the request body to be sent to the user agent.
ProxyResponse	setStatusCode(int sc) Set the status code to be sent to the user agent.
ProxyResponse	setStatusMessage(String statusMessage) Set the status message to be sent to the user agent.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TYPE_ARG

public static final io.vertx.lang.rx.TypeArg<ProxyResponse> __TYPE_ARG

Constructor Detail

ProxyResponse

public ProxyResponse(ProxyResponse delegate)

ProxyResponse

public ProxyResponse(Object delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDelegate

public ProxyResponse getDelegate()

request

public ProxyRequest request()

Return the corresponding ProxyRequest.

Returns:

the proxy request

getStatusCode

public int getStatusCode()

Get the status code.

Returns:

the status code to be sent to the user agent

setStatusCode

public ProxyResponse setStatusCode(int sc)

Set the status code to be sent to the user agent.

The initial value is the inbound response status code.

Parameters:

sc - the status code

Returns:

a reference to this, so the API can be used fluently

getStatusMessage

public String getStatusMessage()

Get the status message.

Returns:

the status message to be sent to the user agent

setStatusMessage

public ProxyResponse setStatusMessage(String statusMessage)

Set the status message to be sent to the user agent.

The initial value is the inbound response status message.

Parameters:

statusMessage - the status message

Returns:

a reference to this, so the API can be used fluently

headers

public MultiMap headers()

Returns:

the headers that will be sent to the user agent, the returned headers can be modified. The headers map is populated with the inbound response headers

getBody

public Body getBody()

Get the body of the response.

Returns:

the response body to be sent to the user agent

setBody

public ProxyResponse setBody(Body body)

Set the request body to be sent to the user agent.

The initial request body value is the outbound response body.

Parameters:

body - the new body

Returns:

a reference to this, so the API can be used fluently

bodyFilter

public ProxyResponse bodyFilter(java.util.function.Function<ReadStream<Buffer>,Flowable<Buffer>> filter)

Set a body filter.

The body filter can rewrite the response body sent to the user agent.

Parameters:

filter - the filter

Returns:

a reference to this, so the API can be used fluently

publicCacheControl

public boolean publicCacheControl()

maxAge

public long maxAge()

etag

public String etag()

Returns:

the etag sent by the origin response

send

public Completable send()

Send the proxy response to the user agent.

Returns:

rxSend

public Completable rxSend()

Send the proxy response to the user agent.

Returns:

release

public ProxyResponse release()

Release the proxy response.

The HTTP client inbound response is resumed, no HTTP inbound server response is sent.

Returns:

newInstance

public static ProxyResponse newInstance(ProxyResponse arg)