Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.client.transport

Class HttpClientStreamableHttpTransport.Builder

java.lang.Object

io.modelcontextprotocol.client.transport.HttpClientStreamableHttpTransport.Builder

Enclosing class:

HttpClientStreamableHttpTransport

public static class HttpClientStreamableHttpTransport.Builder
extends Object

Builder for HttpClientStreamableHttpTransport.

Method Summary

Modifier and Type	Method	Description
HttpClientStreamableHttpTransport.Builder	asyncHttpRequestCustomizer(McpAsyncHttpClientRequestCustomizer asyncHttpRequestCustomizer)	Sets the customizer for HttpRequest.Builder, to modify requests before executing them.
HttpClientStreamableHttpTransport	build()	Construct a fresh instance of HttpClientStreamableHttpTransport using the current builder configuration.
HttpClientStreamableHttpTransport.Builder	clientBuilder(HttpClient.Builder clientBuilder)	Sets the HTTP client builder.
HttpClientStreamableHttpTransport.Builder	connectTimeout(Duration connectTimeout)	Sets the connection timeout for the HTTP client.
HttpClientStreamableHttpTransport.Builder	customizeClient(Consumer<HttpClient.Builder> clientCustomizer)	Customizes the HTTP client builder.
HttpClientStreamableHttpTransport.Builder	customizeRequest(Consumer<HttpRequest.Builder> requestCustomizer)	Customizes the HTTP client builder.
HttpClientStreamableHttpTransport.Builder	endpoint(String endpoint)	Configure the endpoint to make HTTP requests against.
HttpClientStreamableHttpTransport.Builder	httpRequestCustomizer(McpSyncHttpClientRequestCustomizer syncHttpRequestCustomizer)	Sets the customizer for HttpRequest.Builder, to modify requests before executing them.
HttpClientStreamableHttpTransport.Builder	objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Configure the ObjectMapper to use.
HttpClientStreamableHttpTransport.Builder	openConnectionOnStartup(boolean openConnectionOnStartup)	Configure whether the client should open an SSE connection upon startup.
HttpClientStreamableHttpTransport.Builder	requestBuilder(HttpRequest.Builder requestBuilder)	Sets the HTTP request builder.
HttpClientStreamableHttpTransport.Builder	resumableStreams(boolean resumableStreams)	Configure whether to use the stream resumability feature by keeping track of SSE event ids.

Methods inherited from class java.lang.Object

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

Method Details

clientBuilder

public HttpClientStreamableHttpTransport.Builder clientBuilder(HttpClient.Builder clientBuilder)

Sets the HTTP client builder.

Parameters:

clientBuilder - the HTTP client builder

Returns:

this builder

customizeClient

public HttpClientStreamableHttpTransport.Builder customizeClient(Consumer<HttpClient.Builder> clientCustomizer)

Customizes the HTTP client builder.

Parameters:

clientCustomizer - the consumer to customize the HTTP client builder

Returns:

this builder

requestBuilder

public HttpClientStreamableHttpTransport.Builder requestBuilder(HttpRequest.Builder requestBuilder)

Sets the HTTP request builder.

Parameters:

requestBuilder - the HTTP request builder

Returns:

this builder

customizeRequest

public HttpClientStreamableHttpTransport.Builder customizeRequest(Consumer<HttpRequest.Builder> requestCustomizer)

Customizes the HTTP client builder.

Parameters:

requestCustomizer - the consumer to customize the HTTP request builder

Returns:

this builder

objectMapper

public HttpClientStreamableHttpTransport.Builder objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Configure the ObjectMapper to use.

Parameters:

objectMapper - instance to use

Returns:

the builder instance

endpoint

public HttpClientStreamableHttpTransport.Builder endpoint(String endpoint)

Configure the endpoint to make HTTP requests against.

Parameters:

endpoint - endpoint to use

Returns:

the builder instance

resumableStreams

public HttpClientStreamableHttpTransport.Builder resumableStreams(boolean resumableStreams)

Configure whether to use the stream resumability feature by keeping track of SSE event ids.

Parameters:

resumableStreams - if true event ids will be tracked and upon disconnection, the last seen id will be used upon reconnection as a header to resume consuming messages.

Returns:

the builder instance

openConnectionOnStartup

public HttpClientStreamableHttpTransport.Builder openConnectionOnStartup(boolean openConnectionOnStartup)

Configure whether the client should open an SSE connection upon startup. Not all servers support this (although it is in theory possible with the current specification), so use with caution. By default, this value is false.

Parameters:

openConnectionOnStartup - if true the HttpClientStreamableHttpTransport.connect(Function) method call will try to open an SSE connection before sending any JSON-RPC request

Returns:

the builder instance

httpRequestCustomizer

public HttpClientStreamableHttpTransport.Builder httpRequestCustomizer(McpSyncHttpClientRequestCustomizer syncHttpRequestCustomizer)

Sets the customizer for HttpRequest.Builder, to modify requests before executing them.

This overrides the customizer from asyncHttpRequestCustomizer(McpAsyncHttpClientRequestCustomizer).

Do NOT use a blocking McpSyncHttpClientRequestCustomizer in a non-blocking context. Use asyncHttpRequestCustomizer(McpAsyncHttpClientRequestCustomizer) instead.

Parameters:

syncHttpRequestCustomizer - the request customizer

Returns:

this builder

asyncHttpRequestCustomizer

public HttpClientStreamableHttpTransport.Builder asyncHttpRequestCustomizer(McpAsyncHttpClientRequestCustomizer asyncHttpRequestCustomizer)

Sets the customizer for HttpRequest.Builder, to modify requests before executing them.

This overrides the customizer from httpRequestCustomizer(McpSyncHttpClientRequestCustomizer).

Do NOT use a blocking implementation in a non-blocking context.

Parameters:

asyncHttpRequestCustomizer - the request customizer

Returns:

this builder

connectTimeout

public HttpClientStreamableHttpTransport.Builder connectTimeout(Duration connectTimeout)

Sets the connection timeout for the HTTP client.

Parameters:

connectTimeout - the connection timeout duration

Returns:

this builder

build

public HttpClientStreamableHttpTransport build()

Construct a fresh instance of HttpClientStreamableHttpTransport using the current builder configuration.

Returns:

a new instance of HttpClientStreamableHttpTransport