@Deprecated public class MultiActionController extends AbstractController implements LastModified
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
public (ModelAndView | Map | String | void) actionName(HttpServletRequest request, HttpServletResponse response, [,HttpSession] [,AnyObject]);A Map return value indicates a model that is supposed to be passed to a default view (determined through a
RequestToViewNameTranslator).
A String return value indicates the name of a view to be rendered without a specific model.
May take a third parameter (of type HttpSession) in which an
existing session will be required, or a third parameter of an arbitrary
class that gets treated as the command (that is, 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 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:
public 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 xxxLastModified method for
handlers, of signature:
public 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 all handler methods need to be public and that method overloading is not 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| Modifier and Type | Field and Description |
|---|---|
static String |
DEFAULT_COMMAND_NAME
Deprecated.
Default command name used for binding command objects: "command"
|
static String |
LAST_MODIFIED_METHOD_SUFFIX
Deprecated.
Suffix for last-modified methods
|
static String |
PAGE_NOT_FOUND_LOG_CATEGORY
Deprecated.
Log category to use when no mapped handler is found for a request.
|
protected static Log |
pageNotFoundLogger
Deprecated.
Additional logger to use when no mapped handler is found for a request.
|
HEADER_CACHE_CONTROL, METHOD_GET, METHOD_HEAD, METHOD_POSTlogger| Constructor and Description |
|---|
MultiActionController()
Deprecated.
Constructor for
MultiActionController that looks for
handler methods in the present subclass. |
MultiActionController(Object delegate)
Deprecated.
Constructor for
MultiActionController that looks for
handler methods in delegate, rather than a subclass of this class. |
| Modifier and Type | Method and Description |
|---|---|
protected void |
bind(HttpServletRequest request,
Object command)
Deprecated.
Bind request parameters onto the given command bean
|
protected ServletRequestDataBinder |
createBinder(HttpServletRequest request,
Object command)
Deprecated.
Create a new binder instance for the given command and request.
|
protected String |
getCommandName(Object command)
Deprecated.
Return the command name to use for the given command object.
|
protected Method |
getExceptionHandler(Throwable exception)
Deprecated.
Determine the exception handler method for the given exception.
|
long |
getLastModified(HttpServletRequest request)
Deprecated.
Try to find an XXXXLastModified method, where XXXX is the name of a handler.
|
MethodNameResolver |
getMethodNameResolver()
Deprecated.
Return the MethodNameResolver used by this class.
|
Validator[] |
getValidators()
Deprecated.
Return the Validators for this controller.
|
WebBindingInitializer |
getWebBindingInitializer()
Deprecated.
Return the WebBindingInitializer (if any) which will apply pre-configured
configuration to every DataBinder that this controller uses.
|
protected ModelAndView |
handleNoSuchRequestHandlingMethod(NoSuchRequestHandlingMethodException ex,
HttpServletRequest request,
HttpServletResponse response)
Deprecated.
Handle the case where no request handler method was found.
|
protected ModelAndView |
handleRequestInternal(HttpServletRequest request,
HttpServletResponse response)
Deprecated.
Determine a handler method and invoke it.
|
protected void |
initBinder(HttpServletRequest request,
ServletRequestDataBinder binder)
Deprecated.
Initialize the given binder instance, for example with custom editors.
|
protected ModelAndView |
invokeNamedMethod(String methodName,
HttpServletRequest request,
HttpServletResponse response)
Deprecated.
Invokes the named method.
|
protected Object |
newCommandObject(Class<?> clazz)
Deprecated.
Create a new command object of the given class.
|
void |
setDelegate(Object delegate)
Deprecated.
Set the delegate used by this class; the default is
this,
assuming that handler methods have been added by a subclass. |
void |
setMethodNameResolver(MethodNameResolver methodNameResolver)
Deprecated.
Set the method name resolver that this class should use.
|
void |
setValidators(Validator[] validators)
Deprecated.
Set the
Validators for this controller. |
void |
setWebBindingInitializer(WebBindingInitializer webBindingInitializer)
Deprecated.
Specify a WebBindingInitializer which will apply pre-configured
configuration to every DataBinder that this controller uses.
|
handleRequest, isSynchronizeOnSession, setSynchronizeOnSessionapplyCacheControl, applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, checkRequest, getAllowHeader, getCacheControl, getCacheSeconds, getSupportedMethods, getVaryByRequestHeaders, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, prepareResponse, preventCaching, setAlwaysMustRevalidate, setCacheControl, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader, setVaryByRequestHeadersgetServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContextgetApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContextpublic static final String LAST_MODIFIED_METHOD_SUFFIX
public static final String DEFAULT_COMMAND_NAME
public static final String PAGE_NOT_FOUND_LOG_CATEGORY
pageNotFoundLogger,
Constant Field Valuesprotected static final Log pageNotFoundLogger
PAGE_NOT_FOUND_LOG_CATEGORYpublic MultiActionController()
MultiActionController that looks for
handler methods in the present subclass.public MultiActionController(Object delegate)
MultiActionController that looks for
handler methods in delegate, rather than a subclass of this class.delegate - handler object. This does not need to implement any
particular interface, as everything is done using reflection.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 methodsIllegalStateException - if no handler methods are foundpublic final void setMethodNameResolver(MethodNameResolver methodNameResolver)
Allows parameterization of handler method mappings.
public final MethodNameResolver getMethodNameResolver()
public final void setValidators(Validator[] validators)
Validators for this controller.
The Validators must support the specified command class.
public final Validator[] getValidators()
public final void setWebBindingInitializer(WebBindingInitializer webBindingInitializer)
Allows for factoring out the entire binder configuration
to separate objects, as an alternative to initBinder(javax.servlet.http.HttpServletRequest, org.springframework.web.bind.ServletRequestDataBinder).
public final WebBindingInitializer getWebBindingInitializer()
public long getLastModified(HttpServletRequest request)
getLastModified in interface LastModifiedrequest - current HTTP requestLastModified.getLastModified(HttpServletRequest)protected ModelAndView handleRequestInternal(HttpServletRequest request, HttpServletResponse response) throws Exception
handleRequestInternal in class AbstractControllerExceptionMethodNameResolver.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 responsenull if handled directlyException - 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.
Exceptionprotected 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 JavaBeanException - 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.
The 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 ontoException - 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)
Default is "command".
command - the command objectDEFAULT_COMMAND_NAMEprotected 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.
The 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 instanceException - in case of invalid state or argumentscreateBinder(javax.servlet.http.HttpServletRequest, java.lang.Object),
DataBinder.registerCustomEditor(java.lang.Class<?>, java.beans.PropertyEditor),
CustomDateEditor