org.springframework.messaging.handler.invocation

Class InvocableHandlerMethod

java.lang.Object

org.springframework.messaging.handler.HandlerMethod

org.springframework.messaging.handler.invocation.InvocableHandlerMethod

public class InvocableHandlerMethod
extends HandlerMethod

Invokes the handler method for a given message after resolving its method argument values through registered HandlerMethodArgumentResolvers.

Use setMessageMethodArgumentResolvers(HandlerMethodArgumentResolver) to customize the list of argument resolvers.

Since:

4.0

Author:

Rossen Stoyanchev

Field Summary

Fields inherited from class org.springframework.messaging.handler.HandlerMethod

logger

Constructor Summary

Constructors

Constructor and Description
InvocableHandlerMethod(HandlerMethod handlerMethod) Create an instance from a HandlerMethod.
InvocableHandlerMethod(java.lang.Object bean, java.lang.reflect.Method method) Create an instance from a bean instance and a method.
InvocableHandlerMethod(java.lang.Object bean, java.lang.String methodName, java.lang.Class<?>... parameterTypes) Construct a new handler method with the given bean instance, method name and parameters.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getDetailedErrorMessage(java.lang.String message) Adds HandlerMethod details such as the controller type and method signature to the given error message.
java.lang.Object	invoke(Message<?> message, java.lang.Object... providedArgs) Invoke the method with the given message.
void	setMessageMethodArgumentResolvers(HandlerMethodArgumentResolver argumentResolvers) Set HandlerMethodArgumentResolvers to use to use for resolving method argument values.
void	setParameterNameDiscoverer(ParameterNameDiscoverer parameterNameDiscoverer) Set the ParameterNameDiscoverer for resolving parameter names when needed (e.g.

Methods inherited from class org.springframework.messaging.handler.HandlerMethod

createWithResolvedBean, equals, getBean, getBeanType, getBridgedMethod, getMethod, getMethodAnnotation, getMethodParameters, getReturnType, getReturnValueType, getShortLogMessage, hashCode, isVoid, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InvocableHandlerMethod

public InvocableHandlerMethod(HandlerMethod handlerMethod)

Create an instance from a HandlerMethod.

InvocableHandlerMethod

public InvocableHandlerMethod(java.lang.Object bean,
                              java.lang.reflect.Method method)

Create an instance from a bean instance and a method.

InvocableHandlerMethod

public InvocableHandlerMethod(java.lang.Object bean,
                              java.lang.String methodName,
                              java.lang.Class<?>... parameterTypes)
                       throws java.lang.NoSuchMethodException

Construct a new handler method with the given bean instance, method name and parameters.

Parameters:

bean - the object bean

methodName - the method name

parameterTypes - the method parameter types

Throws:

java.lang.NoSuchMethodException - when the method cannot be found

Method Detail

setMessageMethodArgumentResolvers

public void setMessageMethodArgumentResolvers(HandlerMethodArgumentResolver argumentResolvers)

Set HandlerMethodArgumentResolvers to use to use for resolving method argument values.

setParameterNameDiscoverer

public void setParameterNameDiscoverer(ParameterNameDiscoverer parameterNameDiscoverer)

Set the ParameterNameDiscoverer for resolving parameter names when needed (e.g. default request attribute name).

Default is a DefaultParameterNameDiscoverer.

invoke

public final java.lang.Object invoke(Message<?> message,
                                     java.lang.Object... providedArgs)
                              throws java.lang.Exception

Invoke the method with the given message.

Throws:

java.lang.Exception - raised if no suitable argument resolver can be found, or the method raised an exception

getDetailedErrorMessage

protected java.lang.String getDetailedErrorMessage(java.lang.String message)

Adds HandlerMethod details such as the controller type and method signature to the given error message.

Parameters:

message - error message to append the HandlerMethod details to