Index
All Classes and Interfaces|All Packages|Serialized Form
A
- afterResponse(HttpResponse<?>, HttpClientRequest) - Method in interface io.avaje.http.client.RequestIntercept
-
After the response has been received.
- as(Class<E>) - Method in interface io.avaje.http.client.HttpAsyncResponse
-
Process converting the response body to the given type.
- as(Class<E>) - Method in interface io.avaje.http.client.HttpCallResponse
-
A bean response to execute async or sync.
- as(Class<T>) - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the response with the body containing a single instance of the given type.
- as(Type) - Method in interface io.avaje.http.client.HttpAsyncResponse
-
The same as
HttpAsyncResponse.as(Class)
but using a generic type. - as(Type) - Method in interface io.avaje.http.client.HttpCallResponse
-
Same as
HttpCallResponse.as(Class)
but takes a generic parameterized type. - as(Type) - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the response with the body containing a single instance of the given type.
- asByteArray() - Method in interface io.avaje.http.client.HttpAsyncResponse
-
Process as response HttpResponse<byte[]>.
- asByteArray() - Method in interface io.avaje.http.client.HttpCallResponse
-
Process as response HttpResponse<byte[]>.
- asByteArray() - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the content as byte array.
- asDiscarding() - Method in interface io.avaje.http.client.HttpAsyncResponse
-
Process discarding response body as HttpResponse<Void>.
- asDiscarding() - Method in interface io.avaje.http.client.HttpCallResponse
-
Process discarding response body as HttpResponse<Void>.
- asDiscarding() - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the response discarding the response content.
- asFile(Path) - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the content into the given file.
- asInputStream() - Method in interface io.avaje.http.client.HttpAsyncResponse
-
Process as response HttpResponse<InputStream>.
- asInputStream() - Method in interface io.avaje.http.client.HttpCallResponse
-
Process as response HttpResponse<InputStream>.
- asInputStream() - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the content as InputStream.
- asJson(byte[]) - Static method in interface io.avaje.http.client.BodyContent
-
Create BodyContent for JSON byte[] content.
- asLines() - Method in interface io.avaje.http.client.HttpAsyncResponse
-
Process as response HttpResponse<Stream<String>>.
- asLines() - Method in interface io.avaje.http.client.HttpCallResponse
-
Process as response HttpResponse<Stream<String>>.
- asLines() - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the content as a stream of string lines.
- asList(Class<E>) - Method in interface io.avaje.http.client.HttpAsyncResponse
-
Process converting the response body to a list of the given type.
- asList(Class<E>) - Method in interface io.avaje.http.client.HttpCallResponse
-
Same as
HttpCallResponse.as(Class)
but returnsHttpResponse<List<E>>
. - asList(Class<T>) - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the response with the body containing a list of the given type.
- asList(Type) - Method in interface io.avaje.http.client.HttpAsyncResponse
-
The same as
HttpAsyncResponse.asList(Class)
but using a generic type. - asList(Type) - Method in interface io.avaje.http.client.HttpCallResponse
-
Same as
HttpCallResponse.as(Class)
but returnsHttpResponse<List<E>>
. - asList(Type) - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the response with the body containing a list of the given type.
- asPlainString() - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the content as string with check for 200 range status code.
- asStream(Class<E>) - Method in interface io.avaje.http.client.HttpAsyncResponse
-
Process converting the response body to a stream of the given type.
- asStream(Class<E>) - Method in interface io.avaje.http.client.HttpCallResponse
-
Same as
HttpCallResponse.as(Class)
but returnsHttpResponse<Stream<E>>
. - asStream(Class<T>) - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the response with the body containing a stream of beans of the given type.
- asStream(Type) - Method in interface io.avaje.http.client.HttpAsyncResponse
-
The same as
HttpAsyncResponse.asStream(Class)
but using a generic type. - asStream(Type) - Method in interface io.avaje.http.client.HttpCallResponse
-
Same as
HttpCallResponse.as(Class)
but returnsHttpResponse<Stream<E>>
. - asStream(Type) - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the response with the body containing a stream of beans of the given type.
- asString() - Method in interface io.avaje.http.client.HttpAsyncResponse
-
Process as String response body HttpResponse<String>.
- asString() - Method in interface io.avaje.http.client.HttpCallResponse
-
Process as String response body HttpResponse<String>.
- asString() - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the content as string.
- asVoid() - Method in interface io.avaje.http.client.HttpAsyncResponse
-
Process the response with check for 200 range status code returning as HttpResponse<Void>.
- asVoid() - Method in interface io.avaje.http.client.HttpCallResponse
-
Process the response with check for 200 range status code returning as HttpResponse<Void>.
- asVoid() - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the response with check for 200 range status code.
- async() - Method in interface io.avaje.http.client.HttpCall
-
Execute the request asynchronously.
- async() - Method in interface io.avaje.http.client.HttpClientResponse
-
Send the request async using CompletableFuture.
- authenticator(Authenticator) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Set a HttpClient authenticator to the underlying
HttpClient
. - AuthToken - Interface in io.avaje.http.client
-
Represents an Authorization Bearer token that can be held on the context.
- AuthToken.Basic - Class in io.avaje.http.client
-
Standard AuthToken implementation.
- authTokenProvider(AuthTokenProvider) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Add a Authorization token provider.
- AuthTokenProvider - Interface in io.avaje.http.client
-
Use to obtain an Authorization bearer token that is expected to be used.
- avgMicros() - Method in interface io.avaje.http.client.HttpClient.Metrics
-
Return the average response time in microseconds.
B
- baseUrl() - Method in interface io.avaje.http.client.HttpClient.Builder.State
-
Return the base URL.
- baseUrl(String) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Set the base URL to use for requests created from the context.
- Basic(String, Instant) - Constructor for class io.avaje.http.client.AuthToken.Basic
-
Create with token and valid until time.
- BasicAuthIntercept - Class in io.avaje.http.client
-
Adds Basic Authorization header to requests.
- BasicAuthIntercept(String, String) - Constructor for class io.avaje.http.client.BasicAuthIntercept
-
Construct with the username and password.
- bean(Class<E>) - Method in interface io.avaje.http.client.HttpAsyncResponse
-
Process expecting a bean response body (typically from json content).
- bean(Class<E>) - Method in interface io.avaje.http.client.HttpCallResponse
-
A bean response to execute async or sync.
- bean(Class<T>) - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the response as a single bean.
- bean(Class<T>) - Method in exception class io.avaje.http.client.HttpException
-
Return the response body content as a bean, or else null if body content doesn't exist.
- bean(Type) - Method in interface io.avaje.http.client.HttpAsyncResponse
-
Process expecting a bean response body (typically from json content).
- bean(Type) - Method in interface io.avaje.http.client.HttpCallResponse
-
A bean response to execute async or sync.
- bean(Type) - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the response as a single bean.
- beanReader(Class<T>) - Method in interface io.avaje.http.client.BodyAdapter
-
Return a BodyReader to read response content and convert to a bean.
- beanReader(Class<T>) - Method in class io.avaje.http.client.JacksonBodyAdapter
- beanReader(Class<T>) - Method in class io.avaje.http.client.JsonbBodyAdapter
- beanReader(Type) - Method in interface io.avaje.http.client.BodyAdapter
-
Return a BodyReader to read response content and convert to a bean.
- beanReader(Type) - Method in class io.avaje.http.client.JsonbBodyAdapter
- beanWriter(Class<?>) - Method in interface io.avaje.http.client.BodyAdapter
-
Return a BodyWriter to write beans of this type as request content.
- beanWriter(Class<?>) - Method in class io.avaje.http.client.JacksonBodyAdapter
- beanWriter(Class<?>) - Method in class io.avaje.http.client.JsonbBodyAdapter
- beanWriter(Type) - Method in interface io.avaje.http.client.BodyAdapter
-
Return a BodyWriter to write beans of this type as request content.
- beanWriter(Type) - Method in class io.avaje.http.client.JsonbBodyAdapter
- beforeRequest(HttpClientRequest) - Method in class io.avaje.http.client.BasicAuthIntercept
- beforeRequest(HttpClientRequest) - Method in interface io.avaje.http.client.RequestIntercept
-
Before the request has been made.
- body(byte[]) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set the body content as a bytes.
- body(BodyContent) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set encoded body content.
- body(InputStream) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set the body content with supplied InputStream.
- body(Object) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set the body as a bean using the default content type.
- body(Object, Class<?>) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set the body as a bean additionally specifying the type that will be used to serialise the content (e.g.
- body(Object, Class<?>, String) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set the body as a bean with the given content type and additionally specifying the type that will be used to serialise the content (e.g.
- body(Object, Type) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set the body as a bean additionally specifying the type that will be used to serialise the content (e.g.
- body(Object, String) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set the body as a bean with the given content type using a BodyWriter.
- body(String) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set the body content as a string using the default content type.
- body(HttpRequest.BodyPublisher) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set the body content using http BodyPublisher.
- body(Path) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set the body content with supplied InputStream.
- body(Supplier<? extends InputStream>) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set the body content with supplied InputStream.
- bodyAdapter() - Method in interface io.avaje.http.client.HttpClient
-
Return the BodyAdapter that this client is using.
- bodyAdapter() - Method in interface io.avaje.http.client.HttpClient.Builder.State
-
Return the body adapter.
- bodyAdapter(BodyAdapter) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Set the body adapter to use to convert beans to body content and response content back to beans.
- BodyAdapter - Interface in io.avaje.http.client
-
Adaptor between beans and content of a request or response.
- bodyAsBytes() - Method in exception class io.avaje.http.client.HttpException
-
Return the response body content as raw bytes, or else null if body content doesn't exist.
- bodyAsString() - Method in exception class io.avaje.http.client.HttpException
-
Return the response body content as a UTF8 string, or else null if body content doesn't exist.
- bodyContent() - Method in interface io.avaje.http.client.HttpClientRequest
-
Get the body content for this request if available.
- BodyContent - Interface in io.avaje.http.client
-
Content of request or response body used for adapting to beans.
- BodyReader<T> - Interface in io.avaje.http.client
-
Read content as a java type.
- BodyWriter<T> - Interface in io.avaje.http.client
-
Writes beans as content for a specific content type.
- build() - Method in interface io.avaje.http.client.HttpClient.Builder
-
Build and return the context.
- build() - Method in interface io.avaje.http.client.UrlBuilder
-
Return the full URL.
- builder() - Static method in interface io.avaje.http.client.HttpClient
-
Return the builder to config and build the client context.
C
- call() - Method in interface io.avaje.http.client.HttpClientResponse
-
Return a HttpCall which allows either sync or async execution of the request.
- client() - Method in interface io.avaje.http.client.HttpClient.Builder.State
-
Return the HttpClient.
- client(HttpClient) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Set the underlying HttpClient to use.
- configureWith(BeanScope) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Configure BodyAdapter and RetryHandler using dependency injection BeanScope.
- connectionTimeout(Duration) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Set the connection timeout to use.
- content() - Method in interface io.avaje.http.client.BodyContent
-
Return the content as bytes.
- contentAsUtf8() - Method in interface io.avaje.http.client.BodyContent
-
Return the content as UTF8 string.
- contentType() - Method in interface io.avaje.http.client.BodyContent
-
Return the content type.
- contentType() - Method in exception class io.avaje.http.client.HttpException
-
Return the response Content-Type header.
- cookieHandler(CookieHandler) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Specify a cookie handler to use on the HttpClient.
- create(Class<T>) - Method in interface io.avaje.http.client.HttpClient
-
Return the http client API implementation.
D
- DELETE() - Method in interface io.avaje.http.client.HttpClientRequest
-
Execute the request as a DELETE.
E
- enc(String) - Static method in interface io.avaje.http.client.UrlBuilder
-
URL encode the value.
- encode(String, String) - Static method in class io.avaje.http.client.BasicAuthIntercept
-
Return Base64 encoding of username:password
- errorCount() - Method in interface io.avaje.http.client.HttpClient.Metrics
-
Return the total number of error responses (status code >= 300).
- errorMapper(Function<HttpException, RuntimeException>) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set the mapper used to transform
HttpException
into a different kind of exception. - Example: line subscriber - Search tag in io.avaje.http.client.HttpAsyncResponse.handler(HttpResponse.BodyHandler<E>)
- Section
- Example async().bean() - Search tag in interface io.avaje.http.client.HttpAsyncResponse
- Section
- Example async().bean() - Search tag in io.avaje.http.client.HttpClientResponse.async()
- Section
- Example catching HttpException - Search tag in exception class io.avaje.http.client.HttpException
- Section
- Example using .join() for testing purposes - Search tag in interface io.avaje.http.client.HttpAsyncResponse
- Section
- execute() - Method in interface io.avaje.http.client.HttpCall
-
Execute the request returning the result.
- executor(Executor) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Specify the Executor to use for asynchronous tasks.
F
- formParam(String, Object) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add a form parameter.
- formParam(String, String) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add a form parameter.
- formParam(Map<String, ?>) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add the form parameters via a map.
G
- GET() - Method in interface io.avaje.http.client.HttpClientRequest
-
Execute the request as a GET.
- getAttribute(String) - Method in interface io.avaje.http.client.HttpClientRequest
-
Return a custom attribute typically set by a
RequestIntercept.beforeRequest(HttpClientRequest)
. - globalErrorMapper(Function<HttpException, RuntimeException>) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Set the default mapper to be used to transform
HttpException
into a different kind of exception. - gzip(boolean) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set if body content should be gzip encoded.
H
- handler(HttpResponse.BodyHandler<E>) - Method in interface io.avaje.http.client.HttpAsyncResponse
-
Process with any given
HttpResponse.BodyHandler
. - handler(HttpResponse.BodyHandler<E>) - Method in interface io.avaje.http.client.HttpCallResponse
-
Call using any given
HttpResponse.BodyHandler
. - handler(HttpResponse.BodyHandler<T>) - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the response using the given response body handler.
- HEAD() - Method in interface io.avaje.http.client.HttpClientRequest
-
Execute the request as a HEAD.
- header(String) - Method in interface io.avaje.http.client.HttpClientRequest
-
Return the header values that have been set for the given header name.
- header(String, Object) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add the header to the request implicitly converting the value to a String.
- header(String, String) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add the header to the request.
- header(String, Collection<String>) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add the headers to the request via Collection.
- header(Map<String, ?>) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add the headers to the request via map.
- headerAddIfAbsent(String, Object) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add the header to the request but only if there is no existing value for the given header.
- headers() - Method in interface io.avaje.http.client.HttpClientRequest
-
Return the header values that have been set for this request.
- HttpApiProvider<T> - Interface in io.avaje.http.client
-
Provides http client implementations for an interface.
- HttpAsyncResponse - Interface in io.avaje.http.client
-
Async processing of the request with responses as CompletableFuture.
- HttpCall<E> - Interface in io.avaje.http.client
-
Allows for executing the request asynchronously or synchronously.
- HttpCallResponse - Interface in io.avaje.http.client
-
Allows the client code to choose to execute the request asynchronously or synchronously.
- HttpClient - Interface in io.avaje.http.client
-
The HTTP client context that we use to build and process requests.
- HttpClient.Builder - Interface in io.avaje.http.client
-
Builds the HttpClient.
- HttpClient.Builder.State - Interface in io.avaje.http.client
-
The state of the builder with methods to read the set state.
- HttpClient.GeneratedComponent - Interface in io.avaje.http.client
-
Components register Generated Client interface Providers
- HttpClient.Metrics - Interface in io.avaje.http.client
-
Statistic metrics collected to provide an overview of activity of this client.
- HttpClientRequest - Interface in io.avaje.http.client
-
Http request that is built and sent to the server.
- HttpClientResponse - Interface in io.avaje.http.client
-
Controls how the response is processed including potential conversion into beans.
- HttpException - Exception Class in io.avaje.http.client
-
HTTP Exception with support for converting the error response body into a bean.
- HttpException(int, String) - Constructor for exception class io.avaje.http.client.HttpException
-
Create with status code and message.
- HttpException(int, String, Throwable) - Constructor for exception class io.avaje.http.client.HttpException
-
Create with status code, message and throwable.
- HttpException(int, Throwable) - Constructor for exception class io.avaje.http.client.HttpException
-
Create with status code and throwable.
- httpResponse() - Method in exception class io.avaje.http.client.HttpException
-
Return the underlying HttpResponse.
I
- io.avaje.http.client - module io.avaje.http.client
- io.avaje.http.client - package io.avaje.http.client
-
Provides a HTTP client with support for adapting body content (like JSON) to java types.
- isExceptionRetry(int, HttpException) - Method in interface io.avaje.http.client.RetryHandler
-
Return true if the request should be retried.
- isExpired() - Method in class io.avaje.http.client.AuthToken.Basic
- isExpired() - Method in interface io.avaje.http.client.AuthToken
-
Return true if the token has expired or is no longer valid.
- isPlainText() - Method in exception class io.avaje.http.client.HttpException
-
Return true if the Content-Type is text/plain.
- isRetry(int, HttpResponse<?>) - Method in interface io.avaje.http.client.RetryHandler
-
Return true if the request should be retried.
- isRetry(int, HttpResponse<?>) - Method in class io.avaje.http.client.SimpleRetryHandler
J
- JacksonBodyAdapter - Class in io.avaje.http.client
-
Jackson BodyAdapter to read and write beans as JSON.
- JacksonBodyAdapter() - Constructor for class io.avaje.http.client.JacksonBodyAdapter
-
Create with a ObjectMapper that allows unknown properties and inclusion non empty.
- JacksonBodyAdapter(ObjectMapper) - Constructor for class io.avaje.http.client.JacksonBodyAdapter
-
Create passing the ObjectMapper to use.
- JsonbBodyAdapter - Class in io.avaje.http.client
-
Avaje Jsonb BodyAdapter to read and write beans as JSON.
- JsonbBodyAdapter() - Constructor for class io.avaje.http.client.JsonbBodyAdapter
-
Create with a default Jsonb that allows unknown properties.
- JsonbBodyAdapter(Jsonb) - Constructor for class io.avaje.http.client.JsonbBodyAdapter
-
Create passing the Jsonb to use.
L
- label() - Method in interface io.avaje.http.client.HttpClientRequest
-
Return the label that has been set on this request.
- label(String) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set a label for the request.
- list(Class<E>) - Method in interface io.avaje.http.client.HttpAsyncResponse
-
Process expecting a list of beans response body (typically from json content).
- list(Class<E>) - Method in interface io.avaje.http.client.HttpCallResponse
-
Process expecting a list of beans response body (typically from json content).
- list(Class<T>) - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the response as a list of beans.
- list(Type) - Method in interface io.avaje.http.client.HttpAsyncResponse
-
Process expecting a list of beans response body (typically from json content).
- list(Type) - Method in interface io.avaje.http.client.HttpCallResponse
-
Process expecting a list of beans response body (typically from json content).
- list(Type) - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the response as a list of beans.
- listReader(Class<T>) - Method in interface io.avaje.http.client.BodyAdapter
-
Return a BodyReader to read response content and convert to a list of beans.
- listReader(Class<T>) - Method in class io.avaje.http.client.JacksonBodyAdapter
- listReader(Class<T>) - Method in class io.avaje.http.client.JsonbBodyAdapter
- listReader(Type) - Method in interface io.avaje.http.client.BodyAdapter
-
Return a BodyReader to read response content and convert to a list of beans.
- listReader(Type) - Method in class io.avaje.http.client.JsonbBodyAdapter
M
- matrixParam(String, Object) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add a matrix parameter to the current path segment.
- matrixParam(String, Object) - Method in interface io.avaje.http.client.UrlBuilder
-
Append a matrix parameter.
- matrixParam(String, String) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add a matrix parameter to the current path segment.
- matrixParam(String, String) - Method in interface io.avaje.http.client.UrlBuilder
-
Append a matrix parameter.
- maxMicros() - Method in interface io.avaje.http.client.HttpClient.Metrics
-
Return the max response time in microseconds (since the last reset).
- method() - Method in interface io.avaje.http.client.HttpClientRequest
-
The Http Verb (GET, POST, PUT etc) of this request.
- metrics() - Method in interface io.avaje.http.client.HttpClient
-
Return the current aggregate metrics.
- metrics(boolean) - Method in interface io.avaje.http.client.HttpClient
-
Return the current metrics with the option of resetting the underlying counters.
O
- obtainToken(HttpClientRequest) - Method in interface io.avaje.http.client.AuthTokenProvider
-
Obtain a new Authorization token.
- of(byte[]) - Static method in interface io.avaje.http.client.BodyContent
-
Create BodyContent with the given byte[] content.
- of(String) - Static method in interface io.avaje.http.client.BodyContent
-
Create BodyContent with the given string content.
- of(String) - Static method in interface io.avaje.http.client.UrlBuilder
-
Create a UrlBuilder with a base url.
- of(String, byte[]) - Static method in interface io.avaje.http.client.BodyContent
-
Create BodyContent with the given the content type and byte[] content.
- of(String, String) - Static method in interface io.avaje.http.client.BodyContent
-
Create BodyContent with the given the content type and string content.
- of(String, Instant) - Static method in interface io.avaje.http.client.AuthToken
-
Create an return a AuthToken with the given token and time it is valid until.
P
- PATCH() - Method in interface io.avaje.http.client.HttpClientRequest
-
Execute the request as a PATCH.
- path(int) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add a path segment to the URL.
- path(int) - Method in interface io.avaje.http.client.UrlBuilder
-
Add a path segment to the url.
- path(long) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add a path segment to the URL.
- path(long) - Method in interface io.avaje.http.client.UrlBuilder
-
Add a path segment to the url.
- path(Object) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add a path segment to the URL.
- path(Object) - Method in interface io.avaje.http.client.UrlBuilder
-
Add a path segment to the url.
- path(String) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add a path segment to the URL.
- path(String) - Method in interface io.avaje.http.client.UrlBuilder
-
Add a path segment to the url.
- PathConversion - Class in io.avaje.http.client
-
Helper methods to convert common types to String path values.
- PathConversion() - Constructor for class io.avaje.http.client.PathConversion
- POST() - Method in interface io.avaje.http.client.HttpClientRequest
-
Execute the request as a POST.
- priority(int) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Set the priority for HTTP/2 requests to the underlying
HttpClient
. - provide(HttpClient) - Method in interface io.avaje.http.client.HttpApiProvider
-
Return the provided implementation of the API.
- proxy(ProxySelector) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Set the proxy to the underlying
HttpClient
. - PUT() - Method in interface io.avaje.http.client.HttpClientRequest
-
Execute the request as a PUT.
Q
- queryParam(String, Object) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add a query parameter, if value is a collection then it's values are appended with the same key
- queryParam(String, Object) - Method in interface io.avaje.http.client.UrlBuilder
-
Append a query parameter.
- queryParam(String, String) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add a query parameter
- queryParam(String, String) - Method in interface io.avaje.http.client.UrlBuilder
-
Append a query parameter.
- queryParam(String, Collection<String>) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add a query parameter with multiple values
- queryParam(Map<String, ?>) - Method in interface io.avaje.http.client.HttpClientRequest
-
Add a multiple query parameters as name value map.
- queryParam(Map<String, ?>) - Method in interface io.avaje.http.client.UrlBuilder
-
Append a query parameters.
R
- read(BodyContent) - Method in interface io.avaje.http.client.BodyReader
-
Read the content returning it as a java type.
- read(BodyReader<T>) - Method in interface io.avaje.http.client.HttpClientResponse
-
Returning the response using the given response reader.
- readBody(String) - Method in interface io.avaje.http.client.BodyReader
-
Read the String content returning it as a java type.
- redirect(HttpClient.Redirect) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Specify the redirect policy.
- register(Map<Class<?>, HttpApiProvider<?>>) - Method in interface io.avaje.http.client.HttpClient.GeneratedComponent
-
Register the HttpApiProviders to the given providerMap.
- request() - Method in interface io.avaje.http.client.HttpClient
-
Create a new request.
- request() - Method in interface io.avaje.http.client.RequestListener.Event
-
Return the related request.
- requestBody() - Method in interface io.avaje.http.client.RequestListener.Event
-
Return the related request body as string content if available.
- requestIntercept(RequestIntercept...) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Add a request interceptor.
- RequestIntercept - Interface in io.avaje.http.client
-
Interceptor for before the request is made and after the response is obtained.
- requestListener(RequestListener...) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Add a request listener.
- RequestListener - Interface in io.avaje.http.client
-
Listen to responses.
- RequestListener.Event - Interface in io.avaje.http.client
-
The response event details.
- RequestLogger - Class in io.avaje.http.client
-
Logs request and response details for debug logging purposes using
System.Logger
. - RequestLogger() - Constructor for class io.avaje.http.client.RequestLogger
-
Create using the \n new line character.
- RequestLogger(String) - Constructor for class io.avaje.http.client.RequestLogger
-
Create with a given line delimiter.
- requestLogging() - Method in interface io.avaje.http.client.HttpClient.Builder.State
-
Return true if requestLogging is on.
- requestLogging(boolean) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Disable or enable built in request and response logging.
- requestTimeout() - Method in interface io.avaje.http.client.HttpClient.Builder.State
-
Return the request timeout.
- requestTimeout(Duration) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Set the default request timeout.
- requestTimeout(Duration) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set the request timeout to use for this request.
- response() - Method in interface io.avaje.http.client.RequestListener.Event
-
Return the response.
- response(RequestListener.Event) - Method in interface io.avaje.http.client.RequestListener
-
Handle the response.
- response(RequestListener.Event) - Method in class io.avaje.http.client.RequestLogger
- responseBody() - Method in interface io.avaje.http.client.RequestListener.Event
-
Return the response body as string content if applicable.
- responseBytes() - Method in interface io.avaje.http.client.HttpClient.Metrics
-
Return the total response bytes (excludes streaming responses).
- responseTimeMicros() - Method in interface io.avaje.http.client.HttpClientRequest
-
After the response is returned this method returns the response time in microseconds.
- responseTimeMicros() - Method in interface io.avaje.http.client.RequestListener.Event
-
Return the time from request to response in nanos.
- retryHandler() - Method in interface io.avaje.http.client.HttpClient.Builder.State
-
Return the retry handler.
- retryHandler(RetryHandler) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Set a RetryHandler to use to retry requests.
- RetryHandler - Interface in io.avaje.http.client
-
Define how retry should occur on a request.
S
- setAttribute(String, Object) - Method in interface io.avaje.http.client.HttpClientRequest
-
Used to pass custom attribute between
RequestIntercept
methods. - SimpleRetryHandler - Class in io.avaje.http.client
-
Simple retry with max attempts and linear backoff.
- SimpleRetryHandler(int, int) - Constructor for class io.avaje.http.client.SimpleRetryHandler
-
Create with maximum number of retries and linear backoff time and no gitter.
- SimpleRetryHandler(int, int, int) - Constructor for class io.avaje.http.client.SimpleRetryHandler
-
Create with maximum number of retries and linear backoff time.
- skipAuthToken() - Method in interface io.avaje.http.client.HttpClientRequest
-
For this request skip using an Authorization token.
- sslContext(SSLContext) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Set the sslContext to the underlying
HttpClient
. - sslParameters(SSLParameters) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Set the sslParameters to the underlying
HttpClient
. - state() - Method in interface io.avaje.http.client.HttpClient.Builder
-
Return the state of the builder.
- statusCode() - Method in exception class io.avaje.http.client.HttpException
-
Return the HTTP status code.
- stream(Class<E>) - Method in interface io.avaje.http.client.HttpAsyncResponse
-
Process response as a stream of beans (x-json-stream).
- stream(Class<E>) - Method in interface io.avaje.http.client.HttpCallResponse
-
Process expecting a stream of beans response body (typically from json content).
- stream(Class<T>) - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the response as a stream of beans.
- stream(Type) - Method in interface io.avaje.http.client.HttpAsyncResponse
-
Process response as a stream of beans (x-json-stream).
- stream(Type) - Method in interface io.avaje.http.client.HttpCallResponse
-
Process expecting a stream of beans response body (typically from json content).
- stream(Type) - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the response as a stream of beans.
- Suppression - Search tag in io.avaje.http.client.HttpClient.Builder.requestLogging(boolean)
- Section
- suppressLogging() - Method in interface io.avaje.http.client.HttpClientRequest
-
For this request suppress payload logging.
T
- Testing and .join() - Search tag in interface io.avaje.http.client.HttpAsyncResponse
- Section
- token() - Method in class io.avaje.http.client.AuthToken.Basic
- token() - Method in interface io.avaje.http.client.AuthToken
-
Return the Authorization bearer token.
- toPath(boolean) - Static method in class io.avaje.http.client.PathConversion
-
Convert to path.
- toPath(double) - Static method in class io.avaje.http.client.PathConversion
-
Convert to path.
- toPath(float) - Static method in class io.avaje.http.client.PathConversion
-
Convert to path.
- toPath(int) - Static method in class io.avaje.http.client.PathConversion
-
Convert to path.
- toPath(long) - Static method in class io.avaje.http.client.PathConversion
-
Convert to path.
- toPath(Object) - Static method in class io.avaje.http.client.PathConversion
-
Convert to path.
- totalCount() - Method in interface io.avaje.http.client.HttpClient.Metrics
-
Return the total number of responses.
- totalMicros() - Method in interface io.avaje.http.client.HttpClient.Metrics
-
Return the total response time in microseconds.
- TRACE() - Method in interface io.avaje.http.client.HttpClientRequest
-
Execute the request as a TRACE.
U
- uri() - Method in interface io.avaje.http.client.RequestListener.Event
-
Return the URI for the request.
- url() - Method in interface io.avaje.http.client.HttpClient
-
Return a UrlBuilder to use to build an URL taking into account the base URL.
- url() - Method in interface io.avaje.http.client.HttpClientRequest
-
The URL for this request including the query parameters.
- url(String) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set the URL to use replacing the base URL.
- url(String) - Method in interface io.avaje.http.client.UrlBuilder
-
Set the url.
- UrlBuilder - Interface in io.avaje.http.client
-
Build a URL typically using a base url and adding path and query parameters.
V
- version(HttpClient.Version) - Method in interface io.avaje.http.client.HttpClient.Builder
-
Specify the HTTP version.
W
- write(T) - Method in interface io.avaje.http.client.BodyWriter
-
Write the bean as content using the default content type.
- write(T, String) - Method in interface io.avaje.http.client.BodyWriter
-
Write the bean as content with the requested content type.
All Classes and Interfaces|All Packages|Serialized Form