Module io.modelcontextprotocol.sdk.mcp
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 Details

    • Builder

      public Builder()

  • Method Details

    • objectMapper

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

    • 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

    • build

      public HttpServletSseServerTransportProvider build()
      Builds a new instance of HttpServletSseServerTransportProvider with the configured settings.
      Returns:
      A new HttpServletSseServerTransportProvider instance
      Throws:
      IllegalStateException - if objectMapper or messageEndpoint is not set