A B C D E F G H I L M O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- absoluteURI() - Method in interface io.vertx.httpproxy.ProxyRequest
- addingPathPrefix(String) - Method in interface io.vertx.httpproxy.interceptors.HeadInterceptorBuilder
-
Add a prefix to the URI.
- addInterceptor(ProxyInterceptor) - Method in interface io.vertx.httpproxy.HttpProxy
-
Add an interceptor to the interceptor chain.
- addInterceptor(ProxyInterceptor, boolean) - Method in interface io.vertx.httpproxy.HttpProxy
-
Add an interceptor to the interceptor chain.
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.
- build() - Method in interface io.vertx.httpproxy.interceptors.HeadInterceptorBuilder
- builder() - Static method in interface io.vertx.httpproxy.interceptors.HeadInterceptor
C
- Cache - 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
-
Default constructor.
- CacheOptions(JsonObject) - Constructor for class io.vertx.httpproxy.cache.CacheOptions
-
Constructor to create an options from JSON.
- CacheOptions(CacheOptions) - Constructor for class io.vertx.httpproxy.cache.CacheOptions
-
Copy constructor.
- CacheOptionsConverter - Class in io.vertx.httpproxy.cache
-
Converter and mapper for
CacheOptions
. - CacheOptionsConverter() - Constructor for class io.vertx.httpproxy.cache.CacheOptionsConverter
D
- DEFAULT_MAX_SIZE - Static variable in class io.vertx.httpproxy.cache.CacheOptions
-
Default max size of the cache = 1000
- DEFAULT_NAME - Static variable in class io.vertx.httpproxy.cache.CacheOptions
-
Actual name of anonymous shared cache =
__vertx.DEFAULT
- DEFAULT_SHARED - Static variable in class io.vertx.httpproxy.cache.CacheOptions
-
Default shared cache =
false
- 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
- filteringRequestHeaders(Set<CharSequence>) - Method in interface io.vertx.httpproxy.interceptors.HeadInterceptorBuilder
-
Filter the request headers in the given set.
- filteringResponseHeaders(Set<CharSequence>) - Method in interface io.vertx.httpproxy.interceptors.HeadInterceptorBuilder
-
Filter the response headers in the given set.
G
- get(String) - Method in interface io.vertx.httpproxy.spi.cache.Cache
-
Being called when the proxy attempts to fetch a cache item.
- get(String, Class<T>) - Method in interface io.vertx.httpproxy.ProxyContext
-
Get a payload attached to this context.
- getAbsoluteUri() - Method in class io.vertx.httpproxy.spi.cache.Resource
- 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
- getContent() - Method in class io.vertx.httpproxy.spi.cache.Resource
- getEtag() - Method in class io.vertx.httpproxy.spi.cache.Resource
- getHeaders() - Method in class io.vertx.httpproxy.spi.cache.Resource
- getLastModified() - Method in class io.vertx.httpproxy.spi.cache.Resource
- getMaxAge() - Method in class io.vertx.httpproxy.spi.cache.Resource
- getMaxSize() - Method in class io.vertx.httpproxy.cache.CacheOptions
- getMethod() - Method in interface io.vertx.httpproxy.ProxyRequest
- getName() - Method in class io.vertx.httpproxy.cache.CacheOptions
- getStatusCode() - Method in interface io.vertx.httpproxy.ProxyResponse
-
Get the status code.
- getStatusCode() - Method in class io.vertx.httpproxy.spi.cache.Resource
- getStatusMessage() - Method in interface io.vertx.httpproxy.ProxyResponse
-
Get the status message.
- getStatusMessage() - Method in class io.vertx.httpproxy.spi.cache.Resource
- getSupportWebSocket() - Method in class io.vertx.httpproxy.ProxyOptions
- getTimestamp() - Method in class io.vertx.httpproxy.spi.cache.Resource
- 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
- HeadInterceptor - Interface in io.vertx.httpproxy.interceptors
-
An interceptor updating HTTP request/response head attributes (headers, path, query params).
- HeadInterceptorBuilder - Interface in io.vertx.httpproxy.interceptors
-
Configuration for an interceptor updating HTTP request/response head attributes (headers, path, query params).
- 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
- isShared() - Method in class io.vertx.httpproxy.cache.CacheOptions
- isWebSocket() - Method in interface io.vertx.httpproxy.ProxyContext
L
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.
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
- 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
- put(String, Resource) - Method in interface io.vertx.httpproxy.spi.cache.Cache
-
Being called when the proxy attempts to add a new cache item.
- 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.
R
- readFromBuffer(int, Buffer) - Method in class io.vertx.httpproxy.spi.cache.Resource
- 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.
- remove(String) - Method in interface io.vertx.httpproxy.spi.cache.Cache
-
Being called when the proxy attempts to delete a cache item, typically caused by invalidating an existing item.
- removingPathPrefix(String) - Method in interface io.vertx.httpproxy.interceptors.HeadInterceptorBuilder
-
Remove a prefix to the URI.
- removingQueryParam(String) - Method in interface io.vertx.httpproxy.interceptors.HeadInterceptorBuilder
-
Remove a query parameter from the request.
- request() - Method in interface io.vertx.httpproxy.ProxyContext
- request() - Method in interface io.vertx.httpproxy.ProxyResponse
-
Return the corresponding
ProxyRequest
. - Resource - Class in io.vertx.httpproxy.spi.cache
-
The cached object.
- Resource() - Constructor for class io.vertx.httpproxy.spi.cache.Resource
- Resource(String, int, String, MultiMap, long, long) - Constructor for class io.vertx.httpproxy.spi.cache.Resource
- 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.
- setAbsoluteUri(String) - Method in class io.vertx.httpproxy.spi.cache.Resource
- setAuthority(HostAndPort) - Method in interface io.vertx.httpproxy.ProxyRequest
-
Set the request authority.
- 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.
- setContent(Buffer) - Method in class io.vertx.httpproxy.spi.cache.Resource
- setEtag(String) - Method in class io.vertx.httpproxy.spi.cache.Resource
- setHeaders(MultiMap) - Method in class io.vertx.httpproxy.spi.cache.Resource
- setLastModified(Instant) - Method in class io.vertx.httpproxy.spi.cache.Resource
- setMaxAge(long) - Method in class io.vertx.httpproxy.spi.cache.Resource
- 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.
- setName(String) - Method in class io.vertx.httpproxy.cache.CacheOptions
-
Set the cache name, used when the cache is shared, otherwise ignored.
- setShared(boolean) - Method in class io.vertx.httpproxy.cache.CacheOptions
-
Set to
true
to share the cache. - setStatusCode(int) - Method in interface io.vertx.httpproxy.ProxyResponse
-
Set the status code to be sent to the user agent.
- setStatusCode(int) - Method in class io.vertx.httpproxy.spi.cache.Resource
- setStatusMessage(String) - Method in interface io.vertx.httpproxy.ProxyResponse
-
Set the status message to be sent to the user agent.
- setStatusMessage(String) - Method in class io.vertx.httpproxy.spi.cache.Resource
- setSupportWebSocket(boolean) - Method in class io.vertx.httpproxy.ProxyOptions
-
Set whether WebSocket are supported.
- setTimestamp(long) - Method in class io.vertx.httpproxy.spi.cache.Resource
- settingQueryParam(String, String) - Method in interface io.vertx.httpproxy.interceptors.HeadInterceptorBuilder
-
Add a query parameter to the request.
- 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
-
Convert to JSON.
- 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.
U
- updatingPath(Function<String, String>) - Method in interface io.vertx.httpproxy.interceptors.HeadInterceptorBuilder
-
Apply a callback to change the request URI when the proxy receives it.
- updatingQueryParams(Handler<MultiMap>) - Method in interface io.vertx.httpproxy.interceptors.HeadInterceptorBuilder
-
Apply modifications to the query parameters.
- updatingRequestHeaders(Handler<MultiMap>) - Method in interface io.vertx.httpproxy.interceptors.HeadInterceptorBuilder
-
Apply callbacks to change the request headers when the proxy receives them.
- updatingResponseHeaders(Handler<MultiMap>) - Method in interface io.vertx.httpproxy.interceptors.HeadInterceptorBuilder
-
Apply callbacks to change the response headers when the proxy receives them.
V
- version() - Method in interface io.vertx.httpproxy.ProxyRequest
W
- writeToBuffer(Buffer) - Method in class io.vertx.httpproxy.spi.cache.Resource
All Classes All Packages