io.modelcontextprotocol.server.transport

类 WebRxSseServerTransportProvider

java.lang.Object

io.modelcontextprotocol.server.transport.WebRxSseServerTransportProvider

所有已实现的接口:

McpServerTransportProvider

public class WebRxSseServerTransportProvider
extends java.lang.Object
implements McpServerTransportProvider

Server-side implementation of the MCP (Model Context Protocol) HTTP transport using Server-Sent Events (SSE). This implementation provides a bidirectional communication channel between MCP clients and servers using HTTP POST for client-to-server messages and SSE for server-to-client messages.

Key features:

• Implements the McpServerTransportProvider interface that allows managing McpServerSession instances and enabling their communication with the McpServerTransport abstraction.
• Uses WebFlux for non-blocking request handling and SSE support
• Maintains client sessions for reliable message delivery
• Supports graceful shutdown with session cleanup
• Thread-safe message broadcasting to multiple clients

The transport sets up two main endpoints:

• SSE endpoint (/sse) - For establishing SSE connections with clients
• Message endpoint (configurable) - For receiving JSON-RPC messages from clients

This implementation is thread-safe and can handle multiple concurrent client connections. It uses ConcurrentHashMap for session management and Project Reactor's non-blocking APIs for message processing and delivery. and base JDK8

另请参阅:

McpServerTransport, SseEvent

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	WebRxSseServerTransportProvider.Builder Builder for creating instances of WebRxSseServerTransportProvider.
class	WebRxSseServerTransportProvider.WebRxMcpSessionTransport

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	DEFAULT_SSE_ENDPOINT Default SSE endpoint path as specified by the MCP transport specification.
static java.lang.String	ENDPOINT_EVENT_TYPE Event type for sending the message endpoint URI to clients.
static java.lang.String	MESSAGE_EVENT_TYPE Event type for JSON-RPC messages sent through the SSE connection.

构造器概要

构造器

构造器和说明
WebRxSseServerTransportProvider(com.fasterxml.jackson.databind.ObjectMapper objectMapper, java.lang.String messageEndpoint) Constructs a new WebFlux SSE server transport provider instance with the default SSE endpoint.
WebRxSseServerTransportProvider(com.fasterxml.jackson.databind.ObjectMapper objectMapper, java.lang.String messageEndpoint, java.lang.String sseEndpoint) Constructs a new WebFlux SSE server transport provider instance.

方法概要

限定符和类型	方法和说明
static WebRxSseServerTransportProvider.Builder	builder()
reactor.core.publisher.Mono<java.lang.Void>	closeGracefully() Initiates a graceful shutdown of all the sessions.
java.lang.String	getMessageEndpoint()
java.lang.String	getSseEndpoint()
void	handleMessage(org.noear.solon.core.handle.Context ctx) Handles incoming JSON-RPC messages from clients.
void	handleSseConnection(org.noear.solon.core.handle.Context ctx) Handles new SSE connection requests from clients.
reactor.core.publisher.Mono<java.lang.Void>	notifyClients(java.lang.String method, java.util.Map<java.lang.String,java.lang.Object> params) Broadcasts a JSON-RPC message to all connected clients through their SSE connections.
void	sendHeartbeat()
void	setSessionFactory(McpServerSession.Factory sessionFactory) Sets the session factory that will be used to create sessions for new clients.
void	toHttpHandler(org.noear.solon.SolonApp app)

从类继承的方法 java.lang.Object

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

从接口继承的方法 io.modelcontextprotocol.spec.McpServerTransportProvider

close

字段详细资料

MESSAGE_EVENT_TYPE

public static final java.lang.String MESSAGE_EVENT_TYPE

Event type for JSON-RPC messages sent through the SSE connection.

另请参阅:

常量字段值

ENDPOINT_EVENT_TYPE

public static final java.lang.String ENDPOINT_EVENT_TYPE

Event type for sending the message endpoint URI to clients.

另请参阅:

常量字段值

DEFAULT_SSE_ENDPOINT

public static final java.lang.String DEFAULT_SSE_ENDPOINT

Default SSE endpoint path as specified by the MCP transport specification.

另请参阅:

常量字段值

构造器详细资料

WebRxSseServerTransportProvider

public WebRxSseServerTransportProvider(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                       java.lang.String messageEndpoint,
                                       java.lang.String sseEndpoint)

Constructs a new WebFlux SSE server transport provider instance.

参数:

objectMapper - The ObjectMapper to use for JSON serialization/deserialization of MCP messages. Must not be null.

messageEndpoint - The endpoint URI where clients should send their JSON-RPC messages. This endpoint will be communicated to clients during SSE connection setup. Must not be null.

抛出:

java.lang.IllegalArgumentException - if either parameter is null

WebRxSseServerTransportProvider

public WebRxSseServerTransportProvider(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                       java.lang.String messageEndpoint)

Constructs a new WebFlux SSE server transport provider instance with the default SSE endpoint.

参数:

objectMapper - The ObjectMapper to use for JSON serialization/deserialization of MCP messages. Must not be null.

messageEndpoint - The endpoint URI where clients should send their JSON-RPC messages. This endpoint will be communicated to clients during SSE connection setup. Must not be null.

抛出:

java.lang.IllegalArgumentException - if either parameter is null

方法详细资料

sendHeartbeat

public void sendHeartbeat()

toHttpHandler

public void toHttpHandler(org.noear.solon.SolonApp app)

getSseEndpoint

public java.lang.String getSseEndpoint()

getMessageEndpoint

public java.lang.String getMessageEndpoint()

setSessionFactory

public void setSessionFactory(McpServerSession.Factory sessionFactory)

从接口复制的说明: McpServerTransportProvider

Sets the session factory that will be used to create sessions for new clients. An implementation of the MCP server MUST call this method before any MCP interactions take place.

指定者:

setSessionFactory 在接口中 McpServerTransportProvider

参数:

sessionFactory - the session factory to be used for initiating client sessions

notifyClients

public reactor.core.publisher.Mono<java.lang.Void> notifyClients(java.lang.String method,
                                                                 java.util.Map<java.lang.String,java.lang.Object> params)

Broadcasts a JSON-RPC message to all connected clients through their SSE connections. The message is serialized to JSON and sent as a server-sent event to each active session.

The method:

• Serializes the message to JSON
• Creates a server-sent event with the message data
• Attempts to send the event to all active sessions
• Tracks and reports any delivery failures

指定者:

notifyClients 在接口中 McpServerTransportProvider

参数:

method - The JSON-RPC method to send to clients

params - The method parameters to send to clients

返回:

A Mono that completes when the message has been sent to all sessions, or errors if any session fails to receive the message

另请参阅:

McpSession.sendNotification(String, Map)

closeGracefully

public reactor.core.publisher.Mono<java.lang.Void> closeGracefully()

Initiates a graceful shutdown of all the sessions. This method ensures all active sessions are properly closed and cleaned up.

The shutdown process:

• Marks the transport as closing to prevent new connections
• Closes each active session
• Removes closed sessions from the sessions map
• Times out after 5 seconds if shutdown takes too long

指定者:

closeGracefully 在接口中 McpServerTransportProvider

返回:

A Mono that completes when all sessions have been closed

handleSseConnection

public void handleSseConnection(org.noear.solon.core.handle.Context ctx)
                         throws java.lang.Throwable

Handles new SSE connection requests from clients. Creates a new session for each connection and sets up the SSE event stream.

参数:

ctx - The incoming server context

抛出:

java.lang.Throwable

handleMessage

public void handleMessage(org.noear.solon.core.handle.Context ctx)
                   throws java.lang.Throwable

Handles incoming JSON-RPC messages from clients. Deserializes the message and processes it through the configured message handler.

The handler:

• Deserializes the incoming JSON-RPC message
• Passes it through the message handler chain
• Returns appropriate HTTP responses based on processing results
• Handles various error conditions with appropriate error responses

参数:

ctx - The incoming server request context containing the JSON-RPC message

抛出:

java.lang.Throwable

builder

public static WebRxSseServerTransportProvider.Builder builder()