Package org.springframework.ai.anthropic.http.okhttp

Class SpringAiAnthropicHttpClient.Builder

java.lang.Object

org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder

Enclosing class:

SpringAiAnthropicHttpClient

public static final class SpringAiAnthropicHttpClient.Builder
extends Object

Builder for SpringAiAnthropicHttpClient. Mirrors the upstream com.anthropic.client.okhttp.OkHttpClient.Builder surface, with two additional optional inputs: an ObservationRegistry (defaults to ObservationRegistry.NOOP) and a MeterRegistry (optional; when supplied, OkHttp connection-pool gauges are bound to it).

Method Summary

Modifier and Type	Method	Description
SpringAiAnthropicHttpClient.Builder	backend(com.anthropic.backends.Backend backend)
SpringAiAnthropicHttpClient	build()
SpringAiAnthropicHttpClient.Builder	dispatcherExecutorService(@Nullable ExecutorService dispatcherExecutorService)	Sets the executor used by the OkHttp dispatcher.
SpringAiAnthropicHttpClient.Builder	hostnameVerifier(@Nullable HostnameVerifier hostnameVerifier)
SpringAiAnthropicHttpClient.Builder	interceptor(okhttp3.Interceptor interceptor)	Adds an OkHttp application interceptor.
SpringAiAnthropicHttpClient.Builder	keepAliveDuration(@Nullable Duration keepAliveDuration)
SpringAiAnthropicHttpClient.Builder	maxIdleConnections(@Nullable Integer maxIdleConnections)
SpringAiAnthropicHttpClient.Builder	meterRegistry(@Nullable io.micrometer.core.instrument.MeterRegistry meterRegistry)	Registers a meter registry to bind OkHttp connection-pool gauges (active/idle connections).
SpringAiAnthropicHttpClient.Builder	meterTags(Iterable<io.micrometer.core.instrument.Tag> meterTags)	Tags applied to the connection-pool gauges registered with the MeterRegistry.
SpringAiAnthropicHttpClient.Builder	observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)	Registers the Micrometer observation registry used by the OkHttp interceptor.
SpringAiAnthropicHttpClient.Builder	proxy(@Nullable Proxy proxy)
SpringAiAnthropicHttpClient.Builder	proxyAuthenticator(@Nullable com.anthropic.core.http.ProxyAuthenticator proxyAuthenticator)
SpringAiAnthropicHttpClient.Builder	sslSocketFactory(@Nullable SSLSocketFactory sslSocketFactory)
SpringAiAnthropicHttpClient.Builder	timeout(com.anthropic.core.Timeout timeout)
SpringAiAnthropicHttpClient.Builder	timeout(Duration timeout)
SpringAiAnthropicHttpClient.Builder	trustManager(@Nullable X509TrustManager trustManager)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

timeout

public SpringAiAnthropicHttpClient.Builder timeout(com.anthropic.core.Timeout timeout)

timeout

public SpringAiAnthropicHttpClient.Builder timeout(Duration timeout)

proxy

public SpringAiAnthropicHttpClient.Builder proxy(@Nullable Proxy proxy)

backend

public SpringAiAnthropicHttpClient.Builder backend(com.anthropic.backends.Backend backend)

proxyAuthenticator

public SpringAiAnthropicHttpClient.Builder proxyAuthenticator(@Nullable com.anthropic.core.http.ProxyAuthenticator proxyAuthenticator)

maxIdleConnections

public SpringAiAnthropicHttpClient.Builder maxIdleConnections(@Nullable Integer maxIdleConnections)

keepAliveDuration

public SpringAiAnthropicHttpClient.Builder keepAliveDuration(@Nullable Duration keepAliveDuration)

dispatcherExecutorService

public SpringAiAnthropicHttpClient.Builder dispatcherExecutorService(@Nullable ExecutorService dispatcherExecutorService)

Sets the executor used by the OkHttp dispatcher. When supplied, the caller owns the executor's lifecycle — SpringAiAnthropicHttpClient.close() will not shut it down. When null, an internal default is created and closed with the client.

sslSocketFactory

public SpringAiAnthropicHttpClient.Builder sslSocketFactory(@Nullable SSLSocketFactory sslSocketFactory)

trustManager

public SpringAiAnthropicHttpClient.Builder trustManager(@Nullable X509TrustManager trustManager)

hostnameVerifier

public SpringAiAnthropicHttpClient.Builder hostnameVerifier(@Nullable HostnameVerifier hostnameVerifier)

observationRegistry

public SpringAiAnthropicHttpClient.Builder observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)

Registers the Micrometer observation registry used by the OkHttp interceptor. Defaults to ObservationRegistry.NOOP, which makes the interceptor a no-op — no metric/span overhead in environments that don't wire observability.

meterRegistry

public SpringAiAnthropicHttpClient.Builder meterRegistry(@Nullable io.micrometer.core.instrument.MeterRegistry meterRegistry)

Registers a meter registry to bind OkHttp connection-pool gauges (active/idle connections). Optional; when omitted, no pool gauges are registered.

meterTags

public SpringAiAnthropicHttpClient.Builder meterTags(Iterable<io.micrometer.core.instrument.Tag> meterTags)

Tags applied to the connection-pool gauges registered with the MeterRegistry. Useful for distinguishing multiple clients writing pool metrics into the same registry (e.g. a sync and an async client sharing a registry). Has no effect when no meter registry is set.

interceptor

public SpringAiAnthropicHttpClient.Builder interceptor(okhttp3.Interceptor interceptor)

Adds an OkHttp application interceptor. The observation interceptor is outermost (added first); user interceptors are nested inside it. Consequently, on the request path user interceptors execute after the observation interceptor, and on the response path they execute before it — the observation span is open for the full duration of the user interceptor's execution. Use this to attach cross-cutting concerns such as OAuth2 bearer-token injection, custom logging, or tenant-propagation headers.

build

public SpringAiAnthropicHttpClient build()