Package io.gravitee.gateway.api.proxy

Interface ProxyResponse

All Superinterfaces:

ReadStream<Buffer>

public interface ProxyResponse
extends ReadStream<Buffer>

Author:

David BRASSELY (david.brassely at graviteesource.com), GraviteeSource Team

Method Summary

Modifier and Type	Method	Description
default void	cancel()
default ProxyResponse	cancelHandler(Handler<Void> cancelHandler)
default boolean	connected()	Is the response connected to an upstream or it is a 'direct' response from the proxy itself.
default ProxyResponse	customFrameHandler(Handler<HttpFrame> frameHandler)	For HTTP/2 request
HttpHeaders	headers()
default String	reason()	Reason-Phrase is intended to give a short textual description of the Status-Code.
int	status()
default HttpHeaders	trailers()

Methods inherited from interface io.gravitee.gateway.api.stream.ReadStream

bodyHandler, endHandler, pause, resume

Method Details

status

int status()

Returns:

HTTP status code.

reason

default String reason()

Reason-Phrase is intended to give a short textual description of the Status-Code.

Returns:

headers

HttpHeaders headers()

Returns:

the headers in the response.

connected

default boolean connected()

Is the response connected to an upstream or it is a 'direct' response from the proxy itself.

Returns:

customFrameHandler

default ProxyResponse customFrameHandler(Handler<HttpFrame> frameHandler)

For HTTP/2 request

Parameters:

frameHandler - The handler to call when getting a custom HTTP Frame.

Returns:

trailers

default HttpHeaders trailers()

cancelHandler

default ProxyResponse cancelHandler(Handler<Void> cancelHandler)

cancel

default void cancel()