Package io.modelcontextprotocol.server.transport

Class WebFluxSseServerTransportProvider.Builder

java.lang.Object

io.modelcontextprotocol.server.transport.WebFluxSseServerTransportProvider.Builder

Enclosing class:

WebFluxSseServerTransportProvider

public static class WebFluxSseServerTransportProvider.Builder
extends Object

Builder for creating instances of WebFluxSseServerTransportProvider.

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
WebFluxSseServerTransportProvider.Builder	basePath(String baseUrl)	Sets the project basePath as endpoint prefix where clients should send their JSON-RPC messages
WebFluxSseServerTransportProvider	build()	Builds a new instance of WebFluxSseServerTransportProvider with the configured settings.
WebFluxSseServerTransportProvider.Builder	keepAliveInterval(Duration keepAliveInterval)	Sets the interval for sending keep-alive pings to clients.
WebFluxSseServerTransportProvider.Builder	messageEndpoint(String messageEndpoint)	Sets the endpoint URI where clients should send their JSON-RPC messages.
WebFluxSseServerTransportProvider.Builder	objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Sets the ObjectMapper to use for JSON serialization/deserialization of MCP messages.
WebFluxSseServerTransportProvider.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

public Builder()

Method Details

objectMapper

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

Sets the ObjectMapper to use for JSON serialization/deserialization of MCP messages.

Parameters:

objectMapper - The ObjectMapper instance. Must not be null.

Returns:

this builder instance

Throws:

IllegalArgumentException - if objectMapper is null

basePath

public WebFluxSseServerTransportProvider.Builder basePath(String baseUrl)

Sets the project basePath as endpoint prefix where clients should send their JSON-RPC messages

Parameters:

baseUrl - the message basePath . Must not be null.

Returns:

this builder instance

Throws:

IllegalArgumentException - if basePath is null

messageEndpoint

public WebFluxSseServerTransportProvider.Builder messageEndpoint(String messageEndpoint)

Sets the endpoint URI where clients should send their JSON-RPC messages.

Parameters:

messageEndpoint - The message endpoint URI. Must not be null.

Returns:

this builder instance

Throws:

IllegalArgumentException - if messageEndpoint is null

sseEndpoint

public WebFluxSseServerTransportProvider.Builder sseEndpoint(String sseEndpoint)

Sets the SSE endpoint path.

Parameters:

sseEndpoint - The SSE endpoint path. Must not be null.

Returns:

this builder instance

Throws:

IllegalArgumentException - if sseEndpoint is null

keepAliveInterval

public WebFluxSseServerTransportProvider.Builder keepAliveInterval(Duration keepAliveInterval)

Sets the interval for sending keep-alive pings to clients.

Parameters:

keepAliveInterval - The keep-alive interval duration. If null, keep-alive is disabled.

Returns:

this builder instance

build

public WebFluxSseServerTransportProvider build()

Builds a new instance of WebFluxSseServerTransportProvider with the configured settings.

Returns:

A new WebFluxSseServerTransportProvider instance

Throws:

IllegalStateException - if required parameters are not set