Index (Vert.x Http Proxy 5.0.0.CR1 API)

A B C D E F G H I L M N O P Q R S T V W
All Classes All Packages

A

absoluteURI() - Method in interface io.vertx.httpproxy.ProxyRequest
addInterceptor(ProxyInterceptor) - Method in interface io.vertx.httpproxy.HttpProxy: Add an interceptor to the interceptor chain.
addPrefix(String) - Static method in interface io.vertx.httpproxy.interceptors.PathInterceptor: Remove a prefix to the URI.
allow(ProxyInterceptor) - Static method in interface io.vertx.httpproxy.interceptors.WebSocketInterceptor: A wrapper to allow interceptor apply to WebSocket handshake packages.
allowApplyToWebSocket() - Method in interface io.vertx.httpproxy.ProxyInterceptor: Used to set whether to apply the interceptor to the WebSocket handshake packet.

B

body(Buffer) - Static method in interface io.vertx.httpproxy.Body: Create a new Body instance.
body(ReadStream<Buffer>) - Static method in interface io.vertx.httpproxy.Body: Create a new Body instance.
body(ReadStream<Buffer>, long) - Static method in interface io.vertx.httpproxy.Body: Create a new Body instance.
Body - Interface in io.vertx.httpproxy: Handles the HTTP proxy body.
BodyInterceptor - Interface in io.vertx.httpproxy.interceptors: Used to create interceptors to modify request and response bodies.
BodyTransformer - Interface in io.vertx.httpproxy.interceptors: The callback to transform the request or response body.

C

Cache<K,V> - Interface in io.vertx.httpproxy.spi.cache: Cache SPI.
CacheOptions - Class in io.vertx.httpproxy.cache: Cache options.
CacheOptions() - Constructor for class io.vertx.httpproxy.cache.CacheOptions
CacheOptions(JsonObject) - Constructor for class io.vertx.httpproxy.cache.CacheOptions
CacheOptionsConverter - Class in io.vertx.httpproxy.cache: Converter and mapper for CacheOptions.
CacheOptionsConverter() - Constructor for class io.vertx.httpproxy.cache.CacheOptionsConverter
changeHeaders(Handler<MultiMap>, Handler<MultiMap>) - Static method in interface io.vertx.httpproxy.interceptors.HeadersInterceptor: Apply callbacks to change the request and response headers when the proxy receives them.
changePath(Function<String, String>) - Static method in interface io.vertx.httpproxy.interceptors.PathInterceptor: Apply a callback to change the request URI when the proxy receives it.
changeQueryParams(Handler<MultiMap>) - Static method in interface io.vertx.httpproxy.interceptors.QueryInterceptor: Apply callbacks to modify the query parameters.

D

DEFAULT_MAX_SIZE - Static variable in class io.vertx.httpproxy.cache.CacheOptions
DEFAULT_SUPPORT_WEBSOCKET - Static variable in class io.vertx.httpproxy.ProxyOptions: Enable WebSocket support : true
discard() - Static method in interface io.vertx.httpproxy.interceptors.BodyTransformer: Create a callback to discard the body.

E

etag() - Method in interface io.vertx.httpproxy.ProxyResponse

F

filterHeaders(Set<CharSequence>, Set<CharSequence>) - Static method in interface io.vertx.httpproxy.interceptors.HeadersInterceptor: Filter the request and response headers in the given sets.
filterRequestHeaders(Set<CharSequence>) - Static method in interface io.vertx.httpproxy.interceptors.HeadersInterceptor: Filter the request headers in the given set.
filterResponseHeaders(Set<CharSequence>) - Static method in interface io.vertx.httpproxy.interceptors.HeadersInterceptor: Filter the response headers in the given set.

G

get(String, Class<T>) - Method in interface io.vertx.httpproxy.ProxyContext: Get a payload attached to this context
getAuthority() - Method in interface io.vertx.httpproxy.ProxyRequest
getBody() - Method in interface io.vertx.httpproxy.ProxyRequest
getBody() - Method in interface io.vertx.httpproxy.ProxyResponse: Get the body of the response.
getCacheOptions() - Method in class io.vertx.httpproxy.ProxyOptions
getMaxSize() - Method in class io.vertx.httpproxy.cache.CacheOptions
getMethod() - Method in interface io.vertx.httpproxy.ProxyRequest
getStatusCode() - Method in interface io.vertx.httpproxy.ProxyResponse: Get the status code.
getStatusMessage() - Method in interface io.vertx.httpproxy.ProxyResponse: Get the status message.
getSupportWebSocket() - Method in class io.vertx.httpproxy.ProxyOptions
getURI() - Method in interface io.vertx.httpproxy.ProxyRequest

H

handle(HttpServerRequest) - Method in interface io.vertx.httpproxy.HttpProxy: Handle the outbound HttpServerRequest.
handleProxyRequest(ProxyContext) - Method in interface io.vertx.httpproxy.ProxyInterceptor: Handle the proxy request at the stage of this interceptor.
handleProxyResponse(ProxyContext) - Method in interface io.vertx.httpproxy.ProxyInterceptor: Handle the proxy response at the stage of this interceptor.
headers() - Method in interface io.vertx.httpproxy.ProxyRequest
headers() - Method in interface io.vertx.httpproxy.ProxyResponse
HeadersInterceptor - Interface in io.vertx.httpproxy.interceptors: Used to create interceptors to modify request and response headers.
HttpProxy - Interface in io.vertx.httpproxy: Handles the HTTP reverse proxy logic between the user agent and the origin.

I

io.vertx.httpproxy - module io.vertx.httpproxy
io.vertx.httpproxy - package io.vertx.httpproxy
io.vertx.httpproxy.cache - package io.vertx.httpproxy.cache
io.vertx.httpproxy.interceptors - package io.vertx.httpproxy.interceptors
io.vertx.httpproxy.spi.cache - package io.vertx.httpproxy.spi.cache
isWebSocket() - Method in interface io.vertx.httpproxy.ProxyContext

L

length() - Method in interface io.vertx.httpproxy.Body: Get length of the Body.

M

maxAge() - Method in interface io.vertx.httpproxy.ProxyResponse
modifyBody(BodyTransformer, BodyTransformer) - Static method in interface io.vertx.httpproxy.interceptors.BodyInterceptor: Apply callbacks to change the request and response bodies when the proxy receives them.
modifyRequestBody(BodyTransformer) - Static method in interface io.vertx.httpproxy.interceptors.BodyInterceptor: Apply callbacks to change the request body when the proxy receives it.
modifyResponseBody(BodyTransformer) - Static method in interface io.vertx.httpproxy.interceptors.BodyInterceptor: Apply callbacks to change the response body when the proxy receives it.

N

newCache() - Method in class io.vertx.httpproxy.cache.CacheOptions

O

origin(int, String) - Method in interface io.vertx.httpproxy.HttpProxy: Set the host name and port number of the origin.
origin(SocketAddress) - Method in interface io.vertx.httpproxy.HttpProxy: Set the SocketAddress of the origin.
originRequestProvider(BiFunction<HttpServerRequest, HttpClient, Future<HttpClientRequest>>) - Method in interface io.vertx.httpproxy.HttpProxy: Set a provider that creates the request to the origin server based the incoming HTTP request.
originSelector(Function<HttpServerRequest, Future<SocketAddress>>) - Method in interface io.vertx.httpproxy.HttpProxy: Set a selector that resolves the origin address based on the incoming HTTP request.

P

PathInterceptor - Interface in io.vertx.httpproxy.interceptors: Used to create interceptors to modify the request path.
proxiedRequest() - Method in interface io.vertx.httpproxy.ProxyRequest
proxiedResponse() - Method in interface io.vertx.httpproxy.ProxyResponse
proxy(HttpClientRequest) - Method in interface io.vertx.httpproxy.ProxyRequest: Proxy this request to the origin server using the specified request and then send the proxy response.
ProxyContext - Interface in io.vertx.httpproxy: A controller for proxy interception.
ProxyInterceptor - Interface in io.vertx.httpproxy: A HttpProxy interceptor.
ProxyOptions - Class in io.vertx.httpproxy: Proxy options.
ProxyOptions() - Constructor for class io.vertx.httpproxy.ProxyOptions
ProxyOptions(JsonObject) - Constructor for class io.vertx.httpproxy.ProxyOptions
ProxyOptionsConverter - Class in io.vertx.httpproxy: Converter and mapper for ProxyOptions.
ProxyOptionsConverter() - Constructor for class io.vertx.httpproxy.ProxyOptionsConverter
ProxyRequest - Interface in io.vertx.httpproxy: Handles the interoperability of the request between the user agent and the origin.
ProxyResponse - Interface in io.vertx.httpproxy: Handles the interoperability of the response between the origin and the user agent.
publicCacheControl() - Method in interface io.vertx.httpproxy.ProxyResponse
putHeader(CharSequence, CharSequence) - Method in interface io.vertx.httpproxy.ProxyRequest: Put an HTTP header
putHeader(CharSequence, CharSequence) - Method in interface io.vertx.httpproxy.ProxyResponse: Put an HTTP header.

Q

QueryInterceptor - Interface in io.vertx.httpproxy.interceptors: The general interceptor for query parameters.

R

release() - Method in interface io.vertx.httpproxy.ProxyRequest: Release the proxy request and its associated resources
release() - Method in interface io.vertx.httpproxy.ProxyResponse: Release the proxy response.
removePrefix(String) - Static method in interface io.vertx.httpproxy.interceptors.PathInterceptor: Add a prefix to the URI.
removeQueryParam(String) - Static method in interface io.vertx.httpproxy.interceptors.QueryInterceptor: Remove a query parameter to the request.
request() - Method in interface io.vertx.httpproxy.ProxyContext
request() - Method in interface io.vertx.httpproxy.ProxyResponse: Return the corresponding ProxyRequest.
response() - Method in interface io.vertx.httpproxy.ProxyContext
response() - Method in interface io.vertx.httpproxy.ProxyRequest: Create and return the proxy response.
reverseProxy(HttpClient) - Static method in interface io.vertx.httpproxy.HttpProxy: Create a new HttpProxy instance.
reverseProxy(HttpServerRequest) - Static method in interface io.vertx.httpproxy.ProxyRequest: Create a new ProxyRequest instance, the proxied request will be paused.
reverseProxy(ProxyOptions, HttpClient) - Static method in interface io.vertx.httpproxy.HttpProxy: Create a new HttpProxy instance.

S

send() - Method in interface io.vertx.httpproxy.ProxyResponse: Send the proxies response to the user agent.
send(HttpClientRequest) - Method in interface io.vertx.httpproxy.ProxyRequest: Send this request to the origin server using the specified request.
sendRequest() - Method in interface io.vertx.httpproxy.ProxyContext
sendResponse() - Method in interface io.vertx.httpproxy.ProxyContext
set(String, Object) - Method in interface io.vertx.httpproxy.ProxyContext: Attach a payload to the context
setAuthority(HostAndPort) - Method in interface io.vertx.httpproxy.ProxyRequest: Set the request authority for HTTP/1 the Host header for HTTP/2 the :authority pseudo header The value must follow the <host>:<port> syntax.
setBody(Body) - Method in interface io.vertx.httpproxy.ProxyRequest: Set the request body to be sent to the origin server.
setBody(Body) - Method in interface io.vertx.httpproxy.ProxyResponse: Set the request body to be sent to the user agent.
setCacheOptions(CacheOptions) - Method in class io.vertx.httpproxy.ProxyOptions: Set the cache options that configures the proxy.
setMaxSize(int) - Method in class io.vertx.httpproxy.cache.CacheOptions: Set the max number of entries the cache can hold.
setMethod(HttpMethod) - Method in interface io.vertx.httpproxy.ProxyRequest: Set the HTTP method to be sent to the origin server.
setQueryParam(String, String) - Static method in interface io.vertx.httpproxy.interceptors.QueryInterceptor: Add a query parameter to the request.
setStatusCode(int) - Method in interface io.vertx.httpproxy.ProxyResponse: Set the status code to be sent to the user agent.
setStatusMessage(String) - Method in interface io.vertx.httpproxy.ProxyResponse: Set the status message to be sent to the user agent.
setSupportWebSocket(boolean) - Method in class io.vertx.httpproxy.ProxyOptions: Set whether WebSocket are supported.
setURI(String) - Method in interface io.vertx.httpproxy.ProxyRequest: Set the request URI to be sent to the origin server.
stream() - Method in interface io.vertx.httpproxy.Body: Get stream of the Body.

T

toJson() - Method in class io.vertx.httpproxy.cache.CacheOptions
toJson() - Method in class io.vertx.httpproxy.ProxyOptions
toString() - Method in class io.vertx.httpproxy.cache.CacheOptions
toString() - Method in class io.vertx.httpproxy.ProxyOptions
transformJson(Function<Object, Object>) - Static method in interface io.vertx.httpproxy.interceptors.BodyTransformer: Create a callback for transform json with unknown shape.
transformJsonArray(Function<JsonArray, JsonArray>) - Static method in interface io.vertx.httpproxy.interceptors.BodyTransformer: Create a callback for transform JsonArray.
transformJsonObject(Function<JsonObject, JsonObject>) - Static method in interface io.vertx.httpproxy.interceptors.BodyTransformer: Create a callback for transform JsonObject.
transformText(Function<String, String>, String) - Static method in interface io.vertx.httpproxy.interceptors.BodyTransformer: Create a callback for transform texts.

V

version() - Method in interface io.vertx.httpproxy.ProxyRequest

W

WebSocketInterceptor - Interface in io.vertx.httpproxy.interceptors: Interceptor settings for WebSocket.

A B C D E F G H I L M N O P Q R S T V W
All Classes All Packages