Package org.springaicommunity.mcp.method.complete

Class AbstractMcpCompleteMethodCallback

java.lang.Object

org.springaicommunity.mcp.method.complete.AbstractMcpCompleteMethodCallback

Direct Known Subclasses:

AsyncMcpCompleteMethodCallback, AsyncStatelessMcpCompleteMethodCallback, SyncMcpCompleteMethodCallback, SyncStatelessMcpCompleteMethodCallback

public abstract class AbstractMcpCompleteMethodCallback
extends Object

Abstract base class for creating callbacks around complete methods. This class provides common functionality for both synchronous and asynchronous complete method callbacks. It contains shared logic for method validation, argument building, and other common operations.

Author:

Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractMcpCompleteMethodCallback.AbstractBuilder<T extends AbstractMcpCompleteMethodCallback.AbstractBuilder<T,R>,R>	Abstract builder for creating McpCompleteMethodCallback instances.
static class	AbstractMcpCompleteMethodCallback.McpCompleteMethodException	Exception thrown when there is an error invoking a complete method.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Object	bean
protected final io.modelcontextprotocol.spec.McpSchema.CompleteReference	completeReference
protected final Method	method
protected final String	prompt
protected final String	uri
protected final io.modelcontextprotocol.util.McpUriTemplateManager	uriTemplateManager
protected final List<String>	uriVariables

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMcpCompleteMethodCallback(Method method, Object bean, String prompt, String uri, io.modelcontextprotocol.util.McpUriTemplateManagerFactory uriTemplateManagerFactory)	Constructor for AbstractMcpCompleteMethodCallback.

Method Summary

Modifier and Type	Method	Description
protected Object[]	buildArgs(Method method, Object exchange, io.modelcontextprotocol.spec.McpSchema.CompleteRequest request)	Builds the arguments array for invoking the method.
protected abstract boolean	isExchangeType(Class<?> paramType)	Checks if a parameter type is compatible with the exchange type.
protected void	validateMethod(Method method)	Validates that the method signature is compatible with the complete callback.
protected void	validateParameters(Method method)	Validates method parameters.
protected abstract void	validateReturnType(Method method)	Validates that the method return type is compatible with the complete callback.

Methods inherited from class java.lang.Object

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

Field Details

method

protected final Method method

bean

protected final Object bean

prompt

protected final String prompt

uri

protected final String uri

completeReference

protected final io.modelcontextprotocol.spec.McpSchema.CompleteReference completeReference

uriVariables

protected final List<String> uriVariables

uriTemplateManager

protected final io.modelcontextprotocol.util.McpUriTemplateManager uriTemplateManager

Constructor Details

AbstractMcpCompleteMethodCallback

protected AbstractMcpCompleteMethodCallback(Method method,
 Object bean,
 String prompt,
 String uri,
 io.modelcontextprotocol.util.McpUriTemplateManagerFactory uriTemplateManagerFactory)

Constructor for AbstractMcpCompleteMethodCallback.

Parameters:

method - The method to create a callback for

bean - The bean instance that contains the method

prompt - The prompt reference

uri - The URI reference

uriTemplateManagerFactory - The URI template manager factory

Method Details

validateMethod

protected void validateMethod(Method method)

Validates that the method signature is compatible with the complete callback.

This method checks that the return type is valid and that the parameters match the expected pattern.

Parameters:

method - The method to validate

Throws:

IllegalArgumentException - if the method signature is not compatible

validateReturnType

protected abstract void validateReturnType(Method method)

Validates that the method return type is compatible with the complete callback. This method should be implemented by subclasses to handle specific return type validation.

Parameters:

method - The method to validate

Throws:

IllegalArgumentException - if the return type is not compatible

validateParameters

protected void validateParameters(Method method)

Validates method parameters. This method provides common validation logic and delegates exchange type checking to subclasses.

Parameters:

method - The method to validate

Throws:

IllegalArgumentException - if the parameters are not compatible

buildArgs

protected Object[] buildArgs(Method method,
 Object exchange,
 io.modelcontextprotocol.spec.McpSchema.CompleteRequest request)

Builds the arguments array for invoking the method.

This method constructs an array of arguments based on the method's parameter types and the available values (exchange, request, argument).

Parameters:

method - The method to build arguments for

exchange - The server exchange

request - The complete request

Returns:

An array of arguments for the method invocation

isExchangeType

protected abstract boolean isExchangeType(Class<?> paramType)

Checks if a parameter type is compatible with the exchange type. This method should be implemented by subclasses to handle specific exchange type checking.

Parameters:

paramType - The parameter type to check

Returns:

true if the parameter type is compatible with the exchange type, false otherwise