Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.client.transport

Class HttpClientSseClientTransport.Builder

java.lang.Object

io.modelcontextprotocol.client.transport.HttpClientSseClientTransport.Builder

Enclosing class:

HttpClientSseClientTransport

public static class HttpClientSseClientTransport.Builder
extends Object

Builder for HttpClientSseClientTransport.

Constructor Summary

Constructors

Constructor	Description
Builder(String baseUri)	Deprecated, for removal: This API element is subject to removal in a future version. Use HttpClientSseClientTransport.builder(String) instead.

Method Summary

Modifier and Type	Method	Description
HttpClientSseClientTransport.Builder	asyncHttpRequestCustomizer(McpAsyncHttpClientRequestCustomizer asyncHttpRequestCustomizer)	Sets the customizer for HttpRequest.Builder, to modify requests before executing them.
HttpClientSseClientTransport	build()	Builds a new HttpClientSseClientTransport instance.
HttpClientSseClientTransport.Builder	clientBuilder(HttpClient.Builder clientBuilder)	Sets the HTTP client builder.
HttpClientSseClientTransport.Builder	connectTimeout(Duration connectTimeout)	Sets the connection timeout for the HTTP client.
HttpClientSseClientTransport.Builder	customizeClient(Consumer<HttpClient.Builder> clientCustomizer)	Customizes the HTTP client builder.
HttpClientSseClientTransport.Builder	customizeRequest(Consumer<HttpRequest.Builder> requestCustomizer)	Customizes the HTTP client builder.
HttpClientSseClientTransport.Builder	httpRequestCustomizer(McpSyncHttpClientRequestCustomizer syncHttpRequestCustomizer)	Sets the customizer for HttpRequest.Builder, to modify requests before executing them.
HttpClientSseClientTransport.Builder	objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Sets the object mapper for JSON serialization/deserialization.
HttpClientSseClientTransport.Builder	requestBuilder(HttpRequest.Builder requestBuilder)	Sets the HTTP request builder.
HttpClientSseClientTransport.Builder	sseEndpoint(String sseEndpoint)	Sets the SSE endpoint path.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

@Deprecated(forRemoval=true)
public Builder(String baseUri)

Deprecated, for removal: This API element is subject to removal in a future version.

Use HttpClientSseClientTransport.builder(String) instead. This constructor is deprecated and will be removed or made protected or private in a future release.

Creates a new builder with the specified base URI.

Parameters:

baseUri - the base URI of the MCP server

Method Details

sseEndpoint

public HttpClientSseClientTransport.Builder sseEndpoint(String sseEndpoint)

Sets the SSE endpoint path.

Parameters:

sseEndpoint - the SSE endpoint path

Returns:

this builder

clientBuilder

public HttpClientSseClientTransport.Builder clientBuilder(HttpClient.Builder clientBuilder)

Sets the HTTP client builder.

Parameters:

clientBuilder - the HTTP client builder

Returns:

this builder

customizeClient

public HttpClientSseClientTransport.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 HttpClientSseClientTransport.Builder requestBuilder(HttpRequest.Builder requestBuilder)

Sets the HTTP request builder.

Parameters:

requestBuilder - the HTTP request builder

Returns:

this builder

customizeRequest

public HttpClientSseClientTransport.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 HttpClientSseClientTransport.Builder objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Sets the object mapper for JSON serialization/deserialization.

Parameters:

objectMapper - the object mapper

Returns:

this builder

httpRequestCustomizer

public HttpClientSseClientTransport.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 HttpClientSseClientTransport.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 HttpClientSseClientTransport.Builder connectTimeout(Duration connectTimeout)

Sets the connection timeout for the HTTP client.

Parameters:

connectTimeout - the connection timeout duration

Returns:

this builder

build

public HttpClientSseClientTransport build()

Builds a new HttpClientSseClientTransport instance.

Returns:

a new transport instance