Class PhilterClient.PhilterClientBuilder

java.lang.Object

ai.philterd.philter.PhilterClient.PhilterClientBuilder

Enclosing class:

PhilterClient

public static class PhilterClient.PhilterClientBuilder
extends Object

Builds PhilterClient instances. Only withEndpoint(String) is required; all other settings are optional and fall back to sensible defaults.

Constructor Summary

Constructors

Constructor	Description
PhilterClientBuilder()

Method Summary

Modifier and Type	Method	Description
PhilterClient	build()	Builds the configured PhilterClient.
PhilterClient.PhilterClientBuilder	withApiKey(String apiKey)	Sets the value sent in the Authorization header on every request.
PhilterClient.PhilterClientBuilder	withEndpoint(String endpoint)	Sets the base URL of the Philter instance, for example https://localhost:8080.
PhilterClient.PhilterClientBuilder	withKeepAliveDurationMs(int keepAliveDurationMs)	Sets the connection keep-alive duration in milliseconds.
PhilterClient.PhilterClientBuilder	withMaxIdleConnections(int maxIdleConnections)	Sets the maximum number of idle connections in the connection pool.
PhilterClient.PhilterClientBuilder	withOkHttpClientBuilder(okhttp3.OkHttpClient.Builder okHttpClientBuilder)	Supplies a pre-configured OkHttp client builder.
PhilterClient.PhilterClientBuilder	withTimeout(long timeout)	Sets the connect, read, and write timeout in seconds.

Methods inherited from class Object

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

Constructor Details

PhilterClientBuilder

public PhilterClientBuilder()

Method Details

withEndpoint

public PhilterClient.PhilterClientBuilder withEndpoint(String endpoint)

Sets the base URL of the Philter instance, for example https://localhost:8080. Required.

Parameters:

endpoint - The Philter endpoint URL.

Returns:

This builder.

withOkHttpClientBuilder

public PhilterClient.PhilterClientBuilder withOkHttpClientBuilder(okhttp3.OkHttpClient.Builder okHttpClientBuilder)

Supplies a pre-configured OkHttp client builder. When provided, the timeout, maxIdleConnections, and keepAliveDurationMs settings are not applied and should be configured on the supplied builder instead. The Authorization header and any SSL configuration are still applied on top of it.

Parameters:

okHttpClientBuilder - The OkHttp client builder to use.

Returns:

This builder.

withTimeout

public PhilterClient.PhilterClientBuilder withTimeout(long timeout)

Sets the connect, read, and write timeout in seconds. Defaults to PhilterClient.DEFAULT_TIMEOUT_SEC. Ignored when a client builder is supplied via withOkHttpClientBuilder(OkHttpClient.Builder).

Parameters:

timeout - The timeout in seconds.

Returns:

This builder.

withMaxIdleConnections

public PhilterClient.PhilterClientBuilder withMaxIdleConnections(int maxIdleConnections)

Sets the maximum number of idle connections in the connection pool. Defaults to PhilterClient.DEFAULT_MAX_IDLE_CONNECTIONS. Ignored when a client builder is supplied via withOkHttpClientBuilder(OkHttpClient.Builder).

Parameters:

maxIdleConnections - The maximum number of idle connections.

Returns:

This builder.

withKeepAliveDurationMs

public PhilterClient.PhilterClientBuilder withKeepAliveDurationMs(int keepAliveDurationMs)

Sets the connection keep-alive duration in milliseconds. Defaults to PhilterClient.DEFAULT_KEEP_ALIVE_DURATION_MS. Ignored when a client builder is supplied via withOkHttpClientBuilder(OkHttpClient.Builder).

Parameters:

keepAliveDurationMs - The keep-alive duration in milliseconds.

Returns:

This builder.

withApiKey

public PhilterClient.PhilterClientBuilder withApiKey(String apiKey)

Sets the value sent in the Authorization header on every request. The value is sent verbatim, so include any scheme prefix (for example "Bearer ") if your Philter deployment requires it.

Parameters:

apiKey - The Authorization header value.

Returns:

This builder.

build

public PhilterClient build()

Builds the configured PhilterClient.

Returns:

A new PhilterClient.