This class is deprecated.
as of Spring 3.0, in favor of annotated controllers
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
. The difference
is that you do not need to implement showForm
,
processFormSubmission
, and
renderFormSubmission
: A form view and a
success view can be configured declaratively.
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. The main difference in the methods in this class is that the
onSubmit
methods have all been split into onSubmitAction
and onSubmitRender
to account for the two phases.
Workflow
(in addition to the superclass):
processFormSubmission
which inspects
the Errors
object to see if
any errors have occurred during binding and validation.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 onFormChange(ActionRequest, ActionResponse, Object)
, 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.onSubmitAction
during the action phase and then onSubmitRender
during the render phase, which in case of the
default implementation delegate to onSubmitAction
and onSubmitRender
with just the command object.
The default implementation of the latter method will return the configured
successView
. Consider just implementing doSubmitAction
for simply performing a submit action during the action phase and then rendering
the success view during the render phase.The submit behavior can be customized by overriding one of the
onSubmitAction
or onSubmitRender
methods. Submit actions can also perform custom validation if necessary
(typically database-driven checks), calling showForm
in case of validation errors to show
the form view again. You do not have to override both the onSubmitAction
and
onSubmitRender
methods at a given level unless you truly have custom logic to
perform in both.
WARNING: Make sure that any one-time system updates (such as database
updates or file writes) are performed in either an onSubmitAction
method or the doSubmitAction
method. Logic in the
onSubmitRender
methods may be executed repeatedly by
the portal whenever the page containing the portlet is updated.
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 onSubmitRender() methods. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.springframework.web.portlet.mvc.BaseCommandController
|
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.springframework.context.support.ApplicationObjectSupport
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Create a new SimpleFormController.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Return the name of the view that should be used for form display.
| |||||||||||
Return the name of the view that should be shown on successful submit.
| |||||||||||
Set the name of the view that should be used for form display.
| |||||||||||
Set the name of the view that should be shown on successful submit.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Template method for submit actions.
| |||||||||||
Determine whether the given request is a form change request.
| |||||||||||
Simpler
onFormChange variant, called by the full version
onFormChange(request, response, command, errors) . | |||||||||||
Called during form submission if
isFormChangeRequest(PortletRequest)
returns true . | |||||||||||
Simpler
onSubmitAction version. | |||||||||||
Simplest
onSubmitAction version. | |||||||||||
Submit action phase callback with all parameters.
| |||||||||||
Simpler
onSubmitRender version. | |||||||||||
Submit render phase callback with all parameters.
| |||||||||||
Simplest
onSubmitRender version. | |||||||||||
This implementation does nothing in case of errors,
and delegates to
onSubmitAction 's full version else. | |||||||||||
Create a reference data map for the given request and command,
consisting of bean name/bean instance pairs as expected by ModelAndView.
| |||||||||||
Create a reference data map for the given request.
| |||||||||||
This implementation calls
showForm in case of errors,
and delegates to onSubmitRender | |||||||||||
This implementation shows the configured form view.
| |||||||||||
This implementation shows the configured form view, delegating to the
analogous showForm version with a controlModel argument.
| |||||||||||
This implementation delegates to
isFormChangeRequest(PortletRequest) :
A form change request changes the appearance of the form
and should not get validated but just show the new form. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.springframework.web.portlet.mvc.AbstractFormController
| |||||||||||
From class
org.springframework.web.portlet.mvc.BaseCommandController
| |||||||||||
From class
org.springframework.web.portlet.mvc.AbstractController
| |||||||||||
From class
org.springframework.web.portlet.handler.PortletContentGenerator
| |||||||||||
From class
org.springframework.web.portlet.context.PortletApplicationObjectSupport
| |||||||||||
From class
org.springframework.context.support.ApplicationObjectSupport
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
org.springframework.context.ApplicationContextAware
| |||||||||||
From interface
org.springframework.web.portlet.context.PortletContextAware
| |||||||||||
From interface
org.springframework.web.portlet.mvc.Controller
|
Create a new SimpleFormController.
Subclasses should set the following properties, either in the constructor
or via a BeanFactory: commandName, commandClass, sessionForm, formView,
successView. Note that commandClass doesn't need to be set when overriding
formBackingObject
, as this determines the class anyway.
Return the name of the view that should be used for form display.
Return the name of the view that should be shown on successful submit.
Set the name of the view that should be used for form display.
Set the name of the view that should be shown on successful submit.
Template method for submit actions. Called by the default implementation
of the simplest onSubmitAction
version.
This is the preferred submit callback to implement if you want to perform an action (like storing changes to the database) and then render the success view with the command and Errors instance as model.
command | form object with request parameters bound onto it |
---|
Exception | in case of errors |
---|
Determine whether the given request is a form change request. A form change request changes the appearance of the form and should always show the new form, without validation.
Gets called by suppressValidation(PortletRequest)
and processFormSubmission(ActionRequest, ActionResponse, Object, BindException)
.
Consequently, this single method determines to suppress validation
and to show the form view in any case.
The default implementation returns false
request | current portlet request |
---|
Simpler onFormChange
variant, called by the full version
onFormChange(request, response, command, errors)
.
The default implementation is empty.
request | current action request |
---|---|
response | current action response |
command | form object with request parameters bound onto it |
Exception | in case of errors |
---|
Called during form submission if isFormChangeRequest(PortletRequest)
returns true
. Allows subclasses to implement custom logic
to modify the command object to directly modify data in the form.
The default implementation delegates to
onFormChange(request, response, command)
.
request | current action request |
---|---|
response | current action response |
command | form object with request parameters bound onto it |
errors | validation errors holder, allowing for additional custom validation |
Exception | in case of errors |
---|
Simpler onSubmitAction
version. Called by the default implementation
of the onSubmitAction
version with all parameters.
The default implementation calls onSubmitAction(Object)
.
Subclasses can override this to provide custom submission handling that does not need request and response.
command | form object with request parameters bound onto it |
---|---|
errors | Errors instance without errors |
Exception | in case of errors |
---|
Simplest onSubmitAction
version. Called by the default implementation
of the onSubmitAction
version with command and BindException parameters.
This implementation calls doSubmitAction
.
Subclasses can override this to provide custom submission handling that just depends on the command object.
command | form object with request parameters bound onto it |
---|
Exception | in case of errors |
---|
Submit action phase callback with all parameters. Called in case of submit without errors reported by the registered validator respectively on every submit if no validator.
The default implementation delegates to onSubmitAction(Object, BindException)
.
For simply performing a submit action consider implementing doSubmitAction
rather than an onSubmitAction
version.
Subclasses can override this to provide custom submission handling like storing
the object to the database. Implementations can also perform custom validation and
signal the render phase to call showForm
to return to the form. Do not
implement multiple onSubmitAction
methods: In that case,
just this method will be called by the controller.
request | current action request |
---|---|
response | current action response |
command | form object with request parameters bound onto it |
errors | Errors instance without errors (subclass can add errors if it wants to) |
Exception | in case of errors |
---|
Simpler onSubmitRender
version. Called by the default implementation
of the onSubmitRender
version with all parameters.
The default implementation calls onSubmitRender(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.
command | form object with request parameters bound onto it |
---|---|
errors | Errors instance without errors |
Exception | in case of errors |
---|
Submit render phase 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 onSubmitRender(Object, BindException)
.
For simply performing a submit action and rendering the specified success view,
do not implement an onSubmitRender
at all.
Subclasses can override this to provide custom rendering to display results of
the action phase. Implementations can also call showForm
to return to the form
if the onSubmitAction
failed custom validation. Do not implement multiple
onSubmitRender
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.
request | current render request |
---|---|
response | current render response |
command | form object with request parameters bound onto it |
errors | Errors instance without errors (subclass can add errors if it wants to) |
Exception | in case of errors |
---|
Simplest onSubmitRender
version. Called by the default implementation
of the onSubmitRender
version with command and BindException parameters.
This implementation returns null as ModelAndView, making the calling
onSubmitRender
method perform its default rendering of the success view.
Subclasses can override this to provide custom submission handling that just depends on the command object.
command | form object with request parameters bound onto it |
---|
Exception | in case of errors |
---|
This implementation does nothing in case of errors,
and delegates to onSubmitAction
's full version 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 onSubmitAction
methods or doSubmitAction
.
request | current action request |
---|---|
response | current action response |
command | form object with request parameters bound onto it |
errors | errors holder (subclass can add errors if it wants to) |
Exception |
---|
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 referenceData(PortletRequest)
.
Subclasses can override this to set reference data used in the view.
request | current portlet request |
---|---|
command | form object with request parameters bound onto it |
errors | validation errors holder |
Exception | in case of invalid state or arguments |
---|
Create a reference data map for the given request. Called by referenceData version with all parameters.
The default implementation returns null
.
Subclasses can override this to set reference data used in the view.
request | current portlet request |
---|
Exception | in case of invalid state or arguments |
---|
This implementation calls 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 showForm
in case of errors,
and delegates to onSubmitRender
's full version else.
onSubmitRender
methods.
request | current render request |
---|---|
response | current render response |
command | form object with request parameters bound onto it |
errors | errors holder |
Exception |
---|
This implementation shows the configured form view.
Can be called within onSubmit implementations, to redirect back to the form in case of custom validation errors (i.e. 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.
request | current render request |
---|---|
errors | validation errors holder |
controlModel | model map containing controller-specific control data (e.g. current page in wizard-style controllers or special error message) |
Exception | in case of invalid state or arguments |
---|
This implementation shows the configured form view, delegating to the analogous showForm version with a controlModel argument.
Can be called within onSubmit implementations, to redirect back to the form in case of custom validation errors (i.e. 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).
request | current render request |
---|---|
response | current render response |
errors | validation errors holder |
Exception |
---|
This implementation delegates to isFormChangeRequest(PortletRequest)
:
A form change request changes the appearance of the form
and should not get validated but just show the new form.
request | current portlet request |
---|