Index
All Classes|All Packages
A
- afterResponse(HttpResponse<?>, HttpClientRequest) - Method in class io.avaje.http.client.BasicAuthIntercept
- afterResponse(HttpResponse<?>, HttpClientRequest) - Method in interface io.avaje.http.client.RequestIntercept
-
After the response has been received.
- 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.HttpClientResponse
-
Return the content as InputStream.
- asJson(byte[]) - Static method in class io.avaje.http.client.BodyContent
-
Create and return as JSON body content given raw content.
- asLines() - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the content as a stream of string lines.
- 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.
- 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 - Interface in io.avaje.http.client
-
Use to obtain an Authorization bearer token that is expected to be used.
B
- 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 io.avaje.http.client.HttpException
-
Return the response body content as a 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
- 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
- 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(Object) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set the body as a bean using the default content type.
- 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.
- 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 - Interface in io.avaje.http.client
-
Adaptor between beans and content of a request or response.
- bodyAsBytes() - Method in exception io.avaje.http.client.HttpException
-
Return the response body content as raw bytes.
- bodyAsString() - Method in exception io.avaje.http.client.HttpException
-
Return the response body content as a UTF8 string.
- BodyContent - Class in io.avaje.http.client
-
Content of request or response body used for adapting to beans.
- BodyContent(String, byte[]) - Constructor for class io.avaje.http.client.BodyContent
-
Create with content type and content.
- BodyReader<T> - Interface in io.avaje.http.client
-
Read content as a java type.
- BodyWriter - Interface in io.avaje.http.client
-
Writes beans as content for a specific content type.
- build() - Method in interface io.avaje.http.client.HttpClientContext.Builder
-
Build and return the context.
- build() - Method in class io.avaje.http.client.UrlBuilder
-
Return the full URL.
C
- call() - Method in interface io.avaje.http.client.HttpClientResponse
-
Return a HttpCall which allows either sync or async execution of the request.
- checkResponse(HttpResponse<?>) - Method in interface io.avaje.http.client.HttpClientContext
-
Check the response status code and throw HttpException if the status code is in the error range.
- content() - Method in class io.avaje.http.client.BodyContent
-
Return the raw content.
- contentType() - Method in class io.avaje.http.client.BodyContent
-
Return the content type.
- converters() - Method in interface io.avaje.http.client.HttpClientContext
-
Return the body adapter used by the client context.
- create(Class<T>) - Method in interface io.avaje.http.client.HttpClientContext
-
Return the http client API implementation.
D
- decodeContent(String, byte[]) - Method in interface io.avaje.http.client.HttpClientContext
-
Decode the body using the given encoding.
- decodeContent(HttpResponse<byte[]>) - Method in interface io.avaje.http.client.HttpClientContext
-
Decode the response content given the
Content-Encoding
http header. - delete() - Method in interface io.avaje.http.client.HttpClientRequest
-
Deprecated.
- DELETE() - Method in interface io.avaje.http.client.HttpClientRequest
-
Execute the request as a DELETE.
E
- enc(String) - Static method in class 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
- execute() - Method in interface io.avaje.http.client.HttpCall
-
Execute the request returning the result.
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.
G
- get() - Method in interface io.avaje.http.client.HttpClientRequest
-
Deprecated.
- GET() - Method in interface io.avaje.http.client.HttpClientRequest
-
Execute the request as a GET.
- getHttpResponse() - Method in exception io.avaje.http.client.HttpException
-
Deprecated.
- getStatusCode() - Method in exception io.avaje.http.client.HttpException
-
Deprecated.
- gzip(boolean) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set if body content should be gzip encoded.
H
- 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.
- 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() - Method in interface io.avaje.http.client.HttpClientContext
-
Return the underlying http client.
- HttpClientContext - Interface in io.avaje.http.client
-
The HTTP client context that we use to build and process requests.
- HttpClientContext.Builder - Interface in io.avaje.http.client
-
Builds the HttpClientContext.
- 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 in io.avaje.http.client
-
HTTP Exception with support for converting the error response body into a bean.
- HttpException(int, String) - Constructor for exception io.avaje.http.client.HttpException
-
Create with status code and message.
- HttpException(int, String, Throwable) - Constructor for exception io.avaje.http.client.HttpException
-
Create with status code, message and throwable.
- HttpException(int, Throwable) - Constructor for exception io.avaje.http.client.HttpException
-
Create with status code and throwable.
- httpResponse() - Method in exception 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.
- 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.
- 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(ObjectMapper) - Constructor for class io.avaje.http.client.JacksonBodyAdapter
- JSON_UTF8 - Static variable in class io.avaje.http.client.BodyContent
L
- 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.
- 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
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 class 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 class io.avaje.http.client.UrlBuilder
-
Append a matrix parameter.
N
- newBuilder() - Static method in interface io.avaje.http.client.HttpClientContext
-
Return the builder to config and build the client context.
O
- obtainToken(HttpClientRequest) - Method in interface io.avaje.http.client.AuthTokenProvider
-
Obtain a new Authorization token.
- 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
-
Deprecated.
- 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 class 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 class 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 class 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 class 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
-
Deprecated.
- POST() - Method in interface io.avaje.http.client.HttpClientRequest
-
Execute the request as a POST.
- provide(HttpClientContext) - Method in interface io.avaje.http.client.HttpApiProvider
-
Return the provided implementation of the API.
- put() - Method in interface io.avaje.http.client.HttpClientRequest
-
Deprecated.
- 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 Integer query parameter
- queryParam(String, Object) - Method in class 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 class io.avaje.http.client.UrlBuilder
-
Append a query parameter.
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.
- readContent(HttpResponse<byte[]>) - Method in interface io.avaje.http.client.HttpClientContext
-
Return the response content taking into account content encoding.
- request() - Method in interface io.avaje.http.client.HttpClientContext
-
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 - Interface in io.avaje.http.client
-
Interceptor for before the request is made and after the response is obtained.
- 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.
- 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.
- 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.
- responseTimeNanos() - Method in interface io.avaje.http.client.RequestListener.Event
-
Return the time from request to response in nanos.
- RetryHandler - Interface in io.avaje.http.client
-
Define how retry should occur on a request.
S
- SimpleRetryHandler - Class in io.avaje.http.client
-
Simple retry with max attempts and linear backoff.
- SimpleRetryHandler(int, long) - 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.
- statusCode() - Method in exception 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.
- suppressLogging() - Method in interface io.avaje.http.client.HttpClientRequest
-
For this request suppress payload logging.
T
- 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.
- TRACE() - Method in interface io.avaje.http.client.HttpClientRequest
-
Execute the request as a TRACE.
- type() - Method in interface io.avaje.http.client.HttpApiProvider
-
Return the interface type this API implements.
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.HttpClientContext
-
Return a UrlBuilder to use to build an URL taking into account the base URL.
- url(String) - Method in interface io.avaje.http.client.HttpClientRequest
-
Set the URL to use replacing the base URL.
- url(String) - Method in class io.avaje.http.client.UrlBuilder
-
Set the url.
- UrlBuilder - Class in io.avaje.http.client
-
Build a URL typically using a base url and adding path and query parameters.
- UrlBuilder(String) - Constructor for class io.avaje.http.client.UrlBuilder
-
Create with a base url.
W
- with(HttpClient) - Method in interface io.avaje.http.client.HttpClientContext.Builder
-
Set the underlying HttpClient to use.
- withAuthTokenProvider(AuthTokenProvider) - Method in interface io.avaje.http.client.HttpClientContext.Builder
-
Add a Authorization token provider.
- withBaseUrl(String) - Method in interface io.avaje.http.client.HttpClientContext.Builder
-
Set the base URL to use for requests created from the context.
- withBodyAdapter(BodyAdapter) - Method in interface io.avaje.http.client.HttpClientContext.Builder
-
Set the body adapter to use to convert beans to body content and response content back to beans.
- withCookieHandler(CookieHandler) - Method in interface io.avaje.http.client.HttpClientContext.Builder
-
Specify a cookie handler to use on the HttpClient.
- withExecutor(Executor) - Method in interface io.avaje.http.client.HttpClientContext.Builder
-
Specify the Executor to use for asynchronous tasks.
- withHandler(HttpResponse.BodyHandler<E>) - Method in interface io.avaje.http.client.HttpAsyncResponse
-
Process with any given
HttpResponse.BodyHandler
. - withHandler(HttpResponse.BodyHandler<E>) - Method in interface io.avaje.http.client.HttpCallResponse
-
Call using any given
HttpResponse.BodyHandler
. - withHandler(HttpResponse.BodyHandler<T>) - Method in interface io.avaje.http.client.HttpClientResponse
-
Return the response using the given response body handler.
- withRedirect(HttpClient.Redirect) - Method in interface io.avaje.http.client.HttpClientContext.Builder
-
Specify the redirect policy.
- withRequestIntercept(RequestIntercept) - Method in interface io.avaje.http.client.HttpClientContext.Builder
-
Add a request interceptor.
- withRequestListener(RequestListener) - Method in interface io.avaje.http.client.HttpClientContext.Builder
-
Add a request listener.
- withRequestTimeout(Duration) - Method in interface io.avaje.http.client.HttpClientContext.Builder
-
Set the default request timeout.
- withResponseHandler(HttpResponse.BodyHandler<T>) - Method in interface io.avaje.http.client.HttpClientResponse
-
Deprecated.
- withRetryHandler(RetryHandler) - Method in interface io.avaje.http.client.HttpClientContext.Builder
-
Set a RetryHandler to use to retry requests.
- withVersion(HttpClient.Version) - Method in interface io.avaje.http.client.HttpClientContext.Builder
-
Specify the HTTP version.
- write(Object) - Method in interface io.avaje.http.client.BodyWriter
-
Write the bean as content using the default content type.
- write(Object, String) - Method in interface io.avaje.http.client.BodyWriter
-
Write the bean as content with the requested content type.
All Classes|All Packages