Class InvocableHandlerMethod
- java.lang.Object
- org.springframework.messaging.handler.HandlerMethod
- org.springframework.messaging.handler.invocation.InvocableHandlerMethod
public class InvocableHandlerMethod extends HandlerMethod
Provides a method for invoking the handler method for a given message after resolving its method argument values through registeredHandlerMethodArgumentResolver
s.Use
setMessageMethodArgumentResolvers(org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolverComposite)
to customize the list of argument resolvers.- Since:
- 4.0
- Author:
- Rossen Stoyanchev, Juergen Hoeller
Nested Class Summary
Nested classes/interfaces inherited from class org.springframework.messaging.handler.HandlerMethod
HandlerMethod.HandlerMethodParameter
Field Summary
Fields inherited from class org.springframework.messaging.handler.HandlerMethod
logger
Constructor Summary
Constructors Constructor Description InvocableHandlerMethod(Object bean, Method method)
Create an instance from a bean instance and a method.InvocableHandlerMethod(Object bean, String methodName, Class<?>... parameterTypes)
Construct a new handler method with the given bean instance, method name and parameters.InvocableHandlerMethod(HandlerMethod handlerMethod)
Create an instance from aHandlerMethod
.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Object
doInvoke(Object... args)
Invoke the handler method with the given argument values.protected String
getDetailedErrorMessage(String text)
Adds HandlerMethod details such as the bean type and method signature to the message.Object
invoke(Message<?> message, Object... providedArgs)
Invoke the method after resolving its argument values in the context of the given message.void
setMessageMethodArgumentResolvers(HandlerMethodArgumentResolverComposite argumentResolvers)
SetHandlerMethodArgumentResolver
s 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, getResolvedFromHandlerMethod, getReturnType, getReturnValueType, getShortLogMessage, hashCode, hasMethodAnnotation, isVoid, toString
Constructor Detail
InvocableHandlerMethod
public InvocableHandlerMethod(HandlerMethod handlerMethod)
Create an instance from aHandlerMethod
.
InvocableHandlerMethod
public InvocableHandlerMethod(Object bean, Method method)
Create an instance from a bean instance and a method.
InvocableHandlerMethod
public InvocableHandlerMethod(Object bean, String methodName, Class<?>... parameterTypes) throws NoSuchMethodException
Construct a new handler method with the given bean instance, method name and parameters.- Parameters:
bean
- the object beanmethodName
- the method nameparameterTypes
- the method parameter types- Throws:
NoSuchMethodException
- when the method cannot be found
Method Detail
setMessageMethodArgumentResolvers
public void setMessageMethodArgumentResolvers(HandlerMethodArgumentResolverComposite argumentResolvers)
SetHandlerMethodArgumentResolver
s 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 Object invoke(Message<?> message, Object... providedArgs) throws Exception
Invoke the method after resolving its argument values in the context of the given message.Argument values are commonly resolved through
HandlerMethodArgumentResolver
s. TheprovidedArgs
parameter however may supply argument values to be used directly, i.e. without argument resolution.- Parameters:
message
- the current message being processedprovidedArgs
- "given" arguments matched by type, not resolved- Returns:
- the raw value returned by the invoked method
- Throws:
Exception
- raised if no suitable argument resolver can be found, or if the method raised an exception
doInvoke
protected Object doInvoke(Object... args) throws Exception
Invoke the handler method with the given argument values.- Throws:
Exception
getDetailedErrorMessage
protected String getDetailedErrorMessage(String text)
Adds HandlerMethod details such as the bean type and method signature to the message.- Parameters:
text
- error message to append the HandlerMethod details to