| Concrete FormController implementation that provides configurable
form and success views, and an onSubmit chain for convenient overriding.
Automatically resubmits to the form view in case of validation errors,
and renders the success view in case of a valid submission.
The workflow of this Controller does not differ much from the one described
in the
AbstractFormController AbstractFormController . The difference
is that you do not need to implement
SimpleFormController.showForm showForm and
SimpleFormController.processFormSubmission processFormSubmission : A form view and a
success view can be configured declaratively.
Workflow
(in addition to the superclass):
- Call to
SimpleFormController.processFormSubmission processFormSubmission which inspects
the
org.springframework.validation.Errors Errors object to see if
any errors have occurred during binding and validation.
- If errors occured, the controller will return the configured formView,
showing the form again (possibly rendering according error messages).
- If
SimpleFormController.isFormChangeRequest isFormChangeRequest is overridden and returns
true for the given request, the controller will return the formView too.
In that case, the controller will also suppress validation. Before returning the formView,
the controller will invoke
SimpleFormController.onFormChange , giving sub-classes a chance
to make modification to the command object.
This is intended for requests that change the structure of the form,
which should not cause validation and show the form in any case.
- If no errors occurred, the controller will call
SimpleFormController.onSubmit(HttpServletRequest,HttpServletResponse,Object,BindException) onSubmit using all parameters, which in case of the default implementation delegates to
SimpleFormController.onSubmit(Object,BindException) onSubmit with just the command object.
The default implementation of the latter method will return the configured
successView. Consider implementing
SimpleFormController.doSubmitAction doSubmitAction
for simply performing a submit action and rendering the success view.
The submit behavior can be customized by overriding one of the
SimpleFormController.onSubmit onSubmit methods. Submit actions can also perform
custom validation if necessary (typically database-driven checks), calling
SimpleFormController.showForm(HttpServletRequest,HttpServletResponse,BindException) showForm in case of validation errors to show the form view again.
Exposed configuration properties
(and those defined by superclass):
| name |
default |
description |
| formView |
null |
Indicates what view to use when the user asks for a new form
or when validation errors have occurred on form submission. |
| successView |
null |
Indicates what view to use when successful form submissions have
occurred. Such a success view could e.g. display a submission summary.
More sophisticated actions can be implemented by overriding one of
the
SimpleFormController.onSubmit(Object) onSubmit() methods. |
author:
Juergen Hoeller
author:
Rob Harrop
since:
05.05.2003
| Constructor Summary | |
| public | SimpleFormController()
Create a new SimpleFormController.
Subclasses should set the following properties, either in the constructor
or via a BeanFactory: commandName, commandClass, sessionForm, formView,
successView. |
| Method Summary | |
| protected void | doSubmitAction(Object command)
Template method for submit actions. | | final public String | getFormView()
Return the name of the view that should be used for form display. | | final public String | getSuccessView()
Return the name of the view that should be shown on successful submit. | | protected boolean | isFormChangeRequest(HttpServletRequest request, Object command)
Determine whether the given request is a form change request. | | protected boolean | isFormChangeRequest(HttpServletRequest request)
Simpler isFormChangeRequest variant, called by the full
variant
SimpleFormController.isFormChangeRequest(HttpServletRequest,Object) . | | protected void | onFormChange(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors)
Called during form submission if
SimpleFormController.isFormChangeRequest(javax.servlet.http.HttpServletRequest) returns true. | | protected void | onFormChange(HttpServletRequest request, HttpServletResponse response, Object command)
Simpler onFormChange variant, called by the full variant
SimpleFormController.onFormChange(HttpServletRequest,HttpServletResponse,Object,BindException) . | | protected ModelAndView | onSubmit(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors)
Submit callback with all parameters. | | protected ModelAndView | onSubmit(Object command, BindException errors)
Simpler onSubmit variant.
Called by the default implementation of the
SimpleFormController.onSubmit(HttpServletRequest,HttpServletResponse,Object,BindException) variant with all parameters.
The default implementation calls
SimpleFormController.onSubmit(Object) , using the
returned ModelAndView if actually implemented in a subclass. | | protected ModelAndView | onSubmit(Object command)
Simplest onSubmit variant. | | protected ModelAndView | processFormSubmission(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors)
This implementation calls
SimpleFormController.showForm(HttpServletRequest,HttpServletResponse,BindException) in case of errors, and delegates to the full
SimpleFormController.onSubmit(HttpServletRequest,HttpServletResponse,Object,BindException) 's
variant else.
This can only be overridden to check for an action that should be executed
without respect to binding errors, like a cancel action. | | protected Map | referenceData(HttpServletRequest request, Object command, Errors errors)
Create a reference data map for the given request and command,
consisting of bean name/bean instance pairs as expected by ModelAndView. | | protected Map | referenceData(HttpServletRequest request)
Create a reference data map for the given request. | | final public void | setFormView(String formView)
Set the name of the view that should be used for form display. | | final public void | setSuccessView(String successView)
Set the name of the view that should be shown on successful submit. | | protected ModelAndView | showForm(HttpServletRequest request, HttpServletResponse response, BindException errors)
This implementation shows the configured form view, delegating to the analogous
SimpleFormController.showForm(HttpServletRequest,HttpServletResponse,BindException,Map) variant with a "controlModel" argument. | | protected ModelAndView | showForm(HttpServletRequest request, HttpServletResponse response, BindException errors, Map controlModel)
This implementation shows the configured form view.
Can be called within
SimpleFormController.onSubmit(HttpServletRequest,HttpServletResponse,Object,BindException) implementations, to redirect back to the form in case of custom validation errors
(errors not determined by the validator).
Can be overridden in subclasses to show a custom view, writing directly
to the response or preparing the response before rendering a view.
Parameters:
request - current HTTP request
Parameters:
errors - validation errors holder
Parameters:
controlModel - model map containing controller-specific control data(e.g. | | protected boolean | suppressValidation(HttpServletRequest request, Object command)
This implementation delegates to
SimpleFormController.isFormChangeRequest(HttpServletRequest,Object) :
A form change request changes the appearance of the form and should not get
validated but just show the new form. |
| getFormView | | final public String getFormView()(Code) | | Return the name of the view that should be used for form display.
|
| getSuccessView | | final public String getSuccessView()(Code) | | Return the name of the view that should be shown on successful submit.
|
| onSubmit | | protected ModelAndView onSubmit(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors) throws Exception(Code) | | Submit callback with all parameters. Called in case of submit without errors
reported by the registered validator, or on every submit if no validator.
The default implementation delegates to
SimpleFormController.onSubmit(Object,BindException) .
For simply performing a submit action and rendering the specified success
view, consider implementing
SimpleFormController.doSubmitAction rather than an
onSubmit variant.
Subclasses can override this to provide custom submission handling like storing
the object to the database. Implementations can also perform custom validation and
call showForm to return to the form. Do not implement multiple onSubmit
methods: In that case, just this method will be called by the controller.
Call errors.getModel() to populate the ModelAndView model
with the command and the Errors instance, under the specified command name,
as expected by the "spring:bind" tag.
Parameters:
request - current servlet request
Parameters:
response - current servlet response
Parameters:
command - form object with request parameters bound onto it
Parameters:
errors - Errors instance without errors (subclass can add errors if it wants to) the prepared model and view, or null
throws:
Exception - in case of errors
See Also: SimpleFormController.onSubmit(Object,BindException)
See Also: SimpleFormController.doSubmitAction
See Also: SimpleFormController.showForm
See Also: org.springframework.validation.Errors
See Also: org.springframework.validation.BindException.getModel |
| onSubmit | | protected ModelAndView onSubmit(Object command, BindException errors) throws Exception(Code) | | Simpler onSubmit variant.
Called by the default implementation of the
SimpleFormController.onSubmit(HttpServletRequest,HttpServletResponse,Object,BindException) variant with all parameters.
The default implementation calls
SimpleFormController.onSubmit(Object) , using the
returned ModelAndView if actually implemented in a subclass. Else, the
default behavior will apply: rendering the success view with the command
and Errors instance as model.
Subclasses can override this to provide custom submission handling that
does not need request and response.
Call errors.getModel() to populate the ModelAndView model
with the command and the Errors instance, under the specified command name,
as expected by the "spring:bind" tag.
Parameters:
command - form object with request parameters bound onto it
Parameters:
errors - Errors instance without errors the prepared model and view
throws:
Exception - in case of errors
See Also: SimpleFormController.onSubmit(HttpServletRequest,HttpServletResponse,Object,BindException)
See Also: SimpleFormController.onSubmit(Object)
See Also: SimpleFormController.setSuccessView
See Also: org.springframework.validation.Errors
See Also: org.springframework.validation.BindException.getModel |
| processFormSubmission | | protected ModelAndView processFormSubmission(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors) throws Exception(Code) | | This implementation calls
SimpleFormController.showForm(HttpServletRequest,HttpServletResponse,BindException) in case of errors, and delegates to the full
SimpleFormController.onSubmit(HttpServletRequest,HttpServletResponse,Object,BindException) 's
variant else.
This can only be overridden to check for an action that should be executed
without respect to binding errors, like a cancel action. To just handle successful
submissions without binding errors, override one of the onSubmit
methods or
SimpleFormController.doSubmitAction .
See Also: SimpleFormController.showForm(HttpServletRequest,HttpServletResponse,BindException)
See Also: SimpleFormController.onSubmit(HttpServletRequest,HttpServletResponse,Object,BindException)
See Also: SimpleFormController.onSubmit(Object,BindException)
See Also: SimpleFormController.onSubmit(Object)
See Also: SimpleFormController.doSubmitAction(Object) |
| referenceData | | protected Map referenceData(HttpServletRequest request, Object command, Errors errors) throws Exception(Code) | | Create a reference data map for the given request and command,
consisting of bean name/bean instance pairs as expected by ModelAndView.
The default implementation delegates to
SimpleFormController.referenceData(HttpServletRequest) .
Subclasses can override this to set reference data used in the view.
Parameters:
request - current HTTP request
Parameters:
command - form object with request parameters bound onto it
Parameters:
errors - validation errors holder a Map with reference data entries, or null if none
throws:
Exception - in case of invalid state or arguments
See Also: ModelAndView |
| setFormView | | final public void setFormView(String formView)(Code) | | Set the name of the view that should be used for form display.
|
| setSuccessView | | final public void setSuccessView(String successView)(Code) | | Set the name of the view that should be shown on successful submit.
|
| showForm | | protected ModelAndView showForm(HttpServletRequest request, HttpServletResponse response, BindException errors) throws Exception(Code) | | This implementation shows the configured form view, delegating to the analogous
SimpleFormController.showForm(HttpServletRequest,HttpServletResponse,BindException,Map) variant with a "controlModel" argument.
Can be called within
SimpleFormController.onSubmit(HttpServletRequest,HttpServletResponse,Object,BindException) implementations, to redirect back to the form in case of custom validation errors
(errors not determined by the validator).
Can be overridden in subclasses to show a custom view, writing directly
to the response or preparing the response before rendering a view.
If calling showForm with a custom control model in subclasses, it's preferable
to override the analogous showForm version with a controlModel argument
(which will handle both standard form showing and custom form showing then).
See Also: SimpleFormController.setFormView
See Also: SimpleFormController.showForm(HttpServletRequest,HttpServletResponse,BindException,Map) |
| Methods inherited from org.springframework.web.servlet.mvc.AbstractFormController | protected Object currentFormObject(HttpServletRequest request, Object sessionFormObject) throws Exception(Code)(Java Doc)
protected Object formBackingObject(HttpServletRequest request) throws Exception(Code)(Java Doc)
final protected Object getCommand(HttpServletRequest request) throws Exception(Code)(Java Doc)
final protected BindException getErrorsForNewForm(HttpServletRequest request) throws Exception(Code)(Java Doc)
protected String getFormSessionAttributeName(HttpServletRequest request)(Code)(Java Doc)
protected String getFormSessionAttributeName()(Code)(Java Doc)
protected ModelAndView handleInvalidSubmit(HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
protected ModelAndView handleRequestInternal(HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
final public boolean isBindOnNewForm()(Code)(Java Doc)
protected boolean isFormSubmission(HttpServletRequest request)(Code)(Java Doc)
final public boolean isSessionForm()(Code)(Java Doc)
protected void onBindOnNewForm(HttpServletRequest request, Object command, BindException errors) throws Exception(Code)(Java Doc)
protected void onBindOnNewForm(HttpServletRequest request, Object command) throws Exception(Code)(Java Doc)
abstract protected ModelAndView processFormSubmission(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors) throws Exception(Code)(Java Doc)
protected Map referenceData(HttpServletRequest request, Object command, Errors errors) throws Exception(Code)(Java Doc)
final public void setBindOnNewForm(boolean bindOnNewForm)(Code)(Java Doc)
final public void setSessionForm(boolean sessionForm)(Code)(Java Doc)
abstract protected ModelAndView showForm(HttpServletRequest request, HttpServletResponse response, BindException errors) throws Exception(Code)(Java Doc)
final protected ModelAndView showForm(HttpServletRequest request, BindException errors, String viewName) throws Exception(Code)(Java Doc)
final protected ModelAndView showForm(HttpServletRequest request, BindException errors, String viewName, Map controlModel) throws Exception(Code)(Java Doc)
final protected ModelAndView showNewForm(HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
|
| Fields inherited from org.springframework.web.servlet.mvc.BaseCommandController | final public static String DEFAULT_COMMAND_NAME(Code)(Java Doc)
|
| Methods inherited from org.springframework.web.servlet.mvc.BaseCommandController | final protected ServletRequestDataBinder bindAndValidate(HttpServletRequest request, Object command) throws Exception(Code)(Java Doc)
final protected boolean checkCommand(Object command)(Code)(Java Doc)
protected ServletRequestDataBinder createBinder(HttpServletRequest request, Object command) throws Exception(Code)(Java Doc)
final protected Object createCommand() throws Exception(Code)(Java Doc)
final public BindingErrorProcessor getBindingErrorProcessor()(Code)(Java Doc)
protected Object getCommand(HttpServletRequest request) throws Exception(Code)(Java Doc)
final public Class getCommandClass()(Code)(Java Doc)
final public String getCommandName()(Code)(Java Doc)
final public MessageCodesResolver getMessageCodesResolver()(Code)(Java Doc)
final public PropertyEditorRegistrar[] getPropertyEditorRegistrars()(Code)(Java Doc)
final public Validator getValidator()(Code)(Java Doc)
final public Validator[] getValidators()(Code)(Java Doc)
protected void initApplicationContext()(Code)(Java Doc)
protected void initBinder(HttpServletRequest request, ServletRequestDataBinder binder) throws Exception(Code)(Java Doc)
final public boolean isValidateOnBinding()(Code)(Java Doc)
protected void onBind(HttpServletRequest request, Object command, BindException errors) throws Exception(Code)(Java Doc)
protected void onBind(HttpServletRequest request, Object command) throws Exception(Code)(Java Doc)
protected void onBindAndValidate(HttpServletRequest request, Object command, BindException errors) throws Exception(Code)(Java Doc)
final protected void prepareBinder(ServletRequestDataBinder binder)(Code)(Java Doc)
final public void setBindingErrorProcessor(BindingErrorProcessor bindingErrorProcessor)(Code)(Java Doc)
final public void setCommandClass(Class commandClass)(Code)(Java Doc)
final public void setCommandName(String commandName)(Code)(Java Doc)
final public void setMessageCodesResolver(MessageCodesResolver messageCodesResolver)(Code)(Java Doc)
final public void setPropertyEditorRegistrar(PropertyEditorRegistrar propertyEditorRegistrar)(Code)(Java Doc)
final public void setPropertyEditorRegistrars(PropertyEditorRegistrar[] propertyEditorRegistrars)(Code)(Java Doc)
final public void setValidateOnBinding(boolean validateOnBinding)(Code)(Java Doc)
final public void setValidator(Validator validator)(Code)(Java Doc)
final public void setValidators(Validator[] validators)(Code)(Java Doc)
protected boolean suppressBinding(HttpServletRequest request)(Code)(Java Doc)
protected boolean suppressValidation(HttpServletRequest request, Object command, BindException errors)(Code)(Java Doc)
protected boolean suppressValidation(HttpServletRequest request, Object command)(Code)(Java Doc)
protected boolean suppressValidation(HttpServletRequest request)(Code)(Java Doc)
protected boolean useDirectFieldAccess()(Code)(Java Doc)
|
|
