io.modelcontextprotocol.server.transport

Class WebRxSseServerTransportProvider.Builder

java.lang.Object

io.modelcontextprotocol.server.transport.WebRxSseServerTransportProvider.Builder

Enclosing class:

WebRxSseServerTransportProvider

public static class WebRxSseServerTransportProvider.Builder
extends Object

Builder for creating instances of WebMvcSseServerTransportProvider.

This builder provides a fluent API for configuring and creating instances of WebMvcSseServerTransportProvider with custom settings.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
WebRxSseServerTransportProvider.Builder	baseUrl(String baseUrl) Sets the base URL for the server transport.
WebRxSseServerTransportProvider	build() Builds a new instance of WebMvcSseServerTransportProvider with the configured settings.
WebRxSseServerTransportProvider.Builder	contextExtractor(McpTransportContextExtractor<org.noear.solon.core.handle.Context> contextExtractor) Sets the context extractor that allows providing the MCP feature implementations to inspect HTTP transport level metadata that was present at HTTP request processing time.
WebRxSseServerTransportProvider.Builder	keepAliveInterval(Duration keepAliveInterval) Sets the interval for keep-alive pings.
WebRxSseServerTransportProvider.Builder	messageEndpoint(String messageEndpoint) Sets the endpoint path where clients will send their messages.
WebRxSseServerTransportProvider.Builder	objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Sets the JSON object mapper to use for message serialization/deserialization.
WebRxSseServerTransportProvider.Builder	sseEndpoint(String sseEndpoint) Sets the endpoint path where clients will establish SSE connections.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

objectMapper

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

Sets the JSON object mapper to use for message serialization/deserialization.

Parameters:

objectMapper - The object mapper to use

Returns:

This builder instance for method chaining

baseUrl

public WebRxSseServerTransportProvider.Builder baseUrl(String baseUrl)

Sets the base URL for the server transport.

Parameters:

baseUrl - The base URL to use

Returns:

This builder instance for method chaining

messageEndpoint

public WebRxSseServerTransportProvider.Builder messageEndpoint(String messageEndpoint)

Sets the endpoint path where clients will send their messages.

Parameters:

messageEndpoint - The message endpoint path

Returns:

This builder instance for method chaining

sseEndpoint

public WebRxSseServerTransportProvider.Builder sseEndpoint(String sseEndpoint)

Sets the endpoint path where clients will establish SSE connections.

If not specified, the default value of WebRxSseServerTransportProvider.DEFAULT_SSE_ENDPOINT will be used.

Parameters:

sseEndpoint - The SSE endpoint path

Returns:

This builder instance for method chaining

contextExtractor

public WebRxSseServerTransportProvider.Builder contextExtractor(McpTransportContextExtractor<org.noear.solon.core.handle.Context> contextExtractor)

Sets the context extractor that allows providing the MCP feature implementations to inspect HTTP transport level metadata that was present at HTTP request processing time. This allows to extract custom headers and other useful data for use during execution later on in the process.

Parameters:

contextExtractor - The contextExtractor to fill in a McpTransportContext.

Returns:

this builder instance

Throws:

IllegalArgumentException - if contextExtractor is null

keepAliveInterval

public WebRxSseServerTransportProvider.Builder keepAliveInterval(Duration keepAliveInterval)

Sets the interval for keep-alive pings.

If not specified, keep-alive pings will be disabled.

Parameters:

keepAliveInterval - The interval duration for keep-alive pings

Returns:

This builder instance for method chaining

build

public WebRxSseServerTransportProvider build()

Builds a new instance of WebMvcSseServerTransportProvider with the configured settings.

Returns:

A new WebMvcSseServerTransportProvider instance

Throws:

IllegalStateException - if objectMapper or messageEndpoint is not set