Package io.modelcontextprotocol.server.transport

Class HttpServletSseServerTransportProvider.Builder

java.lang.Object

io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider.Builder

Enclosing class:

HttpServletSseServerTransportProvider

public static class HttpServletSseServerTransportProvider.Builder
extends Object

Builder for creating instances of HttpServletSseServerTransportProvider.

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HttpServletSseServerTransportProvider.Builder	baseUrl(String baseUrl)	Sets the base URL for the server transport.
HttpServletSseServerTransportProvider	build()	Builds a new instance of HttpServletSseServerTransportProvider with the configured settings.
HttpServletSseServerTransportProvider.Builder	contextExtractor(McpTransportContextExtractor<jakarta.servlet.http.HttpServletRequest> contextExtractor)	Sets the context extractor for extracting transport context from the request.
HttpServletSseServerTransportProvider.Builder	jsonMapper(McpJsonMapper jsonMapper)	Sets the JsonMapper implementation to use for serialization/deserialization.
HttpServletSseServerTransportProvider.Builder	keepAliveInterval(Duration keepAliveInterval)	Sets the interval for keep-alive pings.
HttpServletSseServerTransportProvider.Builder	messageEndpoint(String messageEndpoint)	Sets the endpoint path where clients will send their messages.
HttpServletSseServerTransportProvider.Builder	securityValidator(ServerTransportSecurityValidator securityValidator)	Sets the security validator for validating HTTP requests.
HttpServletSseServerTransportProvider.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 Details

Builder

public Builder()

Method Details

jsonMapper

public HttpServletSseServerTransportProvider.Builder jsonMapper(McpJsonMapper jsonMapper)

Sets the JsonMapper implementation to use for serialization/deserialization. If not specified, a JacksonJsonMapper will be created from the configured ObjectMapper.

Parameters:

jsonMapper - The JsonMapper to use

Returns:

This builder instance for method chaining

baseUrl

public HttpServletSseServerTransportProvider.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 HttpServletSseServerTransportProvider.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 HttpServletSseServerTransportProvider.Builder sseEndpoint(String sseEndpoint)

Sets the endpoint path where clients will establish SSE connections.

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

Parameters:

sseEndpoint - The SSE endpoint path

Returns:

This builder instance for method chaining

contextExtractor

public HttpServletSseServerTransportProvider.Builder contextExtractor(McpTransportContextExtractor<jakarta.servlet.http.HttpServletRequest> contextExtractor)

Sets the context extractor for extracting transport context from the request.

Parameters:

contextExtractor - The context extractor to use. Must not be null.

Returns:

this builder instance

Throws:

IllegalArgumentException - if contextExtractor is null

keepAliveInterval

public HttpServletSseServerTransportProvider.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

securityValidator

public HttpServletSseServerTransportProvider.Builder securityValidator(ServerTransportSecurityValidator securityValidator)

Sets the security validator for validating HTTP requests.

Parameters:

securityValidator - The security validator to use. Must not be null.

Returns:

This builder instance

Throws:

IllegalArgumentException - if securityValidator is null

build

public HttpServletSseServerTransportProvider build()

Builds a new instance of HttpServletSseServerTransportProvider with the configured settings.

Returns:

A new HttpServletSseServerTransportProvider instance

Throws:

IllegalStateException - if jsonMapper or messageEndpoint is not set