Module methanol

Package com.github.mizosoft.methanol

Interface Summary

Interface	Description
BodyAdapter	An object that converts objects to or from request or response bodies respectively, using a defined format.
BodyAdapter.Decoder	A BodyAdapter that decodes response bodies into objects.
BodyAdapter.Encoder	A BodyAdapter that encodes objects into request bodies.
BodyAdapter.Hints	A collection of hints that provide additional context to customize an adapter's encoding/decoding behavior.
BodyDecoder<T>	A HttpResponse.BodySubscriber that decodes the response body for consumption by a downstream subscriber.
BodyDecoder.Factory	A factory of BodyDecoder instances for some defined encoding.
CacheAwareResponse<T>	A TrackedResponse that knows it may have been generated from an HTTP cache.
HeadersAccumulator<T extends HeadersAccumulator<T>>	An accumulator of header name-value pairs.
HttpCache.Listener	A listener to request/response & read/write events within the cache.
HttpCache.Stats	Statistics of an HttpCache.
HttpCache.StatsRecorder	Strategy for recoding HttpCache statistics.
Methanol.Interceptor	An object that intercepts requests before being sent and responses before being returned.
Methanol.Interceptor.Chain<T>	An object that gives interceptors the ability to relay requests to sibling interceptors, till eventually being sent by the client's backend.
MimeBodyPublisher	A BodyPublisher with a media type.
ProgressTracker.Listener	A listener of progress events.
ProgressTracker.MultipartListener	A ProgressTracker.Listener of multipart progress events.
ProgressTracker.MultipartProgress	A progress event for a multipart body with per-part progress info.
ProgressTracker.Progress	A progress event.
ResponsePayload	A response body that is yet to be handled into the desirable type.
RetryInterceptor.BackoffStrategy	A strategy for backing off (delaying) before a retry.
RetryInterceptor.Context<T>	Context for deciding whether an HTTP call should be retried.
RetryInterceptor.Listener	A listener for RetryInterceptor events.
StorageExtension	An extension that provides a storage backend for an HttpCache.
TaggableRequest.Builder	An HttpRequest.Builder that allows attaching tags.
TrackedResponse<T>	A response with recorded send/receive timestamps.

Class Summary

Class	Description
AdapterCodec	A group of adapters (encoders & decoders), typically targeting different mapping schemes, that facilitates creating corresponding HttpRequest.BodyPublisher, HttpResponse.BodyHandler and HttpResponse.BodySubscriber implementations.
AdapterCodec.Builder	A builder of AdapterCodec instances.
BodyAdapter.Hints.Builder	A builder of Hint objects.
CacheControl	A group of cache directives.
CacheControl.Builder	A builder of CacheControl instances, with explicit directive setters for request cache directives.
FormBodyPublisher	A BodyPublisher for form submission using the application/x-www-form-urlencoded request type.
FormBodyPublisher.Builder	A builder of FormBodyPublisher instances.
HttpCache	An HTTP cache that resides between a Methanol client and its backend HttpClient.
HttpCache.Builder	A builder of HttpCaches.
HttpStatus	Static functions for checking response status codes.
MediaType	A MIME type.
Methanol	An HttpClient with interceptors, request decoration, HTTP caching and reactive extensions.
Methanol.BaseBuilder<B extends Methanol.BaseBuilder<B>>	A base Methanol builder allowing to set the non-standard properties.
Methanol.Builder	A builder of Methanol instances.
Methanol.WithClientBuilder	A builder for Methanol instances with a pre-specified backend HttpClient.
MoreBodyHandlers	Static factories for additional HttpResponse.BodyHandler implementations.
MoreBodyPublishers	Static factories for additional HttpRequest.BodyPublisher implementations.
MoreBodySubscribers	Static factories for additional HttpResponse.BodySubscriber implementations.
MultipartBodyPublisher	A BodyPublisher for multipart bodies.
MultipartBodyPublisher.Builder	A builder of MultipartBodyPublisher instances.
MultipartBodyPublisher.Part	A part in a multipart request body.
MutableRequest	A mutable HttpRequest that supports tags, relative URIs & setting arbitrary objects as request bodies.
ProgressTracker	A progress tracker for upload and download operations.
ProgressTracker.Builder	A builder of ProgressTrackers.
ResponseBuilder<T>	A builder of HttpResponse instances.
RetryInterceptor	An interceptor that retries HTTP requests based on configurable conditions.
RetryInterceptor.Builder	A builder of RetryInterceptor instances.
TaggableRequest	An HttpRequest that can carry arbitrary values, referred to as tags.
TypeRef<T>	A generic object that holds a reference to the Type of its generic argument TypeRef.
WritableBodyPublisher	A BodyPublisher that allows streaming the body's content through an OutputStream or a WritableByteChannel.

Enum Summary

Enum	Description
CacheAwareResponse.CacheStatus	The status of an attempt to retrieve an HTTP response from cache.

Exception Summary

Exception	Description
HttpHeadersTimeoutException	Thrown when all response headers aren't received within a timeout.
HttpReadTimeoutException	Thrown when a body subscriber doesn't receive a requested signal within a timeout.
HttpRetriesExhaustedException	Thrown when a RetryInterceptor exhausts maximum retries.