Class InvocableHandlerMethod
java.lang.Object
org.springframework.messaging.handler.HandlerMethod
org.springframework.messaging.handler.invocation.InvocableHandlerMethod
Extension of
HandlerMethod
that invokes the underlying method with
argument values resolved from the current HTTP request through a list of
HandlerMethodArgumentResolver
.- 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
defaultLogger, logger
-
Constructor Summary
ConstructorDescriptionInvocableHandlerMethod
(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
Modifier and TypeMethodDescriptionprotected Object
Invoke the handler method with the given argument values.protected Object[]
getMethodArgumentValues
(Message<?> message, Object... providedArgs) Get the method argument values for the current message, checking the provided argument values and falling back to the configured argument resolvers.Invoke the method after resolving its argument values in the context of the given message.void
setMessageMethodArgumentResolvers
(HandlerMethodArgumentResolverComposite argumentResolvers) SetHandlerMethodArgumentResolvers
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
assertTargetBean, createWithResolvedBean, equals, findProvidedArgument, formatArgumentError, formatInvokeError, getBean, getBeanType, getBridgedMethod, getLogger, getMethod, getMethodAnnotation, getMethodParameters, getResolvedFromHandlerMethod, getReturnType, getReturnValueType, getShortLogMessage, hashCode, hasMethodAnnotation, isVoid, setLogger, toString
-
Constructor Details
-
InvocableHandlerMethod
Create an instance from aHandlerMethod
. -
InvocableHandlerMethod
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 Details
-
setMessageMethodArgumentResolvers
public void setMessageMethodArgumentResolvers(HandlerMethodArgumentResolverComposite argumentResolvers) SetHandlerMethodArgumentResolvers
to use for resolving method argument values. -
setParameterNameDiscoverer
Set the ParameterNameDiscoverer for resolving parameter names when needed (e.g. default request attribute name).Default is a
DefaultParameterNameDiscoverer
. -
invoke
Invoke the method after resolving its argument values in the context of the given message.Argument values are commonly resolved through
HandlerMethodArgumentResolvers
. TheprovidedArgs
parameter however may supply argument values to be used directly, i.e. without argument resolution.Delegates to
getMethodArgumentValues(org.springframework.messaging.Message<?>, java.lang.Object...)
and callsdoInvoke(java.lang.Object...)
with the resolved arguments.- 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- See Also:
-
getMethodArgumentValues
protected Object[] getMethodArgumentValues(Message<?> message, Object... providedArgs) throws Exception Get the method argument values for the current message, checking the provided argument values and falling back to the configured argument resolvers.The resulting array will be passed into
doInvoke(java.lang.Object...)
.- Throws:
Exception
- Since:
- 5.1.2
-
doInvoke
Invoke the handler method with the given argument values.- Throws:
Exception
-