@Deprecated public abstract class AbstractFormController extends BaseCommandController
Form controller that auto-populates a form bean from the request.
This, either using a new bean instance per request, or using the same bean
when the sessionForm
property has been set to
true
.
This class is the base class for both framework subclasses such as
SimpleFormController
and AbstractWizardFormController
and custom form controllers that you may provide yourself.
A form-input view and an after-submission view have to be provided
programmatically. To provide those views using configuration properties,
use the SimpleFormController
.
Subclasses need to override showForm
to prepare the form view,
processFormSubmission
to handle submit requests, and
renderFormSubmission
to display the results of the submit.
For the latter two methods, binding errors like type mismatches will be
reported via the given "errors" holder. For additional custom form validation,
a validator (property inherited from BaseCommandController) can be used,
reporting via the same "errors" instance.
Comparing this Controller to the Struts notion of the Action
shows us that with Spring, you can use any ordinary JavaBeans or database-
backed JavaBeans without having to implement a framework-specific class
(like Struts' ActionForm
). More complex properties of JavaBeans
(Dates, Locales, but also your own application-specific or compound types)
can be represented and submitted to the controller, by using the notion of
a java.beans.PropertyEditors
. For more information on that
subject, see the workflow of this controller and the explanation of the
BaseCommandController
.
This controller is different from it's servlet counterpart in that it must take into account the two phases of a portlet request: the action phase and the render phase. See the JSR-168 spec for more details on these two phases. Be especially aware that the action phase is called only once, but that the render phase will be called repeatedly by the portal; it does this every time the page containing the portlet is updated, even if the activity is in some other portlet. (This is not quite true, the portal can also be told to cache the results of the render for a period of time, but assume it is true for programming purposes.)
Workflow
(and that defined by superclass):
formBackingObject()
which by
default, returns an instance of the commandClass that has been
configured (see the properties the superclass exposes), but can also be
overridden to e.g. retrieve an object from the database (that needs to
be modified using the form).initBinder()
which allows you to
register custom editors for certain fields (often properties of non-
primitive or non-String types) of the command class. This will render
appropriate Strings for those property values, e.g. locale-specific
date strings. PortletRequestDataBinder
gets applied to populate the new form object with initial request parameters and the
onBindOnNewForm(RenderRequest, Object, BindException)
callback method is invoked.
(only if bindOnNewForm
is set to true
)
Make sure that the initial parameters do not include the parameter that indicates a
form submission has occurred.showForm
to return a View that should be rendered
(typically the view that renders the form). This method has to be
implemented in subclasses. referenceData
,
which you can implement to provide any relevant reference data you might need
when editing a form (e.g. a List of Locale objects you're going to let the
user select one from).isFormSubmission
method.
The action phase will proceed to process the form submission as follows.sessionForm
is not set, formBackingObject
is called to retrieve a form object. Otherwise,
the controller tries to find the command object which is already bound
in the session. If it cannot find the object, the action phase does a
call to handleInvalidSubmit
which - by default -
tries to create a new form object and resubmit the form. It then sets
a render parameter that will indicate to the render phase that this was
an invalid submit.PortletRequestDataBinder
gets applied to populate
the form object with current request parameters.onBind(PortletRequest, Object, Errors)
which allows you to do custom processing after binding but before
validation (e.g. to manually bind request parameters to bean
properties, to be seen by the Validator).validateOnBinding
is set, a registered Validator
will be invoked. The Validator will check the form object properties,
and register corresponding errors via the given Errors
object.onBindAndValidate
which allows
you to do custom processing after binding and validation (e.g. to
manually bind request parameters, and to validate them outside a
Validator).processFormSubmission
to process the submission, with or without binding errors.
This method has to be implemented in subclasses and will be called
only once per form submission.renderInvalidSubmit
which –
also by default – will render the results of the resubmitted
form. Be sure to override both handleInvalidSubmit
and
renderInvalidSubmit
if you want to change this overall
behavior.renderFormSubmission
to
render the results of the submission, with or without binding errors.
This method has to be implemented in subclasses and will be called
repeatedly by the portal.In session form mode, a submission without an existing form object in the
session is considered invalid, like in the case of a resubmit/reload by the browser.
The handleInvalidSubmit
/
renderInvalidSubmit
methods are invoked then,
by default trying to resubmit. This can be overridden in subclasses to show
corresponding messages or to redirect to a new form, in order to avoid duplicate
submissions. The form object in the session can be considered a transaction token
in that case.
Make sure that any URLs that take you to your form controller are Render URLs,
so that it will not try to treat the initial call as a form submission.
If you use action URLs to link to your controller, you will need to override the
isFormSubmission
method to use a different mechanism for
determining whether a form has been submitted. Make sure this method will work for
both the ActionRequest and the RenderRequest objects.
Note that views should never retrieve form beans from the session but always from the request, as prepared by the form controller. Remember that some view technologies like Velocity cannot even access a HTTP session.
Exposed configuration properties
(and those defined by superclass):
name | default | description |
bindOnNewForm | false | Indicates whether to bind portlet request parameters when creating a new form. Otherwise, the parameters will only be bound on form submission attempts. |
sessionForm | false | Indicates whether the form object should be kept in the session when a user asks for a new form. This allows you e.g. to retrieve an object from the database, let the user edit it, and then persist it again. Otherwise, a new command object will be created for each request (even when showing the form again after validation errors). |
redirectAction | false | Specifies whether processFormSubmission is expected to call
ActionResponse.sendRedirect .
This is important because some methods may not be called before
ActionResponse.sendRedirect (e.g.
ActionResponse.setRenderParameter ).
Setting this flag will prevent AbstractFormController from setting render
parameters that it normally needs for the render phase.
If this is set true and sendRedirect is not called, then
processFormSubmission must call
setFormSubmit .
Otherwise, the render phase will not realize the form was submitted
and will simply display a new blank form. |
renderParameters | null | An array of parameters that will be passed forward from the action
phase to the render phase if the form needs to be displayed
again. These can also be passed forward explicitly by calling
the passRenderParameters method from any action
phase method. Abstract descendants of this controller should follow
similar behavior. If there are parameters you need in
renderFormSubmission , then you need to pass those
forward from processFormSubmission . If you override the
default behavior of invalid submits and you set sessionForm to true,
then you probably will not need to set this because your parameters
are only going to be needed on the first request. |
Thanks to Rainer Schmitz and Nick Lothian for their suggestions!
showForm(RenderRequest, RenderResponse, BindException)
,
SimpleFormController
,
AbstractWizardFormController
Modifier and Type | Field and Description |
---|---|
private boolean |
bindOnNewForm
Deprecated.
|
private static java.lang.String |
FORM_SUBMISSION_PARAMETER
Deprecated.
These render parameters are used to indicate forward to the render phase
if the form was submitted and if the submission was invalid.
|
private static java.lang.String |
INVALID_SUBMISSION_PARAMETER
Deprecated.
|
private boolean |
redirectAction
Deprecated.
|
private java.lang.String[] |
renderParameters
Deprecated.
|
private boolean |
sessionForm
Deprecated.
|
private static java.lang.String |
TRUE
Deprecated.
|
DEFAULT_COMMAND_NAME
logger
Constructor and Description |
---|
AbstractFormController()
Deprecated.
Create a new AbstractFormController.
|
Modifier and Type | Method and Description |
---|---|
protected java.lang.Object |
formBackingObject(PortletRequest request)
Deprecated.
Retrieve a backing object for the current form from the given request.
|
protected java.lang.Object |
getCommand(PortletRequest request)
Deprecated.
Return the form object for the given request.
|
protected BindException |
getErrorsForNewForm(RenderRequest request)
Deprecated.
Create a BindException instance for a new form.
|
protected java.lang.String |
getFormSessionAttributeName()
Deprecated.
Return the name of the PortletSession attribute that holds the form object
for this form controller.
|
protected java.lang.String |
getFormSessionAttributeName(PortletRequest request)
Deprecated.
Return the name of the PortletSession attribute that holds the form object
for this form controller.
|
protected java.lang.String |
getFormSubmitParameterName()
Deprecated.
Return the name of the render parameter that indicates this
was a form submission.
|
protected java.lang.String |
getInvalidSubmitParameterName()
Deprecated.
Return the name of the render parameter that indicates this
was an invalid form submission.
|
java.lang.String[] |
getRenderParameters()
Deprecated.
Returns the list of parameters that will be passed forward
from the action phase to the render phase whenever the form is
rerendered or when
passRenderParameters(ActionRequest, ActionResponse) is called. |
protected void |
handleActionRequestInternal(ActionRequest request,
ActionResponse response)
Deprecated.
Handles action phase of two cases: form submissions and showing a new form.
|
protected void |
handleInvalidSubmit(ActionRequest request,
ActionResponse response)
Deprecated.
Handle an invalid submit request, e.g.
|
protected ModelAndView |
handleRenderRequestInternal(RenderRequest request,
RenderResponse response)
Deprecated.
Handles render phase of two cases: form submissions and showing a new form.
|
boolean |
isBindOnNewForm()
Deprecated.
Return if request parameters should be bound in case of a new form.
|
protected boolean |
isFormSubmission(PortletRequest request)
Deprecated.
Determine if the given request represents a form submission.
|
protected boolean |
isInvalidSubmission(PortletRequest request)
Deprecated.
Determine if the given request represents an invalid form submission.
|
boolean |
isRedirectAction()
Deprecated.
Return if
ActionResponse#sendRedirect is
expected to be called in the action phase. |
boolean |
isSessionForm()
Deprecated.
Return if session form mode is activated.
|
protected void |
onBindOnNewForm(RenderRequest request,
java.lang.Object command)
Deprecated.
Callback for custom post-processing in terms of binding for a new form.
|
protected void |
onBindOnNewForm(RenderRequest request,
java.lang.Object command,
BindException errors)
Deprecated.
Callback for custom post-processing in terms of binding for a new form.
|
protected void |
passRenderParameters(ActionRequest request,
ActionResponse response)
Deprecated.
Pass the specified list of action request parameters to the render phase
by putting them into the action response object.
|
protected abstract void |
processFormSubmission(ActionRequest request,
ActionResponse response,
java.lang.Object command,
BindException errors)
Deprecated.
Process action phase of form submission request.
|
protected java.util.Map |
referenceData(PortletRequest request,
java.lang.Object command,
Errors errors)
Deprecated.
Create a reference data map for the given request, consisting of
bean name/bean instance pairs as expected by ModelAndView.
|
protected abstract ModelAndView |
renderFormSubmission(RenderRequest request,
RenderResponse response,
java.lang.Object command,
BindException errors)
Deprecated.
Process render phase of form submission request.
|
protected ModelAndView |
renderInvalidSubmit(RenderRequest request,
RenderResponse response)
Deprecated.
Handle an invalid submit request, e.g.
|
void |
setBindOnNewForm(boolean bindOnNewForm)
Deprecated.
Set if request parameters should be bound to the form object
in case of a non-submitting request, i.e.
|
protected void |
setFormSubmit(ActionResponse response)
Deprecated.
Set the action response parameter that indicates this in a form submission.
|
protected void |
setInvalidSubmit(ActionResponse response)
Deprecated.
Set the action response parameter that indicates this in an invalid submission.
|
void |
setRedirectAction(boolean redirectAction)
Deprecated.
Specify whether the action phase is expected to call
ActionResponse#sendRedirect . |
void |
setRenderParameters(java.lang.String[] parameters)
Deprecated.
Specify the list of parameters that should be passed forward
from the action phase to the render phase whenever the form is
re-rendered or when
passRenderParameters(ActionRequest, ActionResponse) is called. |
void |
setSessionForm(boolean sessionForm)
Deprecated.
Activate/deactivate session form mode.
|
protected ModelAndView |
showForm(RenderRequest request,
BindException errors,
java.lang.String viewName)
Deprecated.
Prepare model and view for the given form, including reference and errors.
|
protected ModelAndView |
showForm(RenderRequest request,
BindException errors,
java.lang.String viewName,
java.util.Map controlModel)
Deprecated.
Prepare model and view for the given form, including reference and errors,
adding a controller-specific control model.
|
protected abstract ModelAndView |
showForm(RenderRequest request,
RenderResponse response,
BindException errors)
Deprecated.
Prepare the form model and view, including reference and error data.
|
protected ModelAndView |
showNewForm(RenderRequest request,
RenderResponse response)
Deprecated.
Show a new form.
|
bindAndValidate, checkCommand, createBinder, createCommand, getBindingErrorProcessor, getCommandClass, getCommandName, getMessageCodesResolver, getPropertyEditorRegistrars, getRenderCommand, getRenderCommandSessionAttributeName, getRenderErrors, getRenderErrorsSessionAttributeName, getValidator, getValidators, getWebBindingInitializer, initApplicationContext, initBinder, isValidateOnBinding, onBind, onBind, onBindAndValidate, prepareBinder, setBindingErrorProcessor, setCommandClass, setCommandName, setMessageCodesResolver, setPropertyEditorRegistrar, setPropertyEditorRegistrars, setRenderCommandAndErrors, setValidateOnBinding, setValidator, setValidators, setWebBindingInitializer, suppressBinding, suppressValidation, useDirectFieldAccess
handleActionRequest, handleRenderRequest, isRenderWhenMinimized, isSynchronizeOnSession, setRenderWhenMinimized, setSynchronizeOnSession
applyCacheSeconds, cacheForSeconds, check, checkAndPrepare, checkAndPrepare, getCacheSeconds, isRequireSession, preventCaching, setCacheSeconds, setRequireSession
getPortletContext, getTempDir, isContextRequired, setPortletContext
getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext
private static final java.lang.String FORM_SUBMISSION_PARAMETER
private static final java.lang.String INVALID_SUBMISSION_PARAMETER
private static final java.lang.String TRUE
private boolean bindOnNewForm
private boolean sessionForm
private boolean redirectAction
private java.lang.String[] renderParameters
public AbstractFormController()
Subclasses should set the following properties, either in the constructor
or via a BeanFactory: commandName, commandClass, bindOnNewForm, sessionForm.
Note that commandClass doesn't need to be set when overriding
formBackingObject
, as the latter determines the class anyway.
"cacheSeconds" is by default set to 0 (-> no caching for all form controllers).
public final void setBindOnNewForm(boolean bindOnNewForm)
public final boolean isBindOnNewForm()
public final void setSessionForm(boolean sessionForm)
This is necessary for either wizard-style controllers that populate a single form object from multiple pages, or forms that populate a persistent object that needs to be identical to allow for tracking changes.
public final boolean isSessionForm()
public void setRedirectAction(boolean redirectAction)
ActionResponse#sendRedirect
.
This information is important because some methods may not be called
before ActionResponse#sendRedirect
, e.g.
ActionResponse#setRenderParameter
and
ActionResponse#setRenderParameters
.
NOTE: Call this at initialization time of your controller: either in the constructor or in the bean definition for your controller.
ActionResponse#sendRedirect
public boolean isRedirectAction()
ActionResponse#sendRedirect
is
expected to be called in the action phase.public void setRenderParameters(java.lang.String[] parameters)
passRenderParameters(ActionRequest, ActionResponse)
is called.public java.lang.String[] getRenderParameters()
passRenderParameters(ActionRequest, ActionResponse)
is called.passRenderParameters(ActionRequest, ActionResponse)
protected void handleActionRequestInternal(ActionRequest request, ActionResponse response) throws java.lang.Exception
isFormSubmission
,
always treating requests without existing form session attribute
as new form when using session form mode.handleActionRequestInternal
in class AbstractController
java.lang.Exception
isFormSubmission(PortletRequest)
,
processFormSubmission(ActionRequest, ActionResponse, java.lang.Object, org.springframework.validation.BindException)
,
handleRenderRequestInternal(RenderRequest, RenderResponse)
protected ModelAndView handleRenderRequestInternal(RenderRequest request, RenderResponse response) throws java.lang.Exception
isFormSubmission
,
always treating requests without existing form session attribute
as new form when using session form mode.handleRenderRequestInternal
in class AbstractController
java.lang.Exception
isFormSubmission(PortletRequest)
,
showNewForm(RenderRequest, RenderResponse)
,
processFormSubmission(ActionRequest, ActionResponse, java.lang.Object, org.springframework.validation.BindException)
,
handleActionRequestInternal(ActionRequest, ActionResponse)
protected boolean isFormSubmission(PortletRequest request)
The default implementation checks to see if this is an ActionRequest and treats all action requests as form submission. During the action phase it will pass forward a render parameter to indicate to the render phase that this is a form submission. This method can check both kinds of requests and indicate if this is a form submission.
Subclasses can override this to use a custom strategy, e.g. a specific request parameter (assumably a hidden field or submit button name). Make sure that the override can handle both ActionRequest and RenderRequest objects properly.
request
- current requestprotected boolean isInvalidSubmission(PortletRequest request)
protected java.lang.String getFormSubmitParameterName()
javax.portlet.RenderRequest#getParameter
protected java.lang.String getInvalidSubmitParameterName()
javax.portlet.RenderRequest#getParameter
protected final void setFormSubmit(ActionResponse response)
response
- the current action responsegetFormSubmitParameterName()
protected final void setInvalidSubmit(ActionResponse response)
response
- the current action responsegetInvalidSubmitParameterName()
protected java.lang.String getFormSessionAttributeName(PortletRequest request)
The default implementation delegates to the
getFormSessionAttributeName
version without arguments.
request
- current HTTP requestnull
if not in session form modegetFormSessionAttributeName()
,
javax.portlet.PortletSession#getAttribute
protected java.lang.String getFormSessionAttributeName()
Default is an internal name, of no relevance to applications, as the form session attribute is not usually accessed directly. Can be overridden to use an application-specific attribute name, which allows other code to access the session attribute directly.
javax.portlet.PortletSession#getAttribute
protected void passRenderParameters(ActionRequest request, ActionResponse response)
sendRedirect
.request
- the current action requestresponse
- the current action responseActionResponse#setRenderParameter
protected final ModelAndView showNewForm(RenderRequest request, RenderResponse response) throws java.lang.Exception
request
- current render requestresponse
- current render responsejava.lang.Exception
- in case of an invalid new form objectgetErrorsForNewForm(RenderRequest)
protected final BindException getErrorsForNewForm(RenderRequest request) throws java.lang.Exception
showNewForm
.
Can be used directly when intending to show a new form but with
special errors registered on it (for example, on invalid submit).
Usually, the resulting BindException will be passed to
showForm
, after registering the errors on it.
request
- current render requestjava.lang.Exception
- in case of an invalid new form objectprotected void onBindOnNewForm(RenderRequest request, java.lang.Object command, BindException errors) throws java.lang.Exception
bindOnNewForm
is true
.
Default implementation delegates to onBindOnNewForm(request, command)
.
request
- current render requestcommand
- the command object to perform further binding onerrors
- validation errors holder, allowing for additional
custom registration of binding errorsjava.lang.Exception
- in case of invalid state or argumentsonBindOnNewForm(RenderRequest, Object)
,
setBindOnNewForm(boolean)
protected void onBindOnNewForm(RenderRequest request, java.lang.Object command) throws java.lang.Exception
onBindOnNewForm
version
with all parameters, after standard binding when displaying the form view.
Only called if bindOnNewForm
is set to true
.
The default implementation is empty.
request
- current render requestcommand
- the command object to perform further binding onjava.lang.Exception
- in case of invalid state or argumentsonBindOnNewForm(RenderRequest, Object, BindException)
,
setBindOnNewForm(boolean)
protected final java.lang.Object getCommand(PortletRequest request) throws java.lang.Exception
Calls formBackingObject
if the object is not in the session
getCommand
in class BaseCommandController
request
- current requestjava.lang.Exception
formBackingObject(PortletRequest)
protected java.lang.Object formBackingObject(PortletRequest request) throws java.lang.Exception
The properties of the form object will correspond to the form field values in your form view. This object will be exposed in the model under the specified command name, to be accessed under that name in the view: for example, with a "spring:bind" tag. The default command name is "command".
Note that you need to activate session form mode to reuse the form-backing object across the entire form workflow. Else, a new instance of the command class will be created for each submission attempt, just using this backing object as template for the initial form.
The default implementation calls BaseCommandController.createCommand
,
creating a new empty instance of the command class.
Subclasses can override this to provide a preinitialized backing object.
request
- current portlet requestjava.lang.Exception
- in case of invalid state or argumentsBaseCommandController.setCommandName(java.lang.String)
,
BaseCommandController.setCommandClass(java.lang.Class)
,
BaseCommandController.createCommand()
protected abstract ModelAndView showForm(RenderRequest request, RenderResponse response, BindException errors) throws java.lang.Exception
A typical implementation will call
showForm(request, errors, "myView")
to prepare the form view for a specific view name, returning the
ModelAndView provided there.
For building a custom ModelAndView, 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.
You also need to include the model returned by referenceData
.
Note: If you decide to have a "formView" property specifying the view name, consider using SimpleFormController.
request
- current render requestresponse
- current render responseerrors
- validation errors holderjava.lang.Exception
- in case of invalid state or argumentsshowForm(RenderRequest, BindException, String)
,
Errors
,
BindException.getModel()
,
referenceData(PortletRequest, Object, Errors)
,
SimpleFormController.setFormView(java.lang.String)
protected final ModelAndView showForm(RenderRequest request, BindException errors, java.lang.String viewName) throws java.lang.Exception
In session form mode: Re-puts the form object in the session when returning to the form, as it has been removed by getCommand.
Can be used in subclasses to redirect back to a specific form page.
request
- current render requesterrors
- validation errors holderviewName
- name of the form viewjava.lang.Exception
- in case of invalid state or argumentsshowForm(RenderRequest, BindException, String, Map)
,
showForm(RenderRequest, RenderResponse, BindException)
protected final ModelAndView showForm(RenderRequest request, BindException errors, java.lang.String viewName, java.util.Map controlModel) throws java.lang.Exception
In session form mode: Re-puts the form object in the session when returning to the form, as it has been removed by getCommand.
Can be used in subclasses to redirect back to a specific form page.
request
- current render requesterrors
- validation errors holderviewName
- name of the form viewcontrolModel
- model map containing controller-specific control data
(e.g. current page in wizard-style controllers or special error message)java.lang.Exception
- in case of invalid state or argumentsshowForm(RenderRequest, BindException, String)
,
showForm(RenderRequest, RenderResponse, BindException)
protected java.util.Map referenceData(PortletRequest request, java.lang.Object command, Errors errors) throws java.lang.Exception
The default implementation returns null
.
Subclasses can override this to set reference data used in the view.
request
- current render requestcommand
- form object with request parameters bound onto iterrors
- validation errors holderjava.lang.Exception
- in case of invalid state or argumentsModelAndView
protected abstract ModelAndView renderFormSubmission(RenderRequest request, RenderResponse response, java.lang.Object command, BindException errors) throws java.lang.Exception
handleRequestInternal
in case of a form submission, with or without binding errors. Implementations
need to proceed properly, typically showing a form view in case of binding
errors or rendering the result of a submit action else.
For a success view, 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. For a form view,
simply return the ModelAndView object privded by showForm
.
request
- current render requestresponse
- current render responsecommand
- form object with request parameters bound onto iterrors
- errors holderjava.lang.Exception
- in case of errorshandleRenderRequestInternal(RenderRequest, RenderResponse)
,
processFormSubmission(ActionRequest, ActionResponse, java.lang.Object, org.springframework.validation.BindException)
,
isFormSubmission(PortletRequest)
,
showForm(RenderRequest, RenderResponse, BindException)
,
Errors
,
BindException.getModel()
protected abstract void processFormSubmission(ActionRequest request, ActionResponse response, java.lang.Object command, BindException errors) throws java.lang.Exception
handleRequestInternal
in case of a form submission, with or without binding errors. Implementations
need to proceed properly, typically performing a submit action if there are no binding errors.
Subclasses can implement this to provide custom submission handling like triggering a custom action. They can also provide custom validation or proceed with the submission accordingly.
request
- current action requestresponse
- current action responsecommand
- form object with request parameters bound onto iterrors
- errors holder (subclass can add errors if it wants to)java.lang.Exception
- in case of errorshandleActionRequestInternal(ActionRequest, ActionResponse)
,
renderFormSubmission(RenderRequest, RenderResponse, java.lang.Object, org.springframework.validation.BindException)
,
isFormSubmission(PortletRequest)
,
Errors
protected ModelAndView renderInvalidSubmit(RenderRequest request, RenderResponse response) throws java.lang.Exception
The default implementation simply tries to resubmit the form with a new form object. This should also work if the user hit the back button, changed some form data, and resubmitted the form.
Note: To avoid duplicate submissions, you need to override this method.
Either show some "invalid submit" message, or call showNewForm
for
resetting the form (prepopulating it with the current values if "bindOnNewForm"
is true). In this case, the form object in the session serves as transaction token.
protected ModelAndView renderInvalidSubmit(RenderRequest request, RenderResponse response) throws Exception { return showNewForm(request, response); }You can also show a new form but with special errors registered on it:
protected ModelAndView renderInvalidSubmit(RenderRequest request, RenderResponse response) throws Exception { BindException errors = getErrorsForNewForm(request); errors.reject("duplicateFormSubmission", "Duplicate form submission"); return showForm(request, response, errors); }
WARNING: If you override this method, be sure to also override the action phase version of this method so that it will not attempt to perform the resubmit action by default.
request
- current render requestresponse
- current render responsejava.lang.Exception
- in case of errorshandleInvalidSubmit(ActionRequest, ActionResponse)
protected void handleInvalidSubmit(ActionRequest request, ActionResponse response) throws java.lang.Exception
The default implementation simply tries to resubmit the form with a new form object. This should also work if the user hit the back button, changed some form data, and resubmitted the form.
Note: To avoid duplicate submissions, you need to override this method. Most likely you will simply want it to do nothing here in the action phase and diplay an appropriate error and a new form in the render phase.
protected void handleInvalidSubmit(ActionRequest request, ActionResponse response) throws Exception { }
If you override this method but you do need a command object and bind errors
in the render phase, be sure to call setRenderCommandAndErrors
from here.
request
- current action requestresponse
- current action responsejava.lang.Exception
- in case of errorsrenderInvalidSubmit(RenderRequest, RenderResponse)
,
BaseCommandController.setRenderCommandAndErrors(ActionRequest, java.lang.Object, org.springframework.validation.BindException)