org.springframework.web.servlet.mvc.method.annotation

Class ServletInvocableHandlerMethod

java.lang.Object

org.springframework.web.method.HandlerMethod

org.springframework.web.method.support.InvocableHandlerMethod

org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod

Direct Known Subclasses:

ServletInvocableHandlerMethod.ConcurrentResultHandlerMethod

public class ServletInvocableHandlerMethod
extends InvocableHandlerMethod

Extends InvocableHandlerMethod with the ability to handle return values through a registered HandlerMethodReturnValueHandler and also supports setting the response status based on a method-level @ResponseStatus annotation.

A null return value (including void) may be interpreted as the end of request processing in combination with a @ResponseStatus annotation, a not-modified check condition (see ServletWebRequest.checkNotModified(long)), or a method argument that provides access to the response stream.

Since:

3.1

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ServletInvocableHandlerMethod.ConcurrentResultHandlerMethod A nested subclass of ServletInvocableHandlerMethod that uses a simple Callable instead of the original controller as the handler in order to return the fixed (concurrent) result value given to it.
private class	ServletInvocableHandlerMethod.ConcurrentResultMethodParameter MethodParameter subclass based on the actual return value type or if that's null falling back on the generic type within the declared async return type, e.g.

Nested classes/interfaces inherited from class org.springframework.web.method.HandlerMethod

HandlerMethod.HandlerMethodParameter

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.reflect.Method	CALLABLE_METHOD
private java.lang.String	responseReason
private HttpStatus	responseStatus
private HandlerMethodReturnValueHandlerComposite	returnValueHandlers

Fields inherited from class org.springframework.web.method.HandlerMethod

logger

Constructor Summary

Constructors

Constructor and Description
ServletInvocableHandlerMethod(HandlerMethod handlerMethod) Create an instance from a HandlerMethod.
ServletInvocableHandlerMethod(java.lang.Object handler, java.lang.reflect.Method method) Creates an instance from the given handler and method.

Method Summary

Modifier and Type	Method and Description
private java.lang.String	getReturnValueHandlingErrorMessage(java.lang.String message, java.lang.Object returnValue)
private boolean	hasResponseStatus() Does this method have the response status instruction?
private void	initResponseStatus()
void	invokeAndHandle(ServletWebRequest webRequest, ModelAndViewContainer mavContainer, java.lang.Object... providedArgs) Invokes the method and handles the return value through one of the configured HandlerMethodReturnValueHandlers.
private boolean	isRequestNotModified(ServletWebRequest webRequest) Does the given request qualify as "not modified"?
void	setHandlerMethodReturnValueHandlers(HandlerMethodReturnValueHandlerComposite returnValueHandlers) Register HandlerMethodReturnValueHandler instances to use to handle return values.
private void	setResponseStatus(ServletWebRequest webRequest) Set the response status according to the ResponseStatus annotation.
(package private) ServletInvocableHandlerMethod	wrapConcurrentResult(java.lang.Object result) Create a nested ServletInvocableHandlerMethod subclass that returns the the given value (or raises an Exception if the value is one) rather than actually invoking the controller method.

Methods inherited from class org.springframework.web.method.support.InvocableHandlerMethod

doInvoke, getDetailedErrorMessage, invokeForRequest, setDataBinderFactory, setHandlerMethodArgumentResolvers, setParameterNameDiscoverer

Methods inherited from class org.springframework.web.method.HandlerMethod

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

Methods inherited from class java.lang.Object

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

Field Detail

CALLABLE_METHOD

private static final java.lang.reflect.Method CALLABLE_METHOD

responseStatus

private HttpStatus responseStatus

responseReason

private java.lang.String responseReason

returnValueHandlers

private HandlerMethodReturnValueHandlerComposite returnValueHandlers

Constructor Detail

ServletInvocableHandlerMethod

public ServletInvocableHandlerMethod(java.lang.Object handler,
                                     java.lang.reflect.Method method)

Creates an instance from the given handler and method.

ServletInvocableHandlerMethod

public ServletInvocableHandlerMethod(HandlerMethod handlerMethod)

Create an instance from a HandlerMethod.

Method Detail

initResponseStatus

private void initResponseStatus()

setHandlerMethodReturnValueHandlers

public void setHandlerMethodReturnValueHandlers(HandlerMethodReturnValueHandlerComposite returnValueHandlers)

Register HandlerMethodReturnValueHandler instances to use to handle return values.

invokeAndHandle

public void invokeAndHandle(ServletWebRequest webRequest,
                            ModelAndViewContainer mavContainer,
                            java.lang.Object... providedArgs)
                     throws java.lang.Exception

Invokes the method and handles the return value through one of the configured HandlerMethodReturnValueHandlers.

Parameters:

webRequest - the current request

mavContainer - the ModelAndViewContainer for this request

providedArgs - "given" arguments matched by type (not resolved)

Throws:

java.lang.Exception

setResponseStatus

private void setResponseStatus(ServletWebRequest webRequest)
                        throws java.io.IOException

Set the response status according to the ResponseStatus annotation.

Throws:

java.io.IOException

isRequestNotModified

private boolean isRequestNotModified(ServletWebRequest webRequest)

Does the given request qualify as "not modified"?

See Also:

ServletWebRequest.checkNotModified(long), ServletWebRequest.checkNotModified(String)

hasResponseStatus

private boolean hasResponseStatus()

Does this method have the response status instruction?

getReturnValueHandlingErrorMessage

private java.lang.String getReturnValueHandlingErrorMessage(java.lang.String message,
                                                            java.lang.Object returnValue)

wrapConcurrentResult

ServletInvocableHandlerMethod wrapConcurrentResult(java.lang.Object result)

Create a nested ServletInvocableHandlerMethod subclass that returns the the given value (or raises an Exception if the value is one) rather than actually invoking the controller method. This is useful when processing async return values (e.g. Callable, DeferredResult, ListenableFuture).