Class InvocableShellMethod
The class may be created with a bean instance or with a bean name
(e.g. lazy-init bean, prototype bean). Use createWithResolvedBean()
to obtain a HandlerMethod
instance with a bean instance resolved
through the associated BeanFactory
.
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected class
A MethodParameter with HandlerMethod-specific behavior. -
Field Summary
Modifier and TypeFieldDescriptionstatic final org.slf4j.Logger
Public for wrapping with fallback logger. -
Constructor Summary
ModifierConstructorDescriptionInvocableShellMethod
(Object bean, Method method) Create an instance from a bean instance and a method.InvocableShellMethod
(Object bean, String methodName, Class<?>... parameterTypes) Create an instance from a bean instance, method name, and parameter types.InvocableShellMethod
(String beanName, org.springframework.beans.factory.BeanFactory beanFactory, Method method) Create an instance from a bean name, a method, and aBeanFactory
.protected
InvocableShellMethod
(InvocableShellMethod handlerMethod) Copy constructor for use in subclasses. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
assertTargetBean
(Method method, Object targetBean, Object[] args) Assert that the target bean class is an instance of the class where the given method is declared.If the provided instance contains a bean name rather than an object instance, the bean name is resolved before aInvocableShellMethod
is created and returned.protected Object
Invoke the handler method with the given argument values.boolean
protected static Object
findProvidedArgument
(org.springframework.core.MethodParameter parameter, Object... providedArgs) protected static String
formatArgumentError
(org.springframework.core.MethodParameter param, String message) protected String
formatInvokeError
(String text, Object[] args) getBean()
Return the bean for this handler method.Class<?>
This method returns the type of the handler for this handler method.protected Method
If the bean method is a bridge method, this method returns the bridged (user-defined) method.Return the method for this handler method.<A extends Annotation>
AgetMethodAnnotation
(Class<A> annotationType) Return a single annotation on the underlying method traversing its super methods if no annotation can be found on the given method itself.protected Object[]
getMethodArgumentValues
(org.springframework.messaging.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.org.springframework.core.MethodParameter[]
Return the method parameters for this handler method.Return the HandlerMethod from which this HandlerMethod instance was resolved viacreateWithResolvedBean()
.org.springframework.core.MethodParameter
Return the HandlerMethod return type.org.springframework.core.MethodParameter
getReturnValueType
(Object returnValue) Return the actual return value type.Return a short representation of this handler method for log message purposes.int
hashCode()
<A extends Annotation>
booleanhasMethodAnnotation
(Class<A> annotationType) Return whether the parameter is declared with the given annotation type.Invoke the method after resolving its argument values in the context of the given message.boolean
isVoid()
Returntrue
if the method return type is void,false
otherwise.void
setConversionService
(org.springframework.core.convert.ConversionService conversionService) Sets a conversion servicevoid
setMessageMethodArgumentResolvers
(ShellMethodArgumentResolverComposite argumentResolvers) SetHandlerMethodArgumentResolvers
to use to use for resolving method argument values.void
setParameterNameDiscoverer
(org.springframework.core.ParameterNameDiscoverer parameterNameDiscoverer) Set the ParameterNameDiscoverer for resolving parameter names when needed (e.g.void
setValidator
(jakarta.validation.Validator validator) toString()
-
Field Details
-
log
public static final org.slf4j.Logger logPublic for wrapping with fallback logger.
-
-
Constructor Details
-
InvocableShellMethod
Create an instance from a bean instance and a method. -
InvocableShellMethod
public InvocableShellMethod(Object bean, String methodName, Class<?>... parameterTypes) throws NoSuchMethodException Create an instance from a bean instance, method name, and parameter types.- Throws:
NoSuchMethodException
- when the method cannot be found
-
InvocableShellMethod
public InvocableShellMethod(String beanName, org.springframework.beans.factory.BeanFactory beanFactory, Method method) Create an instance from a bean name, a method, and aBeanFactory
. The methodcreateWithResolvedBean()
may be used later to re-create theHandlerMethod
with an initialized bean. -
InvocableShellMethod
Copy constructor for use in subclasses.
-
-
Method Details
-
setConversionService
public void setConversionService(org.springframework.core.convert.ConversionService conversionService) Sets a conversion service- Parameters:
conversionService
- the conversion service
-
setValidator
public void setValidator(jakarta.validation.Validator validator) -
setMessageMethodArgumentResolvers
public void setMessageMethodArgumentResolvers(ShellMethodArgumentResolverComposite argumentResolvers) SetHandlerMethodArgumentResolvers
to use to use for resolving method argument values. -
setParameterNameDiscoverer
public void setParameterNameDiscoverer(org.springframework.core.ParameterNameDiscoverer parameterNameDiscoverer) Set the ParameterNameDiscoverer for resolving parameter names when needed (e.g. default request attribute name).Default is a
DefaultParameterNameDiscoverer
. -
invoke
@Nullable public Object invoke(org.springframework.messaging.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
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(org.springframework.messaging.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
-
doInvoke
Invoke the handler method with the given argument values.- Throws:
Exception
-
getBean
Return the bean for this handler method. -
getMethod
Return the method for this handler method. -
getBeanType
This method returns the type of the handler for this handler method.Note that if the bean type is a CGLIB-generated class, the original user-defined class is returned.
-
getBridgedMethod
If the bean method is a bridge method, this method returns the bridged (user-defined) method. Otherwise it returns the same method asgetMethod()
. -
getMethodParameters
public org.springframework.core.MethodParameter[] getMethodParameters()Return the method parameters for this handler method. -
getReturnType
public org.springframework.core.MethodParameter getReturnType()Return the HandlerMethod return type. -
getReturnValueType
Return the actual return value type. -
isVoid
public boolean isVoid()Returntrue
if the method return type is void,false
otherwise. -
getMethodAnnotation
Return a single annotation on the underlying method traversing its super methods if no annotation can be found on the given method itself.Also supports merged composed annotations with attribute overrides.
- Parameters:
annotationType
- the type of annotation to introspect the method for- Returns:
- the annotation, or
null
if none found - See Also:
-
AnnotatedElementUtils.findMergedAnnotation(java.lang.reflect.AnnotatedElement, java.lang.Class<A>)
-
hasMethodAnnotation
Return whether the parameter is declared with the given annotation type.- Parameters:
annotationType
- the annotation type to look for- See Also:
-
AnnotatedElementUtils.hasAnnotation(java.lang.reflect.AnnotatedElement, java.lang.Class<? extends java.lang.annotation.Annotation>)
-
getResolvedFromHandlerMethod
Return the HandlerMethod from which this HandlerMethod instance was resolved viacreateWithResolvedBean()
. -
createWithResolvedBean
If the provided instance contains a bean name rather than an object instance, the bean name is resolved before aInvocableShellMethod
is created and returned. -
getShortLogMessage
Return a short representation of this handler method for log message purposes. -
equals
-
hashCode
public int hashCode() -
toString
-
findProvidedArgument
-
formatArgumentError
-
assertTargetBean
Assert that the target bean class is an instance of the class where the given method is declared. In some cases the actual endpoint instance at request- processing time may be a JDK dynamic proxy (lazy initialization, prototype beans, and others). Endpoint classes that require proxying should prefer class-based proxy mechanisms. -
formatInvokeError
-