Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractHttpClientFactory<T extends HttpClient> - Class in io.micronaut.http.client
-
Abstract class implementation of
HttpClientFactory
. - AbstractHttpClientFactory(MediaTypeCodecRegistry, ConversionService) - Constructor for class io.micronaut.http.client.AbstractHttpClientFactory
- AbstractRoundRobinLoadBalancer - Class in io.micronaut.http.client.loadbalance
- AbstractRoundRobinLoadBalancer() - Constructor for class io.micronaut.http.client.loadbalance.AbstractRoundRobinLoadBalancer
- addBinder(ClientRequestBinder) - Method in class io.micronaut.http.client.bind.DefaultHttpClientBinderRegistry
-
Adds a binder to the registry.
- addFilter(Supplier<GenericHttpFilter>, AnnotationMetadata, BaseFilterProcessor.FilterMetadata) - Method in class io.micronaut.http.client.filter.DefaultHttpClientFilterResolver
- addPart(String, File) - Method in class io.micronaut.http.client.multipart.MultipartBody.Builder
-
Add a file object to MultipartBody.
- addPart(String, String) - Method in class io.micronaut.http.client.multipart.MultipartBody.Builder
-
Add a file object to MultipartBody.
- addPart(String, String, byte[]) - Method in class io.micronaut.http.client.multipart.MultipartBody.Builder
-
Add bytes data to MultipartBody.
- addPart(String, String, MediaType, byte[]) - Method in class io.micronaut.http.client.multipart.MultipartBody.Builder
-
Add bytes data to MultipartBody.
- addPart(String, String, MediaType, File) - Method in class io.micronaut.http.client.multipart.MultipartBody.Builder
-
Add a file object to MultipartBody.
- addPart(String, String, MediaType, InputStream, long) - Method in class io.micronaut.http.client.multipart.MultipartBody.Builder
-
Add a InputStream data to MultipartBody.
- addPart(String, String, File) - Method in class io.micronaut.http.client.multipart.MultipartBody.Builder
-
Add a file object to MultipartBody.
- addPart(String, String, InputStream, long) - Method in class io.micronaut.http.client.multipart.MultipartBody.Builder
-
Add a InputStream data to MultipartBody.
- addQueryParameter(String, String) - Method in class io.micronaut.http.client.bind.ClientRequestUriContext
-
Add a new query parameter given its name.
- ALPN_HTTP_1 - Static variable in class io.micronaut.http.client.HttpVersionSelection
-
ALPN protocol ID for HTTP/1.1.
- ALPN_HTTP_2 - Static variable in class io.micronaut.http.client.HttpVersionSelection
-
ALPN protocol ID for HTTP/2.
- ALPN_HTTP_3 - Static variable in class io.micronaut.http.client.HttpVersionSelection
-
ALPN protocol ID for HTTP/3.
- alpnModes() - Element in annotation interface io.micronaut.http.client.annotation.Client
-
The protocols to support for TLS ALPN.
- AnnotatedClientArgumentRequestBinder<A extends Annotation> - Interface in io.micronaut.http.client.bind
-
An interface for classes that bind an
Argument
to anMutableHttpRequest
driven by an annotation. - AnnotatedClientRequestBinder<A extends Annotation> - Interface in io.micronaut.http.client.bind
-
A binder that binds to a
MutableHttpRequest
. - argumentType() - Method in interface io.micronaut.http.client.bind.TypedClientArgumentRequestBinder
- AttributeClientRequestBinder - Class in io.micronaut.http.client.bind.binders
-
An
AnnotatedClientRequestBinder
implementation forRequestAttribute
. - AttributeClientRequestBinder() - Constructor for class io.micronaut.http.client.bind.binders.AttributeClientRequestBinder
B
- bind(MethodInvocationContext<Object, Object>, ClientRequestUriContext, MutableHttpRequest<?>) - Method in interface io.micronaut.http.client.bind.AnnotatedClientRequestBinder
-
Modify the request with the annotation that this binder is applied to.
- bind(MethodInvocationContext<Object, Object>, ClientRequestUriContext, MutableHttpRequest<?>) - Method in class io.micronaut.http.client.bind.binders.AttributeClientRequestBinder
- bind(MethodInvocationContext<Object, Object>, ClientRequestUriContext, MutableHttpRequest<?>) - Method in class io.micronaut.http.client.bind.binders.HeaderClientRequestBinder
- bind(MethodInvocationContext<Object, Object>, ClientRequestUriContext, MutableHttpRequest<?>) - Method in class io.micronaut.http.client.bind.binders.VersionClientRequestBinder
- bind(ArgumentConversionContext<Object>, ClientRequestUriContext, Object, MutableHttpRequest<?>) - Method in class io.micronaut.http.client.bind.binders.QueryValueClientArgumentRequestBinder
-
If value can be converted to ConvertibleMultiValues, then use it and add it to the uriContext.queryParameters.
- bind(ArgumentConversionContext<T>, ClientRequestUriContext, T, MutableHttpRequest<?>) - Method in interface io.micronaut.http.client.bind.ClientArgumentRequestBinder
-
Bind the given argument to the request.
- BlockingHttpClient - Interface in io.micronaut.http.client
-
A blocking HTTP client interface that features a subset of the operations provided by
HttpClient
and is designed primarily for testing purposes. - build() - Method in class io.micronaut.http.client.multipart.MultipartBody.Builder
-
Creates
MultipartBody
from the provided parts. - build() - Method in class io.micronaut.http.client.ProxyRequestOptions.Builder
-
Build an immutable
ProxyRequestOptions
with the options configured in this builder. - builder() - Static method in class io.micronaut.http.client.multipart.MultipartBody
- builder() - Static method in class io.micronaut.http.client.ProxyRequestOptions
C
- Client - Annotation Interface in io.micronaut.http.client.annotation
-
Allows defining declarative HTTP clients and customizing injection for injecting
HttpClient
implementations. - ClientArgumentRequestBinder<T> - Interface in io.micronaut.http.client.bind
-
A binder that binds to a
MutableHttpRequest
. - ClientFilterResolutionContext - Class in io.micronaut.http.client.filter
-
The client filter resolution context.
- ClientFilterResolutionContext(List<String>, AnnotationMetadata) - Constructor for class io.micronaut.http.client.filter.ClientFilterResolutionContext
-
Default constructor.
- ClientRequestBinder - Interface in io.micronaut.http.client.bind
-
A binder that binds to a
MutableHttpRequest
. - ClientRequestUriContext - Class in io.micronaut.http.client.bind
-
A class that exposes information about the URI to
ClientArgumentRequestBinder
instances. - ClientRequestUriContext(UriMatchTemplate, Map<String, Object>, Map<String, List<String>>) - Constructor for class io.micronaut.http.client.bind.ClientRequestUriContext
- ClientServerContextFilter - Class in io.micronaut.http.client.filters
-
A client filter that propagates the request context.
- ClientServerContextFilter(HttpRequest<?>) - Constructor for class io.micronaut.http.client.filters.ClientServerContextFilter
-
Default constructor.
- ClientVersioningConfiguration - Class in io.micronaut.http.client.interceptor.configuration
-
A base configuration class for configuring
Client
versioning. - configuration() - Element in annotation interface io.micronaut.http.client.annotation.Client
- ConnectionPoolConfiguration() - Constructor for class io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
- ContentLengthExceededException - Exception in io.micronaut.http.client.exceptions
- ContentLengthExceededException(long) - Constructor for exception io.micronaut.http.client.exceptions.ContentLengthExceededException
- ContentLengthExceededException(long, long) - Constructor for exception io.micronaut.http.client.exceptions.ContentLengthExceededException
- conversionService - Variable in class io.micronaut.http.client.AbstractHttpClientFactory
- create(URL) - Static method in interface io.micronaut.http.client.HttpClient
-
Create a new
HttpClient
. - create(URL) - Static method in interface io.micronaut.http.client.ProxyHttpClient
-
Create a new
ProxyHttpClient
. - create(URL) - Static method in interface io.micronaut.http.client.sse.SseClient
-
Create a new
SseClient
. - create(URL) - Static method in interface io.micronaut.http.client.StreamingHttpClient
-
Create a new
StreamingHttpClient
. - create(URL, HttpClientConfiguration) - Static method in interface io.micronaut.http.client.HttpClient
-
Create a new
HttpClient
with the specified configuration. - create(URL, HttpClientConfiguration) - Static method in interface io.micronaut.http.client.ProxyHttpClient
-
Create a new
ProxyHttpClient
with the specified configuration. - create(URL, HttpClientConfiguration) - Static method in interface io.micronaut.http.client.sse.SseClient
-
Create a new
SseClient
with the specified configuration. - create(URL, HttpClientConfiguration) - Static method in interface io.micronaut.http.client.StreamingHttpClient
-
Create a new
StreamingHttpClient
with the specified configuration. - create(ServiceInstanceList) - Method in class io.micronaut.http.client.loadbalance.ServiceInstanceListLoadBalancerFactory
-
Creates a
LoadBalancer
from the givenServiceInstanceList
. - create(String) - Method in class io.micronaut.http.client.loadbalance.DiscoveryClientLoadBalancerFactory
-
Creates a
LoadBalancer
for the given service ID. - createAttribute(String, String) - Method in interface io.micronaut.http.client.multipart.MultipartDataFactory
-
Creates an attribute.
- createClient(URL) - Method in interface io.micronaut.http.client.HttpClientFactory
-
Create a new
HttpClient
. - createClient(URL, HttpClientConfiguration) - Method in interface io.micronaut.http.client.HttpClientFactory
-
Create a new
HttpClient
with the specified configuration. - createClient(URL) - Method in class io.micronaut.http.client.AbstractHttpClientFactory
- createClient(URL, HttpClientConfiguration) - Method in class io.micronaut.http.client.AbstractHttpClientFactory
- createFileUpload(String, String, MediaType, String, Charset, long) - Method in interface io.micronaut.http.client.multipart.MultipartDataFactory
-
Creates a file upload.
- createHttpClient(URI) - Method in class io.micronaut.http.client.AbstractHttpClientFactory
-
Creates a new
HttpClient
instance for a given URI. - createHttpClient(URI, HttpClientConfiguration) - Method in class io.micronaut.http.client.AbstractHttpClientFactory
-
Creates a new
HttpClient
instance for a given URI and configuration. - createProxyClient(URL) - Method in interface io.micronaut.http.client.ProxyHttpClientFactory
-
Create a new
ProxyHttpClient
. - createProxyClient(URL, HttpClientConfiguration) - Method in interface io.micronaut.http.client.ProxyHttpClientFactory
-
Create a new
ProxyHttpClient
with the specified configuration. - createSseClient(URL) - Method in interface io.micronaut.http.client.sse.SseClientFactory
-
Create a new
SseClient
. - createSseClient(URL, HttpClientConfiguration) - Method in interface io.micronaut.http.client.sse.SseClientFactory
-
Create a new
SseClient
with the specified configuration. - createStreamingClient(URL) - Method in interface io.micronaut.http.client.StreamingHttpClientFactory
-
Create a new
StreamingHttpClient
. - createStreamingClient(URL, HttpClientConfiguration) - Method in interface io.micronaut.http.client.StreamingHttpClientFactory
-
Create a new
StreamingHttpClient
with the specified configuration.
D
- dataStream(HttpRequest<I>) - Method in interface io.micronaut.http.client.StreamingHttpClient
-
Request a stream of data where each emitted item is a
ByteBuffer
instance. - dataStream(HttpRequest<I>, Argument<?>) - Method in interface io.micronaut.http.client.StreamingHttpClient
-
Request a stream of data where each emitted item is a
ByteBuffer
instance. - DEFAULT - Static variable in interface io.micronaut.http.client.exceptions.HttpClientErrorDecoder
-
The default implementation.
- DEFAULT - Static variable in class io.micronaut.http.client.interceptor.configuration.ClientVersioningConfiguration
-
The default configuration property name.
- DEFAULT_ALLOW_BLOCK_EVENT_LOOP - Static variable in class io.micronaut.http.client.HttpClientConfiguration
-
The default value.
- DEFAULT_CONNECTION_POOL_IDLE_TIMEOUT_SECONDS - Static variable in class io.micronaut.http.client.HttpClientConfiguration
-
The default pool idle timeout in seconds.
- DEFAULT_ENABLED - Static variable in class io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.http.client.HttpClientConfiguration.WebSocketCompressionConfiguration
-
The default enable value.
- DEFAULT_ERROR_TYPE - Static variable in interface io.micronaut.http.client.HttpClient
-
The default error type.
- DEFAULT_EXCEPTION_ON_ERROR_STATUS - Static variable in class io.micronaut.http.client.HttpClientConfiguration
-
The default value.
- DEFAULT_FOLLOW_REDIRECTS - Static variable in class io.micronaut.http.client.HttpClientConfiguration
-
The default follow redirects value.
- DEFAULT_HEADER_NAME - Static variable in class io.micronaut.http.client.interceptor.configuration.DefaultClientVersioningConfiguration
- DEFAULT_HEALTHCHECK - Static variable in class io.micronaut.http.client.ServiceHttpClientConfiguration
-
The default health check value.
- DEFAULT_HEALTHCHECKINTERVAL_SECONDS - Static variable in class io.micronaut.http.client.ServiceHttpClientConfiguration
-
The default health check interval in seconds.
- DEFAULT_HEALTHCHECKURI - Static variable in class io.micronaut.http.client.ServiceHttpClientConfiguration
-
The default health check uri.
- DEFAULT_MAX_CONTENT_LENGTH - Static variable in class io.micronaut.http.client.HttpClientConfiguration
-
The default max content length in bytes.
- DEFAULT_PARAMETER_NAME - Static variable in class io.micronaut.http.client.interceptor.configuration.DefaultClientVersioningConfiguration
- DEFAULT_READ_IDLE_TIMEOUT_MINUTES - Static variable in class io.micronaut.http.client.HttpClientConfiguration
-
The default read idle timeout in minutes.
- DEFAULT_READ_TIMEOUT_SECONDS - Static variable in class io.micronaut.http.client.HttpClientConfiguration
-
The default read timeout in seconds.
- DEFAULT_SHUTDOWN_QUIET_PERIOD_MILLISECONDS - Static variable in class io.micronaut.http.client.HttpClientConfiguration
-
The default shutdown timeout in millis.
- DEFAULT_SHUTDOWN_TIMEOUT_MILLISECONDS - Static variable in class io.micronaut.http.client.HttpClientConfiguration
-
The default shutdown timeout in millis.
- DefaultClientVersioningConfiguration - Class in io.micronaut.http.client.interceptor.configuration
-
Default configuration when no other is present.
- DefaultConnectionPoolConfiguration() - Constructor for class io.micronaut.http.client.DefaultHttpClientConfiguration.DefaultConnectionPoolConfiguration
- DefaultHttpClientBinderRegistry - Class in io.micronaut.http.client.bind
-
Default implementation of
HttpClientBinderRegistry
that searches by annotation then by type. - DefaultHttpClientBinderRegistry(ConversionService, List<ClientRequestBinder>, BeanContext) - Constructor for class io.micronaut.http.client.bind.DefaultHttpClientBinderRegistry
- DefaultHttpClientConfiguration - Class in io.micronaut.http.client
-
The default configuration if no explicit configuration is specified for an HTTP client.
- DefaultHttpClientConfiguration() - Constructor for class io.micronaut.http.client.DefaultHttpClientConfiguration
-
Default constructor.
- DefaultHttpClientConfiguration(DefaultHttpClientConfiguration.DefaultConnectionPoolConfiguration, DefaultHttpClientConfiguration.DefaultWebSocketCompressionConfiguration, ApplicationConfiguration) - Constructor for class io.micronaut.http.client.DefaultHttpClientConfiguration
- DefaultHttpClientConfiguration(DefaultHttpClientConfiguration.DefaultConnectionPoolConfiguration, ApplicationConfiguration) - Constructor for class io.micronaut.http.client.DefaultHttpClientConfiguration
-
Deprecated.
- DefaultHttpClientConfiguration.DefaultConnectionPoolConfiguration - Class in io.micronaut.http.client
-
The default connection pool configuration.
- DefaultHttpClientConfiguration.DefaultWebSocketCompressionConfiguration - Class in io.micronaut.http.client
-
The default WebSocket compression configuration.
- DefaultHttpClientFilterResolver - Class in io.micronaut.http.client.filter
-
Resolves filters for http clients.
- DefaultHttpClientFilterResolver(BeanContext, AnnotationMetadataResolver, List<HttpClientFilter>) - Constructor for class io.micronaut.http.client.filter.DefaultHttpClientFilterResolver
-
Default constructor.
- DefaultKeyConfiguration() - Constructor for class io.micronaut.http.client.ServiceHttpClientConfiguration.ServiceSslClientConfiguration.DefaultKeyConfiguration
- DefaultKeyStoreConfiguration() - Constructor for class io.micronaut.http.client.ServiceHttpClientConfiguration.ServiceSslClientConfiguration.DefaultKeyStoreConfiguration
- DefaultLoadBalancerResolver - Class in io.micronaut.http.client
-
Abstraction over
LoadBalancer
lookup. - DefaultLoadBalancerResolver(BeanContext, ServiceInstanceList...) - Constructor for class io.micronaut.http.client.DefaultLoadBalancerResolver
-
The default server loadbalance resolver.
- DefaultLoadBalancerResolver(BeanContext, List<ServiceInstanceList>) - Constructor for class io.micronaut.http.client.DefaultLoadBalancerResolver
-
The default server loadbalance resolver.
- DefaultTrustStoreConfiguration() - Constructor for class io.micronaut.http.client.ServiceHttpClientConfiguration.ServiceSslClientConfiguration.DefaultTrustStoreConfiguration
- DefaultWebSocketCompressionConfiguration() - Constructor for class io.micronaut.http.client.DefaultHttpClientConfiguration.DefaultWebSocketCompressionConfiguration
- DiscoveryClientLoadBalancerFactory - Class in io.micronaut.http.client.loadbalance
-
A factory class that can be replaced at runtime for creating
LoadBalancer
instances that load balance between available clients provided by theDiscoveryClient
. - DiscoveryClientLoadBalancerFactory(DiscoveryClient) - Constructor for class io.micronaut.http.client.loadbalance.DiscoveryClientLoadBalancerFactory
- DiscoveryClientRoundRobinLoadBalancer - Class in io.micronaut.http.client.loadbalance
-
A
LoadBalancer
that uses theDiscoveryClient
and aServiceInstance
ID to automatically load balance between discovered clients in a non-blocking manner. - DiscoveryClientRoundRobinLoadBalancer(String, DiscoveryClient) - Constructor for class io.micronaut.http.client.loadbalance.DiscoveryClientRoundRobinLoadBalancer
- disposeClient(AnnotationMetadata) - Method in interface io.micronaut.http.client.HttpClientRegistry
-
Dispose of the client defined by the given metadata.
- disposeClient(AnnotationMetadata) - Method in interface io.micronaut.http.client.ProxyHttpClientRegistry
-
Dispose of the client defined by the given metadata.
- disposeClient(AnnotationMetadata) - Method in interface io.micronaut.http.client.sse.SseClientRegistry
-
Dispose of the client defined by the given metadata.
- disposeClient(AnnotationMetadata) - Method in interface io.micronaut.http.client.StreamingHttpClientRegistry
-
Dispose of the client defined by the given metadata.
- doFilter(MutableHttpRequest<?>, ClientFilterChain) - Method in class io.micronaut.http.client.filters.ClientServerContextFilter
E
- empty() - Static method in interface io.micronaut.http.client.LoadBalancer
- EmptyResponseException - Exception in io.micronaut.http.client.exceptions
-
An exception thrown when the server returned and empty, unreadable response.
- EmptyResponseException() - Constructor for exception io.micronaut.http.client.exceptions.EmptyResponseException
-
Default constructor.
- equals(Object) - Method in class io.micronaut.http.client.HttpVersionSelection
- equals(Object) - Method in class io.micronaut.http.client.ProxyRequestOptions
- errorType() - Element in annotation interface io.micronaut.http.client.annotation.Client
- eventStream(HttpRequest<I>) - Method in interface io.micronaut.http.client.sse.SseClient
-
Perform an HTTP request and receive data as a stream of SSE
Event
objects as they become available without blocking. - eventStream(HttpRequest<I>, Argument<B>) - Method in interface io.micronaut.http.client.sse.SseClient
-
Perform an HTTP request and receive data as a stream of SSE
Event
objects as they become available without blocking. - eventStream(HttpRequest<I>, Argument<B>, Argument<?>) - Method in interface io.micronaut.http.client.sse.SseClient
-
Perform an HTTP request and receive data as a stream of SSE
Event
objects as they become available without blocking. - eventStream(HttpRequest<I>, Class<B>) - Method in interface io.micronaut.http.client.sse.SseClient
-
Perform an HTTP request and receive data as a stream of SSE
Event
objects as they become available without blocking. - eventStream(String, Argument<B>) - Method in interface io.micronaut.http.client.sse.SseClient
-
Perform an HTTP GET request and receive data as a stream of SSE
Event
objects as they become available without blocking. - eventStream(String, Class<B>) - Method in interface io.micronaut.http.client.sse.SseClient
-
Perform an HTTP GET request and receive data as a stream of SSE
Event
objects as they become available without blocking. - exchange(HttpRequest<I>) - Method in interface io.micronaut.http.client.HttpClient
-
Perform an HTTP request for the given request object emitting the full HTTP response from returned
Publisher
. - exchange(HttpRequest<I>, Argument<O>) - Method in interface io.micronaut.http.client.HttpClient
-
Perform an HTTP request for the given request object emitting the full HTTP response from returned
Publisher
and converting the response body to the specified type. - exchange(HttpRequest<I>, Argument<O>, Argument<E>) - Method in interface io.micronaut.http.client.HttpClient
-
Perform an HTTP request for the given request object emitting the full HTTP response from returned
Publisher
and converting the response body to the specified type. - exchange(HttpRequest<I>, Class<O>) - Method in interface io.micronaut.http.client.HttpClient
-
Perform an HTTP request for the given request object emitting the full HTTP response from returned
Publisher
and converting the response body to the specified type. - exchange(String) - Method in interface io.micronaut.http.client.HttpClient
-
Perform an HTTP GET request for the given request object emitting the full HTTP response from returned
Publisher
. - exchange(String, Class<O>) - Method in interface io.micronaut.http.client.HttpClient
-
Perform an HTTP GET request for the given request object emitting the full HTTP response from returned
Publisher
. - exchange(HttpRequest<I>) - Method in interface io.micronaut.http.client.BlockingHttpClient
-
Perform an HTTP request for the given request object emitting the full HTTP response from returned
Publisher
. - exchange(HttpRequest<I>, Argument<O>) - Method in interface io.micronaut.http.client.BlockingHttpClient
-
Perform an HTTP request for the given request object emitting the full HTTP response from returned
Publisher
and converting the response body to the specified type. - exchange(HttpRequest<I>, Argument<O>, Argument<E>) - Method in interface io.micronaut.http.client.BlockingHttpClient
-
Perform an HTTP request for the given request object emitting the full HTTP response from returned
Publisher
and converting the response body to the specified type. - exchange(HttpRequest<I>, Class<O>) - Method in interface io.micronaut.http.client.BlockingHttpClient
-
Perform an HTTP request for the given request object emitting the full HTTP response from returned
Publisher
and converting the response body to the specified type. - exchange(String) - Method in interface io.micronaut.http.client.BlockingHttpClient
-
Perform a GET request for the given request object emitting the full HTTP response from returned
Publisher
. - exchange(String, Class<O>) - Method in interface io.micronaut.http.client.BlockingHttpClient
-
Perform a GET request for the given request object emitting the full HTTP response from returned
Publisher
. - exchange(String, Class<O>, Class<E>) - Method in interface io.micronaut.http.client.BlockingHttpClient
-
Perform a GET request for the given request object emitting the full HTTP response from returned
Publisher
. - exchangeStream(HttpRequest<I>) - Method in interface io.micronaut.http.client.StreamingHttpClient
-
Requests a stream data where each emitted item is a
ByteBuffer
wrapped in theHttpResponse
object (which remains the same for each emitted item). - exchangeStream(HttpRequest<I>, Argument<?>) - Method in interface io.micronaut.http.client.StreamingHttpClient
-
Requests a stream data where each emitted item is a
ByteBuffer
wrapped in theHttpResponse
object (which remains the same for each emitted item).
F
- findAnnotatedBinder(Class<?>) - Method in class io.micronaut.http.client.bind.DefaultHttpClientBinderRegistry
- findAnnotatedBinder(Class<?>) - Method in interface io.micronaut.http.client.bind.HttpClientBinderRegistry
-
Locate an
AnnotatedClientRequestBinder
for a given annotation type (that is supposed to be applied to the method). - findArgumentBinder(Argument<T>) - Method in class io.micronaut.http.client.bind.DefaultHttpClientBinderRegistry
- findArgumentBinder(Argument<T>) - Method in interface io.micronaut.http.client.bind.HttpClientBinderRegistry
-
Locate an
ClientArgumentRequestBinder
for the given argument. - fixed(URI) - Static method in interface io.micronaut.http.client.LoadBalancer
-
A
LoadBalancer
that does no load balancing and always hits the given URI. - fixed(URL) - Static method in interface io.micronaut.http.client.LoadBalancer
-
Deprecated.Use
LoadBalancer.fixed(URI)
instead - FixedLoadBalancer - Class in io.micronaut.http.client.loadbalance
-
A
LoadBalancer
that resolves a fixed URI. - FixedLoadBalancer(URI) - Constructor for class io.micronaut.http.client.loadbalance.FixedLoadBalancer
-
Constructs a new FixedLoadBalancer.
- FixedLoadBalancer(URL) - Constructor for class io.micronaut.http.client.loadbalance.FixedLoadBalancer
-
Deprecated.Use
FixedLoadBalancer(URI)
instead - forClientAnnotation(AnnotationMetadata) - Static method in class io.micronaut.http.client.HttpVersionSelection
-
Infer the version selection for the given
Client
annotation, if any version settings are set. - forClientConfiguration(HttpClientConfiguration) - Static method in class io.micronaut.http.client.HttpVersionSelection
-
Construct a version selection from the given client configuration.
- forLegacyVersion(HttpVersion) - Static method in class io.micronaut.http.client.HttpVersionSelection
-
Get the
HttpVersionSelection
that matches Micronaut HTTP client 3.x behavior for the given version setting. - forWebsocket() - Static method in class io.micronaut.http.client.HttpVersionSelection
-
Get the
HttpVersionSelection
to be used for a WebSocket connection, which will enable ALPN but constrain the mode to HTTP 1.1.
G
- getAcquireTimeout() - Method in class io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
-
The time to wait to acquire a connection.
- getAlpnModes() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
The protocols to support for TLS ALPN.
- getAlpnSupportedProtocols() - Method in class io.micronaut.http.client.HttpVersionSelection
- getAnnotationMetadata() - Method in class io.micronaut.http.client.filter.ClientFilterResolutionContext
- getAnnotationType() - Method in interface io.micronaut.http.client.bind.AnnotatedClientArgumentRequestBinder
- getAnnotationType() - Method in interface io.micronaut.http.client.bind.AnnotatedClientRequestBinder
- getAnnotationType() - Method in class io.micronaut.http.client.bind.binders.AttributeClientRequestBinder
- getAnnotationType() - Method in class io.micronaut.http.client.bind.binders.HeaderClientRequestBinder
- getAnnotationType() - Method in class io.micronaut.http.client.bind.binders.QueryValueClientArgumentRequestBinder
- getAnnotationType() - Method in class io.micronaut.http.client.bind.binders.VersionClientRequestBinder
- getChannelOptions() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
[available in the Netty HTTP client].
- getClient(AnnotationMetadata) - Method in interface io.micronaut.http.client.HttpClientRegistry
-
Return the client for the given annotation metadata.
- getClient(HttpVersionSelection, String, String) - Method in interface io.micronaut.http.client.HttpClientRegistry
-
Return the client for the client ID and path.
- getClient(HttpVersion, String, String) - Method in interface io.micronaut.http.client.HttpClientRegistry
-
Deprecated.
- getClientIds() - Method in class io.micronaut.http.client.filter.ClientFilterResolutionContext
- getClientName() - Method in class io.micronaut.http.client.interceptor.configuration.ClientVersioningConfiguration
- getConnectionPoolConfiguration() - Method in class io.micronaut.http.client.DefaultHttpClientConfiguration
- getConnectionPoolConfiguration() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Obtains the connection pool configuration.
- getConnectionPoolConfiguration() - Method in class io.micronaut.http.client.ServiceHttpClientConfiguration
- getConnectionPoolIdleTimeout() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
[available in the Netty HTTP client].
- getConnectTimeout() - Method in class io.micronaut.http.client.HttpClientConfiguration
- getConnectTtl() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
[available in the Netty HTTP client].
- getContextPath() - Method in class io.micronaut.http.client.loadbalance.FixedLoadBalancer
- getContextPath() - Method in class io.micronaut.http.client.loadbalance.ServiceInstanceListRoundRobinLoadBalancer
- getContextPath() - Method in interface io.micronaut.http.client.LoadBalancer
- getContextPath() - Method in class io.micronaut.http.client.ServiceHttpClientConfiguration
- getData(MultipartDataFactory<T>) - Method in class io.micronaut.http.client.multipart.MultipartBody
-
Create a list of data objects using the given factory.
- getDefault() - Static method in class io.micronaut.http.client.ProxyRequestOptions
- getDefaultCharset() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
[available in the Netty HTTP client].
- getDefaultClient() - Method in interface io.micronaut.http.client.HttpClientRegistry
- getDefaultProxyHttpClient() - Method in interface io.micronaut.http.client.ProxyHttpClientRegistry
- getDefaultSseClient() - Method in interface io.micronaut.http.client.sse.SseClientRegistry
- getDefaultStreamingHttpClient() - Method in interface io.micronaut.http.client.StreamingHttpClientRegistry
- getDiscoveryClient() - Method in class io.micronaut.http.client.loadbalance.DiscoveryClientLoadBalancerFactory
- getErrorType(MediaType) - Method in interface io.micronaut.http.client.exceptions.HttpClientErrorDecoder
-
Gets the error type for the given media type.
- getEventLoopGroup() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
[available in the Netty HTTP client].
- getHeaders() - Method in class io.micronaut.http.client.interceptor.configuration.ClientVersioningConfiguration
- getHealthCheckInterval() - Method in class io.micronaut.http.client.ServiceHttpClientConfiguration
-
The default duration to check health status.
- getHealthCheckUri() - Method in class io.micronaut.http.client.ServiceHttpClientConfiguration
-
The URI to check the service for health status.
- getHttpVersion() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Deprecated.There are now separate settings for HTTP and HTTPS connections. To configure HTTP connections (e.g. for h2c), use
HttpClientConfiguration.plaintextMode
. To configure ALPN, setHttpClientConfiguration.alpnModes
. - getLoggerName() - Method in class io.micronaut.http.client.HttpClientConfiguration
- getLogLevel() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
[available in the Netty HTTP client].
- getMaxConcurrentHttp1Connections() - Method in class io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
-
The maximum number of concurrent HTTP1 connections in the pool.
- getMaxConcurrentHttp2Connections() - Method in class io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
-
The maximum number of concurrent HTTP2 connections in the pool.
- getMaxConcurrentRequestsPerHttp2Connection() - Method in class io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
-
The maximum number of requests (streams) that can run concurrently on one HTTP2 connection.
- getMaxContentLength() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
[available in the Netty HTTP client].
- getMaxPendingAcquires() - Method in class io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
-
Maximum number of futures awaiting connection acquisition.
- getMaxPendingConnections() - Method in class io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
-
The maximum number of pending (new) connections before they are assigned to a pool.
- getMessage() - Method in exception io.micronaut.http.client.exceptions.HttpClientException
- getMessage() - Method in exception io.micronaut.http.client.exceptions.HttpClientResponseException
- getMessage(Object) - Method in interface io.micronaut.http.client.exceptions.HttpClientErrorDecoder
-
Default message decoder.
- getNextAvailable(List<ServiceInstance>) - Method in class io.micronaut.http.client.loadbalance.AbstractRoundRobinLoadBalancer
- getNumOfThreads() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
[available in the Netty HTTP client].
- getOrder() - Method in class io.micronaut.http.client.filters.ClientServerContextFilter
- getParameters() - Method in class io.micronaut.http.client.interceptor.configuration.ClientVersioningConfiguration
- getPath() - Method in class io.micronaut.http.client.ServiceHttpClientConfiguration
-
The context path to use for requests.
- getPathParameters() - Method in class io.micronaut.http.client.bind.ClientRequestUriContext
- getPlaintextMode() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
The connection mode to use for plaintext (http as opposed to https) connections.
- getPlaintextMode() - Method in class io.micronaut.http.client.HttpVersionSelection
- getProxyAddress() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
The proxy to use.
- getProxyHttpClient(AnnotationMetadata) - Method in interface io.micronaut.http.client.ProxyHttpClientRegistry
-
Return the client for the given annotation metadata.
- getProxyPassword() - Method in class io.micronaut.http.client.HttpClientConfiguration
- getProxySelector() - Method in class io.micronaut.http.client.HttpClientConfiguration
- getProxyType() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
The proxy to use.
- getProxyUsername() - Method in class io.micronaut.http.client.HttpClientConfiguration
- getQueryParameters() - Method in class io.micronaut.http.client.bind.ClientRequestUriContext
- getReadIdleTimeout() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
For streaming requests and WebSockets, the
HttpClientConfiguration.getReadTimeout()
method does not apply instead a configurable idle timeout is applied. - getReadTimeout() - Method in class io.micronaut.http.client.HttpClientConfiguration
- getResponse() - Method in exception io.micronaut.http.client.exceptions.HttpClientResponseException
- getServiceId() - Method in exception io.micronaut.http.client.exceptions.HttpClientException
-
Get the service ID of the http client that produced this exception.
- getServiceId() - Method in class io.micronaut.http.client.ServiceHttpClientConfiguration
-
The service id.
- getServiceID() - Method in class io.micronaut.http.client.loadbalance.AbstractRoundRobinLoadBalancer
- getServiceID() - Method in class io.micronaut.http.client.loadbalance.DiscoveryClientRoundRobinLoadBalancer
- getServiceID() - Method in class io.micronaut.http.client.loadbalance.ServiceInstanceListRoundRobinLoadBalancer
- getShutdownQuietPeriod() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
The amount of quiet period for shutdown.
- getShutdownTimeout() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
The amount of time to wait for shutdown.
- getSseClient(AnnotationMetadata) - Method in interface io.micronaut.http.client.sse.SseClientRegistry
-
Return the client for the given annotation metadata.
- getSslConfiguration() - Method in class io.micronaut.http.client.HttpClientConfiguration
- getStatus() - Method in exception io.micronaut.http.client.exceptions.HttpClientResponseException
- getStreamingHttpClient(AnnotationMetadata) - Method in interface io.micronaut.http.client.StreamingHttpClientRegistry
-
Return the client for the given annotation metadata.
- getThreadFactory() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
[available in the Netty HTTP client].
- getUri() - Method in class io.micronaut.http.client.loadbalance.FixedLoadBalancer
- getUriTemplate() - Method in class io.micronaut.http.client.bind.ClientRequestUriContext
- getUrl() - Method in class io.micronaut.http.client.loadbalance.FixedLoadBalancer
-
Deprecated.Use
FixedLoadBalancer.getUri()
instead - getUrls() - Method in class io.micronaut.http.client.ServiceHttpClientConfiguration
-
The URLs.
- getWebSocketCompressionConfiguration() - Method in class io.micronaut.http.client.DefaultHttpClientConfiguration
- getWebSocketCompressionConfiguration() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Obtains the WebSocket compression configuration.
- getWebSocketCompressionConfiguration() - Method in class io.micronaut.http.client.ServiceHttpClientConfiguration
H
- H2C - Enum constant in enum class io.micronaut.http.client.HttpVersionSelection.PlaintextMode
-
HTTP/2 cleartext upgrade from HTTP/1.1.
- hashCode() - Method in class io.micronaut.http.client.HttpVersionSelection
- hashCode() - Method in class io.micronaut.http.client.ProxyRequestOptions
- HeaderClientRequestBinder - Class in io.micronaut.http.client.bind.binders
-
An
AnnotatedClientRequestBinder
implementation forHeader
. - HeaderClientRequestBinder() - Constructor for class io.micronaut.http.client.bind.binders.HeaderClientRequestBinder
- HTTP_1 - Enum constant in enum class io.micronaut.http.client.HttpVersionSelection.PlaintextMode
-
Normal HTTP/1.1 connection.
- HttpClient - Interface in io.micronaut.http.client
-
A non-blocking HTTP client interface designed around the Micronaut API and Reactive Streams.
- HttpClientBinderRegistry - Interface in io.micronaut.http.client.bind
-
A registry of
ClientArgumentRequestBinder
instances. - HttpClientConfiguration - Class in io.micronaut.http.client
-
Configuration for the
HttpClient
. - HttpClientConfiguration() - Constructor for class io.micronaut.http.client.HttpClientConfiguration
-
Default constructor.
- HttpClientConfiguration(HttpClientConfiguration) - Constructor for class io.micronaut.http.client.HttpClientConfiguration
-
Copy constructor.
- HttpClientConfiguration(ApplicationConfiguration) - Constructor for class io.micronaut.http.client.HttpClientConfiguration
- HttpClientConfiguration.ConnectionPoolConfiguration - Class in io.micronaut.http.client
-
Configuration for the HTTP client connnection pool.
- HttpClientConfiguration.WebSocketCompressionConfiguration - Class in io.micronaut.http.client
-
Configuration for WebSocket client compression extensions.
- HttpClientErrorDecoder - Interface in io.micronaut.http.client.exceptions
-
Strategy interface for decoding the error from a server respponse.
- HttpClientException - Exception in io.micronaut.http.client.exceptions
-
Parent class for all HTTP client exceptions.
- HttpClientException(String) - Constructor for exception io.micronaut.http.client.exceptions.HttpClientException
- HttpClientException(String, Throwable) - Constructor for exception io.micronaut.http.client.exceptions.HttpClientException
- HttpClientException(String, Throwable, boolean) - Constructor for exception io.micronaut.http.client.exceptions.HttpClientException
- HttpClientExceptionUtils - Class in io.micronaut.http.client.exceptions
-
Utility Class to work with
HttpClientException
. - HttpClientFactory - Interface in io.micronaut.http.client
-
A factory to create HTTP clients.
- HttpClientIntroductionAdvice - Class in io.micronaut.http.client.interceptor
-
Introduction advice that implements the
Client
annotation. - HttpClientIntroductionAdvice(HttpClientRegistry<?>, JsonMediaTypeCodec, List<ReactiveClientResultTransformer>, HttpClientBinderRegistry, ConversionService) - Constructor for class io.micronaut.http.client.interceptor.HttpClientIntroductionAdvice
-
Constructor for advice class to set up things like Headers, Cookies, Parameters for Clients.
- HttpClientRegistry<T extends HttpClient> - Interface in io.micronaut.http.client
-
Interface for managing the construction and lifecycle of instances of
HttpClient
clients. - HttpClientResponseException - Exception in io.micronaut.http.client.exceptions
-
An exception that occurs when a response returns an error code equal to or greater than 400.
- HttpClientResponseException(String, HttpResponse<?>) - Constructor for exception io.micronaut.http.client.exceptions.HttpClientResponseException
- HttpClientResponseException(String, Throwable, HttpResponse<?>) - Constructor for exception io.micronaut.http.client.exceptions.HttpClientResponseException
- HttpClientResponseException(String, Throwable, HttpResponse<?>, HttpClientErrorDecoder) - Constructor for exception io.micronaut.http.client.exceptions.HttpClientResponseException
- httpVersion() - Element in annotation interface io.micronaut.http.client.annotation.Client
-
Deprecated.There are now separate settings for HTTP and HTTPS connections. To configure HTTP connections (e.g. for h2c), use
Client.plaintextMode()
. To configure ALPN, setClient.alpnModes()
. - HttpVersionSelection - Class in io.micronaut.http.client
-
This class collects information about HTTP client protocol version settings, such as the
HttpVersionSelection.PlaintextMode
and the ALPN configuration. - HttpVersionSelection.PlaintextMode - Enum Class in io.micronaut.http.client
-
The connection mode to use for plaintext (non-TLS) connections.
I
- id() - Element in annotation interface io.micronaut.http.client.annotation.Client
- index - Variable in class io.micronaut.http.client.loadbalance.AbstractRoundRobinLoadBalancer
- intercept(MethodInvocationContext<Object, Object>) - Method in class io.micronaut.http.client.interceptor.HttpClientIntroductionAdvice
-
Interceptor to apply headers, cookies, parameter and body arguments.
- io.micronaut.http.client - package io.micronaut.http.client
-
Core HTTP Client Library.
- io.micronaut.http.client.annotation - package io.micronaut.http.client.annotation
-
Annotations associated with the HTTP client.
- io.micronaut.http.client.bind - package io.micronaut.http.client.bind
- io.micronaut.http.client.bind.binders - package io.micronaut.http.client.bind.binders
- io.micronaut.http.client.exceptions - package io.micronaut.http.client.exceptions
-
HTTP Client exceptions.
- io.micronaut.http.client.filter - package io.micronaut.http.client.filter
- io.micronaut.http.client.filters - package io.micronaut.http.client.filters
-
Client filter implementations.
- io.micronaut.http.client.interceptor - package io.micronaut.http.client.interceptor
-
HTTP introduction advice.
- io.micronaut.http.client.interceptor.configuration - package io.micronaut.http.client.interceptor.configuration
-
Client
versioning configuration. - io.micronaut.http.client.loadbalance - package io.micronaut.http.client.loadbalance
-
HTTP load balance strategies.
- io.micronaut.http.client.multipart - package io.micronaut.http.client.multipart
-
HTTP Netty multipart requests.
- io.micronaut.http.client.sse - package io.micronaut.http.client.sse
-
Contains client interfaces for reading Server Sent Events (SSE).
- isAllowBlockEventLoop() - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Whether to allow blocking a netty event loop with a call to
BlockingHttpClient
. - isAlpn() - Method in class io.micronaut.http.client.HttpVersionSelection
- isEnabled() - Method in class io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
-
Whether connection pooling is enabled.
- isEnabled() - Method in class io.micronaut.http.client.HttpClientConfiguration.WebSocketCompressionConfiguration
-
Whether deflate compression is enabled for client WebSocket connections.
- isExceptionOnErrorStatus() - Method in class io.micronaut.http.client.HttpClientConfiguration
- isFollowRedirects() - Method in class io.micronaut.http.client.HttpClientConfiguration
- isHealthCheck() - Method in class io.micronaut.http.client.ServiceHttpClientConfiguration
-
Whether the service health should be checked.
- isHttp2CipherSuites() - Method in class io.micronaut.http.client.HttpVersionSelection
- isHttp3() - Method in class io.micronaut.http.client.HttpVersionSelection
- isRetainHostHeader() - Method in class io.micronaut.http.client.ProxyRequestOptions
-
If
true
, retain the host header from the given request.
J
- jsonStream(HttpRequest<I>) - Method in interface io.micronaut.http.client.StreamingHttpClient
-
Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.
- jsonStream(HttpRequest<I>, Argument<O>) - Method in interface io.micronaut.http.client.StreamingHttpClient
-
Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.
- jsonStream(HttpRequest<I>, Argument<O>, Argument<?>) - Method in interface io.micronaut.http.client.StreamingHttpClient
-
Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.
- jsonStream(HttpRequest<I>, Class<O>) - Method in interface io.micronaut.http.client.StreamingHttpClient
-
Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.
L
- LoadBalancer - Interface in io.micronaut.http.client
-
Interface to abstract server selection.
- LoadBalancerConverters - Class in io.micronaut.http.client.loadbalance
-
Converters from URL to
LoadBalancer
interface. - LoadBalancerConverters() - Constructor for class io.micronaut.http.client.loadbalance.LoadBalancerConverters
- LoadBalancerResolver - Interface in io.micronaut.http.client
-
A resolver of
LoadBalancer
instances that are capable of resolving references to services into a concrete loadbalance.
M
- mediaTypeCodecRegistry - Variable in class io.micronaut.http.client.AbstractHttpClientFactory
- MultipartBody - Class in io.micronaut.http.client.multipart
-
A builder class to generate a list of parts for a multipart request.
- MultipartBody.Builder - Class in io.micronaut.http.client.multipart
-
A builder class to add different
Part
toMultipartBody
. - MultipartDataFactory<T> - Interface in io.micronaut.http.client.multipart
-
A factory for Multipart data.
N
- NamedClientVersioningConfiguration - Class in io.micronaut.http.client.interceptor.configuration
-
Client versioning configuration for named configurations nested under
micronaut.http.client.versioning
. - NoHostException - Exception in io.micronaut.http.client.exceptions
-
Thrown when a request is made that has no host information.
- NoHostException(String) - Constructor for exception io.micronaut.http.client.exceptions.NoHostException
- NoHostException(String, Throwable) - Constructor for exception io.micronaut.http.client.exceptions.NoHostException
- NoHostException(String, Throwable, boolean) - Constructor for exception io.micronaut.http.client.exceptions.NoHostException
P
- path() - Element in annotation interface io.micronaut.http.client.annotation.Client
-
The base URI for the client.
- plaintextMode() - Element in annotation interface io.micronaut.http.client.annotation.Client
-
The connection mode to use for plaintext (http as opposed to https) connections.
- populateServiceId(E, String, HttpClientConfiguration) - Static method in class io.micronaut.http.client.exceptions.HttpClientExceptionUtils
- PREFIX - Static variable in class io.micronaut.http.client.DefaultHttpClientConfiguration
-
Prefix for HTTP Client settings.
- PREFIX - Static variable in class io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
-
The prefix to use for configuration.
- PREFIX - Static variable in class io.micronaut.http.client.HttpClientConfiguration.WebSocketCompressionConfiguration
-
The prefix to use for configuration.
- PREFIX - Static variable in class io.micronaut.http.client.interceptor.configuration.ClientVersioningConfiguration
-
The prefix for versioning configuration.
- PREFIX - Static variable in class io.micronaut.http.client.interceptor.configuration.DefaultClientVersioningConfiguration
- PREFIX - Static variable in class io.micronaut.http.client.ServiceHttpClientConfiguration
-
Prefix for HTTP Client settings.
- proxy(HttpRequest<?>) - Method in interface io.micronaut.http.client.ProxyHttpClient
-
Proxy the given request and emit the response.
- proxy(HttpRequest<?>, ProxyRequestOptions) - Method in interface io.micronaut.http.client.ProxyHttpClient
-
Proxy the given request and emit the response.
- ProxyHttpClient - Interface in io.micronaut.http.client
-
Interface that allows proxying of HTTP requests in controllers and filters.
- ProxyHttpClientFactory - Interface in io.micronaut.http.client
-
A factory to create Proxy HTTP clients.
- ProxyHttpClientRegistry<P extends ProxyHttpClient> - Interface in io.micronaut.http.client
-
Interface for managing the construction and lifecycle of instances of
ProxyHttpClient
clients. - ProxyRequestOptions - Class in io.micronaut.http.client
-
Further options for
ProxyHttpClient
when handling proxy requests. - ProxyRequestOptions.Builder - Class in io.micronaut.http.client
-
Builder class.
Q
- QueryValueClientArgumentRequestBinder - Class in io.micronaut.http.client.bind.binders
-
Implementation of the Binder for
QueryValue
The details of implementation can be found in theQueryValueClientArgumentRequestBinder.bind(ArgumentConversionContext, ClientRequestUriContext, Object, MutableHttpRequest)
method javadoc. - QueryValueClientArgumentRequestBinder(ConversionService) - Constructor for class io.micronaut.http.client.bind.binders.QueryValueClientArgumentRequestBinder
R
- ReactiveClientResultTransformer - Interface in io.micronaut.http.client
-
Allows hooking modifying the resulting publisher prior to returning it from the client.
- ReadTimeoutException - Exception in io.micronaut.http.client.exceptions
-
An exception thrown when a read timeout occurs.
- refresh() - Method in interface io.micronaut.http.client.HttpClient
- register(MutableConversionService) - Method in class io.micronaut.http.client.loadbalance.LoadBalancerConverters
- resolve(String...) - Method in class io.micronaut.http.client.DefaultLoadBalancerResolver
- resolve(String...) - Method in interface io.micronaut.http.client.LoadBalancerResolver
-
Resolve a
LoadBalancer
for the given references. - resolveClient(InjectionPoint<?>, LoadBalancer, HttpClientConfiguration, BeanContext) - Method in interface io.micronaut.http.client.HttpClientRegistry
-
Resolves a
HttpClient
for the given injection point. - resolveFilterEntries(ClientFilterResolutionContext) - Method in class io.micronaut.http.client.filter.DefaultHttpClientFilterResolver
- resolveFilters(HttpRequest<?>, List<HttpFilterResolver.FilterEntry>) - Method in class io.micronaut.http.client.filter.DefaultHttpClientFilterResolver
- resolveLoadBalancerForServiceID(String) - Method in class io.micronaut.http.client.DefaultLoadBalancerResolver
- resolveProxy(boolean, String, int) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Resolves a proxy to use for connection.
- resolveProxyHttpClient(InjectionPoint<?>, LoadBalancer, HttpClientConfiguration, BeanContext) - Method in interface io.micronaut.http.client.ProxyHttpClientRegistry
-
Resolves a
ProxyHttpClient
for the given injection point. - resolveSseClient(InjectionPoint<?>, LoadBalancer, HttpClientConfiguration, BeanContext) - Method in interface io.micronaut.http.client.sse.SseClientRegistry
-
Resolves a
SseClient
for the given injection point. - resolveStreamingHttpClient(InjectionPoint<?>, LoadBalancer, HttpClientConfiguration, BeanContext) - Method in interface io.micronaut.http.client.StreamingHttpClientRegistry
-
Resolves a
StreamingHttpClient
for the given injection point. - ResponseClosedException - Exception in io.micronaut.http.client.exceptions
-
Exception raised when the connection is closed during the response.
- ResponseClosedException(String) - Constructor for exception io.micronaut.http.client.exceptions.ResponseClosedException
- retainHostHeader() - Method in class io.micronaut.http.client.ProxyRequestOptions.Builder
-
Equivalent to
ProxyRequestOptions.Builder.retainHostHeader(boolean)
. - retainHostHeader(boolean) - Method in class io.micronaut.http.client.ProxyRequestOptions.Builder
-
If
true
, retain the host header from the given request. - retrieve(HttpRequest<I>) - Method in interface io.micronaut.http.client.HttpClient
-
Perform an HTTP request for the given request object emitting the full HTTP response from returned
Publisher
and converting the response body to the specified type. - retrieve(HttpRequest<I>, Argument<O>) - Method in interface io.micronaut.http.client.HttpClient
-
Perform an HTTP request for the given request object emitting the full HTTP response from returned
Publisher
and converting the response body to the specified type. - retrieve(HttpRequest<I>, Argument<O>, Argument<E>) - Method in interface io.micronaut.http.client.HttpClient
-
Perform an HTTP request for the given request object emitting the full HTTP response from returned
Publisher
and converting the response body to the specified type. - retrieve(HttpRequest<I>, Class<O>) - Method in interface io.micronaut.http.client.HttpClient
-
Perform an HTTP request for the given request object emitting the full HTTP response from returned
Publisher
and converting the response body to the specified type. - retrieve(String) - Method in interface io.micronaut.http.client.HttpClient
-
Perform an HTTP GET request for the given request object emitting the full HTTP response from returned
Publisher
and converting the response body to the specified type. - retrieve(HttpRequest<I>) - Method in interface io.micronaut.http.client.BlockingHttpClient
-
Perform an HTTP request for the given request object emitting the full HTTP response from returned
Publisher
and converting the response body to the specified type. - retrieve(HttpRequest<I>, Argument<O>) - Method in interface io.micronaut.http.client.BlockingHttpClient
-
Perform an HTTP request for the given request object emitting the full HTTP response from returned
Publisher
and converting the response body to the specified type. - retrieve(HttpRequest<I>, Argument<O>, Argument<E>) - Method in interface io.micronaut.http.client.BlockingHttpClient
-
Perform an HTTP request for the given request object emitting the full HTTP response from returned
Publisher
and converting the response body to the specified type. - retrieve(HttpRequest<I>, Class<O>) - Method in interface io.micronaut.http.client.BlockingHttpClient
-
Perform an HTTP request for the given request object emitting the full HTTP response from returned
Publisher
and converting the response body to the specified type. - retrieve(String) - Method in interface io.micronaut.http.client.BlockingHttpClient
-
Perform an HTTP GET request for the given request object emitting the full HTTP response from returned
Publisher
and converting the response body to the specified type. - retrieve(String, Class<O>) - Method in interface io.micronaut.http.client.BlockingHttpClient
-
Perform an HTTP GET request for the given request object emitting the full HTTP response from returned
Publisher
and converting the response body to the specified type. - retrieve(String, Class<O>, Class<E>) - Method in interface io.micronaut.http.client.BlockingHttpClient
-
Perform a GET request for the given request object emitting the full HTTP response from returned
Publisher
.
S
- select() - Method in interface io.micronaut.http.client.LoadBalancer
- select(Object) - Method in class io.micronaut.http.client.loadbalance.FixedLoadBalancer
- select(Object) - Method in class io.micronaut.http.client.loadbalance.ServiceInstanceListRoundRobinLoadBalancer
- select(Object) - Method in interface io.micronaut.http.client.LoadBalancer
- select(Object) - Method in class io.micronaut.http.client.loadbalance.DiscoveryClientRoundRobinLoadBalancer
- ServiceConnectionPoolConfiguration() - Constructor for class io.micronaut.http.client.ServiceHttpClientConfiguration.ServiceConnectionPoolConfiguration
- ServiceHttpClientConfiguration - Class in io.micronaut.http.client
-
Allows defining HTTP client configurations via the
micronaut.http.services
setting. - ServiceHttpClientConfiguration(String, ServiceHttpClientConfiguration.ServiceConnectionPoolConfiguration, ServiceHttpClientConfiguration.ServiceSslClientConfiguration, HttpClientConfiguration) - Constructor for class io.micronaut.http.client.ServiceHttpClientConfiguration
- ServiceHttpClientConfiguration(String, ServiceHttpClientConfiguration.ServiceConnectionPoolConfiguration, ServiceHttpClientConfiguration.ServiceSslClientConfiguration, ApplicationConfiguration) - Constructor for class io.micronaut.http.client.ServiceHttpClientConfiguration
-
Creates a new client configuration for the given service ID.
- ServiceHttpClientConfiguration(String, ServiceHttpClientConfiguration.ServiceConnectionPoolConfiguration, ServiceHttpClientConfiguration.ServiceWebSocketCompressionConfiguration, ServiceHttpClientConfiguration.ServiceSslClientConfiguration, HttpClientConfiguration) - Constructor for class io.micronaut.http.client.ServiceHttpClientConfiguration
-
Creates a new client configuration for the given service ID.
- ServiceHttpClientConfiguration.ServiceConnectionPoolConfiguration - Class in io.micronaut.http.client
-
The default connection pool configuration.
- ServiceHttpClientConfiguration.ServiceSslClientConfiguration - Class in io.micronaut.http.client
-
The default connection pool configuration.
- ServiceHttpClientConfiguration.ServiceSslClientConfiguration.DefaultKeyConfiguration - Class in io.micronaut.http.client
-
The default
SslConfiguration.KeyConfiguration
. - ServiceHttpClientConfiguration.ServiceSslClientConfiguration.DefaultKeyStoreConfiguration - Class in io.micronaut.http.client
-
The default
SslConfiguration.KeyStoreConfiguration
. - ServiceHttpClientConfiguration.ServiceSslClientConfiguration.DefaultTrustStoreConfiguration - Class in io.micronaut.http.client
-
The default
SslConfiguration.TrustStoreConfiguration
. - ServiceHttpClientConfiguration.ServiceWebSocketCompressionConfiguration - Class in io.micronaut.http.client
-
The default WebSocket compression configuration.
- ServiceHttpClientFactory - Class in io.micronaut.http.client
-
Creates
HttpClient
instances for each definedServiceHttpClientConfiguration
. - ServiceHttpClientFactory(TaskScheduler, BeanProvider<HttpClientRegistry<?>>) - Constructor for class io.micronaut.http.client.ServiceHttpClientFactory
-
Default constructor.
- ServiceInstanceListLoadBalancerFactory - Class in io.micronaut.http.client.loadbalance
-
The default
LoadBalancer
factory for creatingLoadBalancer
instances fromServiceInstanceList
instances. - ServiceInstanceListLoadBalancerFactory() - Constructor for class io.micronaut.http.client.loadbalance.ServiceInstanceListLoadBalancerFactory
- ServiceInstanceListRoundRobinLoadBalancer - Class in io.micronaut.http.client.loadbalance
- ServiceInstanceListRoundRobinLoadBalancer(ServiceInstanceList) - Constructor for class io.micronaut.http.client.loadbalance.ServiceInstanceListRoundRobinLoadBalancer
- ServiceSslClientConfiguration() - Constructor for class io.micronaut.http.client.ServiceHttpClientConfiguration.ServiceSslClientConfiguration
- ServiceWebSocketCompressionConfiguration() - Constructor for class io.micronaut.http.client.ServiceHttpClientConfiguration.ServiceWebSocketCompressionConfiguration
- setAcquireTimeout(Duration) - Method in class io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
-
Sets the timeout to wait for a connection.
- setAllowBlockEventLoop(boolean) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Whether to allow blocking a netty event loop with a call to
BlockingHttpClient
. - setAlpnModes(List<String>) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
The protocols to support for TLS ALPN.
- setChannelOptions(Map<String, Object>) - Method in class io.micronaut.http.client.HttpClientConfiguration
- setClientSslConfiguration(ClientSslConfiguration) - Method in class io.micronaut.http.client.DefaultHttpClientConfiguration
-
Uses the default SSL configuration.
- setConnectionPoolIdleTimeout(Duration) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets the idle timeout for connection in the client connection pool.
- setConnectTimeout(Duration) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets the connect timeout.
- setConnectTtl(Duration) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets the connect timeout.
- setContent(T, Object) - Method in interface io.micronaut.http.client.multipart.MultipartDataFactory
-
Sets the content on the file upload object.
- setDefaultCharset(Charset) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets the default charset to use.
- setEnabled(boolean) - Method in class io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
-
Sets whether connection pooling is enabled.
- setEnabled(boolean) - Method in class io.micronaut.http.client.HttpClientConfiguration.WebSocketCompressionConfiguration
-
Sets whether the per message deflate extension is enabled for WebSocket connections.
- setEventLoopGroup(String) - Method in class io.micronaut.http.client.HttpClientConfiguration
- setExceptionOnErrorStatus(boolean) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets whether throwing an exception upon HTTP error status (>= 400) is preferred.
- setFollowRedirects(boolean) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets whether redirects should be followed.
- setHeaders(List<String>) - Method in class io.micronaut.http.client.interceptor.configuration.ClientVersioningConfiguration
- setHealthCheck(boolean) - Method in class io.micronaut.http.client.ServiceHttpClientConfiguration
-
Sets whether the service health should be checked.
- setHealthCheckInterval(Duration) - Method in class io.micronaut.http.client.ServiceHttpClientConfiguration
-
Sets the default duration to check health status.
- setHealthCheckUri(String) - Method in class io.micronaut.http.client.ServiceHttpClientConfiguration
-
Sets the health check URI.
- setHttpVersion(HttpVersion) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Deprecated.There are now separate settings for HTTP and HTTPS connections. To configure HTTP connections (e.g. for h2c), use
HttpClientConfiguration.plaintextMode
. To configure ALPN, setHttpClientConfiguration.alpnModes
. - setLoggerName(String) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets the client-specific logger name.
- setLogLevel(LogLevel) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets the level to enable trace logging at.
- setMaxConcurrentHttp1Connections(int) - Method in class io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
-
The maximum number of concurrent HTTP1 connections in the pool.
- setMaxConcurrentHttp2Connections(int) - Method in class io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
-
The maximum number of concurrent HTTP2 connections in the pool.
- setMaxConcurrentRequestsPerHttp2Connection(int) - Method in class io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
-
The maximum number of requests (streams) that can run concurrently on one HTTP2 connection.
- setMaxContentLength(int) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets the maximum content length the client can consume.
- setMaxPendingAcquires(int) - Method in class io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
-
Sets the max pending acquires.
- setMaxPendingConnections(int) - Method in class io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
-
The maximum number of pending (new) connections before they are assigned to a pool.
- setNumOfThreads(Integer) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets the number of threads the client should use for requests.
- setParameters(List<String>) - Method in class io.micronaut.http.client.interceptor.configuration.ClientVersioningConfiguration
- setPath(String) - Method in class io.micronaut.http.client.ServiceHttpClientConfiguration
-
Sets the context path to use for requests.
- setPathParameter(String, Object) - Method in class io.micronaut.http.client.bind.ClientRequestUriContext
-
Set the value of a path parameter.
- setPlaintextMode(HttpVersionSelection.PlaintextMode) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
The connection mode to use for plaintext (http as opposed to https) connections.
- setProxyAddress(SocketAddress) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets a proxy address.
- setProxyPassword(String) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets the proxy password.
- setProxySelector(ProxySelector) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets the proxy selector.
- setProxyType(Proxy.Type) - Method in class io.micronaut.http.client.HttpClientConfiguration
- setProxyUsername(String) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets the proxy username to use.
- setQueryParameter(String, List<String>) - Method in class io.micronaut.http.client.bind.ClientRequestUriContext
-
Set all the values of query parameters.
- setReadIdleTimeout(Duration) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets the max read idle time for streaming requests.
- setReadTimeout(Duration) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets the read timeout.
- setServiceId(String) - Method in exception io.micronaut.http.client.exceptions.HttpClientException
-
Set the service id that produced this exception.
- setShutdownQuietPeriod(Duration) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets the amount of quiet period for shutdown of client thread pools.
- setShutdownTimeout(Duration) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets the amount of time to wait for shutdown of client thread pools.
- setSslConfiguration(SslConfiguration) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets the SSL configuration for the client.
- setThreadFactory(Class<? extends ThreadFactory>) - Method in class io.micronaut.http.client.HttpClientConfiguration
-
Sets a thread factory.
- setUrl(URI) - Method in class io.micronaut.http.client.ServiceHttpClientConfiguration
-
Sets the URL of the service.
- setUrls(List<URI>) - Method in class io.micronaut.http.client.ServiceHttpClientConfiguration
-
Sets the URIs of the service.
- SseClient - Interface in io.micronaut.http.client.sse
-
A client for streaming Server Sent Event streams.
- SseClientFactory - Interface in io.micronaut.http.client.sse
-
A factory to create Server Sent Event clients.
- SseClientRegistry<E extends SseClient> - Interface in io.micronaut.http.client.sse
-
Interface for managing the construction and lifecycle of instances of reactive clients.
- StreamingHttpClient - Interface in io.micronaut.http.client
-
Extended version of the
HttpClient
that supports streaming responses. - StreamingHttpClientFactory - Interface in io.micronaut.http.client
-
A factory to create Streaming HTTP clients.
- StreamingHttpClientRegistry<S extends StreamingHttpClient> - Interface in io.micronaut.http.client
-
Interface for managing the construction and lifecycle of instances of
StreamingHttpClient
clients. - superTypes() - Method in interface io.micronaut.http.client.bind.TypedClientArgumentRequestBinder
-
Returns additional super types.
T
- TIMEOUT_EXCEPTION - Static variable in exception io.micronaut.http.client.exceptions.ReadTimeoutException
- toBlocking() - Method in interface io.micronaut.http.client.HttpClient
- transform(Object) - Method in interface io.micronaut.http.client.ReactiveClientResultTransformer
-
Transform the publisher result.
- TypedClientArgumentRequestBinder<T> - Interface in io.micronaut.http.client.bind
-
A
ClientArgumentRequestBinder
that is resolved based on the argument type.
V
- value() - Element in annotation interface io.micronaut.http.client.annotation.Client
- valueOf(String) - Static method in enum class io.micronaut.http.client.HttpVersionSelection.PlaintextMode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.micronaut.http.client.HttpVersionSelection.PlaintextMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VersionClientRequestBinder - Class in io.micronaut.http.client.bind.binders
-
An
AnnotatedClientRequestBinder
implementation forVersion
. - VersionClientRequestBinder(BeanContext) - Constructor for class io.micronaut.http.client.bind.binders.VersionClientRequestBinder
W
- WebSocketCompressionConfiguration() - Constructor for class io.micronaut.http.client.HttpClientConfiguration.WebSocketCompressionConfiguration
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
DefaultHttpClientConfiguration(io.micronaut.http.client.DefaultHttpClientConfiguration.DefaultConnectionPoolConfiguration,io.micronaut.http.client.DefaultHttpClientConfiguration.DefaultWebSocketCompressionConfiguration,io.micronaut.runtime.ApplicationConfiguration)
instead.