|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.context.support.ApplicationObjectSupport org.springframework.web.context.support.WebApplicationObjectSupport org.springframework.web.servlet.support.WebContentGenerator org.springframework.web.servlet.mvc.AbstractController org.springframework.web.servlet.mvc.multiaction.MultiActionController
public class MultiActionController
Controller implementation that allows multiple request types to be handled by the same class. Subclasses of this class can handle several different types of request with methods of the form
(ModelAndView | Map | void) actionName(HttpServletRequest request, HttpServletResponse response);May take a third parameter HttpSession in which an existing session will be required, or a third parameter of an arbitrary class that gets treated as command (i.e. an instance of the class gets created, and request parameters get bound to it)
These methods can throw any kind of exception, but should only let propagate those that they consider fatal, or which their class or superclass is prepared to catch by implementing an exception handler.
When returning just a Map
instance view name translation will be used to generate
the view name. The configured RequestToViewNameTranslator
will be used to determine the view name.
When returning void
a return value of null
is assumed
meaning that the handler method is responsible for writing the response directly to
the supplied HttpServletResponse
.
This model allows for rapid coding, but loses the advantage of compile-time checking. It is similar to a Struts 1.1 DispatchAction, but more sophisticated. Also supports delegation to another object.
An implementation of the MethodNameResolver interface defined in this package should return a method name for a given request, based on any aspect of the request, such as its URL or an "action" parameter. The actual strategy can be configured via the "methodNameResolver" bean property, for each MultiActionController.
The default MethodNameResolver is InternalPathMethodNameResolver; further included strategies are PropertiesMethodNameResolver and ParameterMethodNameResolver.
Subclasses can implement custom exception handler methods with names such as:
ModelAndView anyMeaningfulName(HttpServletRequest request, HttpServletResponse response, ExceptionClass exception);The third parameter can be any subclass or Exception or RuntimeException.
There can also be an optional lastModified method for handlers, of signature:
long anyMeaningfulNameLastModified(HttpServletRequest request)If such a method is present, it will be invoked. Default return from getLastModified is -1, meaning that the content must always be regenerated.
Note that method overloading isn't allowed.
See also the description of the workflow performed by
the superclass
(in that section of the class
level Javadoc entitled 'workflow').
Note: For maximum data binding flexibility, consider direct usage of a ServletRequestDataBinder in your controller method, instead of relying on a declared command argument. This allows for full control over the entire binder setup and usage, including the invocation of Validators and the subsequent evaluation of binding/validation errors.
MethodNameResolver
,
InternalPathMethodNameResolver
,
PropertiesMethodNameResolver
,
ParameterMethodNameResolver
,
LastModified.getLastModified(javax.servlet.http.HttpServletRequest)
,
ServletRequestDataBinder
Field Summary | |
---|---|
static String |
DEFAULT_COMMAND_NAME
Default command name used for binding command objects: "command" |
static String |
LAST_MODIFIED_METHOD_SUFFIX
Suffix for last-modified methods |
static String |
PAGE_NOT_FOUND_LOG_CATEGORY
Log category to use when no mapped handler is found for a request |
protected static Log |
pageNotFoundLogger
Additional logger to use when no mapped handler is found for a request |
Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator |
---|
METHOD_GET, METHOD_HEAD, METHOD_POST |
Fields inherited from class org.springframework.context.support.ApplicationObjectSupport |
---|
logger |
Constructor Summary | |
---|---|
MultiActionController()
Constructor for MultiActionController that looks for handler methods in the present subclass. |
|
MultiActionController(Object delegate)
Constructor for MultiActionController that looks for handler methods in delegate, rather than a subclass of this class. |
Method Summary | |
---|---|
protected void |
bind(HttpServletRequest request,
Object command)
Bind request parameters onto the given command bean |
protected ServletRequestDataBinder |
createBinder(HttpServletRequest request,
Object command)
Create a new binder instance for the given command and request. |
protected String |
getCommandName(Object command)
Return the command name to use for the given command object. |
protected Method |
getExceptionHandler(Throwable exception)
Determine the exception handler method for the given exception. |
long |
getLastModified(HttpServletRequest request)
Try to find an XXXXLastModified method, where XXXX is the name of a handler. |
MethodNameResolver |
getMethodNameResolver()
Return the MethodNameResolver used by this class. |
Validator[] |
getValidators()
Return the Validators for this controller. |
protected ModelAndView |
handleNoSuchRequestHandlingMethod(NoSuchRequestHandlingMethodException ex,
HttpServletRequest request,
HttpServletResponse response)
Handle the case where no request handler method was found. |
protected ModelAndView |
handleRequestInternal(HttpServletRequest request,
HttpServletResponse response)
Determine a handler method and invoke it. |
protected void |
initBinder(HttpServletRequest request,
ServletRequestDataBinder binder)
Initialize the given binder instance, for example with custom editors. |
protected void |
initBinder(ServletRequest request,
ServletRequestDataBinder binder)
Deprecated. since Spring 2.0: use initBinder(HttpServletRequest, ServletRequestDataBinder) instead |
protected ModelAndView |
invokeNamedMethod(String methodName,
HttpServletRequest request,
HttpServletResponse response)
Invokes the named method. |
protected Object |
newCommandObject(Class clazz)
Create a new command object of the given class. |
void |
setDelegate(Object delegate)
Set the delegate used by this class. |
void |
setMethodNameResolver(MethodNameResolver methodNameResolver)
Set the method name resolver that this class should use. |
void |
setValidators(Validator[] validators)
Set the Validators for this controller. |
Methods inherited from class org.springframework.web.servlet.mvc.AbstractController |
---|
handleRequest, isSynchronizeOnSession, setSynchronizeOnSession |
Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator |
---|
applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isRequireSession, isUseCacheControlHeader, isUseExpiresHeader, preventCaching, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseExpiresHeader |
Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport |
---|
getServletContext, getTempDir, getWebApplicationContext, isContextRequired, setServletContext |
Methods inherited from class org.springframework.context.support.ApplicationObjectSupport |
---|
getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String LAST_MODIFIED_METHOD_SUFFIX
public static final String DEFAULT_COMMAND_NAME
public static final String PAGE_NOT_FOUND_LOG_CATEGORY
protected static final Log pageNotFoundLogger
Constructor Detail |
---|
public MultiActionController()
public MultiActionController(Object delegate)
delegate
- handler object. This doesn't need to implement any particular
interface, as everything is done using reflection.Method Detail |
---|
public final void setMethodNameResolver(MethodNameResolver methodNameResolver)
public final MethodNameResolver getMethodNameResolver()
public final void setValidators(Validator[] validators)
public final Validator[] getValidators()
public final void setDelegate(Object delegate)
this
,
assuming that handler methods have been added by a subclass.
This method does not get invoked once the class is configured.
delegate
- an object containing handler methodspublic long getLastModified(HttpServletRequest request)
getLastModified
in interface LastModified
request
- current HTTP request
LastModified.getLastModified(HttpServletRequest)
protected ModelAndView handleRequestInternal(HttpServletRequest request, HttpServletResponse response) throws Exception
handleRequestInternal
in class AbstractController
Exception
MethodNameResolver.getHandlerMethodName(javax.servlet.http.HttpServletRequest)
,
invokeNamedMethod(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
,
handleNoSuchRequestHandlingMethod(org.springframework.web.servlet.mvc.multiaction.NoSuchRequestHandlingMethodException, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
protected ModelAndView handleNoSuchRequestHandlingMethod(NoSuchRequestHandlingMethodException ex, HttpServletRequest request, HttpServletResponse response) throws Exception
The default implementation logs a warning and sends an HTTP 404 error. Alternatively, a fallback view could be chosen, or the NoSuchRequestHandlingMethodException could be rethrown as-is.
ex
- the NoSuchRequestHandlingMethodException to be handledrequest
- current HTTP requestresponse
- current HTTP response
null
if handled directly
Exception
- an Exception that should be thrown as result of the servlet requestprotected final ModelAndView invokeNamedMethod(String methodName, HttpServletRequest request, HttpServletResponse response) throws Exception
Uses a custom exception handler if possible; otherwise, throw an unchecked exception; wrap a checked exception or Throwable.
Exception
protected Object newCommandObject(Class clazz) throws Exception
This implementation uses BeanUtils.instantiateClass
,
so commands need to have public no-arg constructors.
Subclasses can override this implementation if desired.
Exception
- if the command object could not be instantiatedBeanUtils.instantiateClass(Class)
protected void bind(HttpServletRequest request, Object command) throws Exception
request
- request from which parameters will be boundcommand
- command object, that must be a JavaBean
Exception
- in case of invalid state or argumentsprotected ServletRequestDataBinder createBinder(HttpServletRequest request, Object command) throws Exception
Called by bind
. Can be overridden to plug in custom
ServletRequestDataBinder subclasses.
Default implementation creates a standard ServletRequestDataBinder,
and invokes initBinder
. Note that initBinder
will not be invoked if you override this method!
request
- current HTTP requestcommand
- the command to bind onto
Exception
- in case of invalid state or argumentsbind(javax.servlet.http.HttpServletRequest, java.lang.Object)
,
initBinder(javax.servlet.http.HttpServletRequest, org.springframework.web.bind.ServletRequestDataBinder)
protected String getCommandName(Object command)
command
- the command object
DEFAULT_COMMAND_NAME
protected void initBinder(HttpServletRequest request, ServletRequestDataBinder binder) throws Exception
createBinder
.
This method allows you to register custom editors for certain fields of your command class. For instance, you will be able to transform Date objects into a String pattern and back, in order to allow your JavaBeans to have Date properties and still be able to set and display them in an HTML interface.
Default implementation is empty.
Note: the command object is not directly passed to this method, but it's available
via DataBinder.getTarget()
request
- current HTTP requestbinder
- new binder instance
Exception
- in case of invalid state or argumentscreateBinder(javax.servlet.http.HttpServletRequest, java.lang.Object)
,
DataBinder.registerCustomEditor(java.lang.Class, java.beans.PropertyEditor)
,
CustomDateEditor
protected void initBinder(ServletRequest request, ServletRequestDataBinder binder) throws Exception
initBinder(HttpServletRequest, ServletRequestDataBinder) instead
Exception
protected Method getExceptionHandler(Throwable exception)
exception
- the exception to handle
null
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |