Package org.springaicommunity.mcp.method.logging

Class AbstractMcpLoggingMethodCallback

java.lang.Object

org.springaicommunity.mcp.method.logging.AbstractMcpLoggingMethodCallback

Direct Known Subclasses:

AsyncMcpLoggingMethodCallback, SyncMcpLoggingMethodCallback

public abstract class AbstractMcpLoggingMethodCallback
extends Object

Abstract base class for creating callbacks around logging consumer methods. This class provides common functionality for both synchronous and asynchronous logging consumer 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	AbstractMcpLoggingMethodCallback.AbstractBuilder<T extends AbstractMcpLoggingMethodCallback.AbstractBuilder<T,R>,R>	Abstract builder for creating McpLoggingConsumerMethodCallback instances.
static class	AbstractMcpLoggingMethodCallback.McpLoggingConsumerMethodException	Exception thrown when there is an error invoking a logging consumer method.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Object	bean
protected final Method	method

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMcpLoggingMethodCallback(Method method, Object bean)	Constructor for AbstractMcpLoggingConsumerMethodCallback.

Method Summary

Modifier and Type	Method	Description
protected Object[]	buildArgs(Method method, Object exchange, io.modelcontextprotocol.spec.McpSchema.LoggingMessageNotification notification)	Builds the arguments array for invoking the method.
protected void	validateMethod(Method method)	Validates that the method signature is compatible with the logging consumer 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 logging consumer 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

Constructor Details

AbstractMcpLoggingMethodCallback

protected AbstractMcpLoggingMethodCallback(Method method,
 Object bean)

Constructor for AbstractMcpLoggingConsumerMethodCallback.

Parameters:

method - The method to create a callback for

bean - The bean instance that contains the method

Method Details

validateMethod

protected void validateMethod(Method method)

Validates that the method signature is compatible with the logging consumer 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 logging consumer 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.LoggingMessageNotification notification)

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, notification).

Parameters:

method - The method to build arguments for

exchange - The server exchange

notification - The logging message notification

Returns:

An array of arguments for the method invocation