|
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.portlet.context.PortletApplicationObjectSupport org.springframework.web.portlet.handler.PortletContentGenerator org.springframework.web.portlet.mvc.AbstractController org.springframework.web.portlet.mvc.BaseCommandController
public abstract class BaseCommandController
Controller implementation which creates an object (the command object) on receipt of a request and attempts to populate this object with request parameters.
This controller is the base for all controllers wishing to populate
JavaBeans based on request parameters, validate the content of such
JavaBeans using Validators
and use custom editors (in the form of
PropertyEditors
) to transform
objects into strings and vice versa, for example. Three notions are mentioned here:
Command class:
An instance of the command class will be created for each request and populated
with request parameters. A command class can basically be any Java class; the only
requirement is a no-arg constructor. The command class should preferably be a
JavaBean in order to be able to populate bean properties with request parameters.
Populating using request parameters and PropertyEditors:
Upon receiving a request, any BaseCommandController will attempt to fill the
command object using the request parameters. This is done using the typical
and well-known JavaBeans property notation. When a request parameter named
'firstName'
exists, the framework will attempt to call
setFirstName([value])
passing the value of the parameter. Nested properties
are of course supported. For instance a parameter named 'address.city'
will result in a getAddress().setCity([value])
call on the
command class.
It's important to realize that you are not limited to String arguments in
your JavaBeans. Using the PropertyEditor-notion as supplied by the
java.beans package, you will be able to transform Strings to Objects and
the other way around. For instance setLocale(Locale loc)
is
perfectly possible for a request parameter named locale
having
a value of en
, as long as you register the appropriate
PropertyEditor in the Controller (see initBinder()
for more information on that matter).
Validators:
After the controller has successfully populated the command object with
parameters from the request, it will use any configured validators to
validate the object. Validation results will be put in a
Errors
object which can be
used in a View to render any input problems.
Workflow
(and that defined by superclass):
Since this class is an abstract base class for more specific implementation,
it does not override the handleRequestInternal()
methods and also has no
actual workflow. Implementing classes like
AbstractFormController
,
AbstractCommandController
,
SimpleFormController
and
AbstractWizardFormController
provide actual functionality and workflow.
More information on workflow performed by superclasses can be found
here.
Exposed configuration properties
(and those defined by superclass):
name | default | description |
commandName | command | the name to use when binding the instantiated command class to the request |
commandClass | null | the class to use upon receiving a request and which to fill using the request parameters. What object is used and whether or not it should be created is defined by extending classes and their configuration properties and methods. |
validators | null | Array of Validator beans. The validator will be called at appropriate places in the workflow of subclasses (have a look at those for more info) to validate the command object. |
validator | null | Short-form property for setting only one Validator bean (usually passed in using a <ref bean="beanId"/> property. |
validateOnBinding | true | Indicates whether or not to validate the command object after the object has been populated with request parameters. |
Thanks to Rainer Schmitz and Nick Lothian for their suggestions!
Field Summary | |
---|---|
static String |
DEFAULT_COMMAND_NAME
|
Fields inherited from class org.springframework.context.support.ApplicationObjectSupport |
---|
logger |
Constructor Summary | |
---|---|
BaseCommandController()
|
Method Summary | |
---|---|
protected PortletRequestDataBinder |
bindAndValidate(PortletRequest request,
Object command)
Bind the parameters of the given request to the given command object. |
protected boolean |
checkCommand(Object command)
Check if the given command object is a valid for this controller, i.e. its command class. |
protected PortletRequestDataBinder |
createBinder(PortletRequest request,
Object command)
Create a new binder instance for the given command and request. |
protected Object |
createCommand()
Create a new command instance for the command class of this controller. |
BindingErrorProcessor |
getBindingErrorProcessor()
Return the strategy to use for processing binding errors. |
protected Object |
getCommand(PortletRequest request)
Retrieve a command object for the given request. |
Class |
getCommandClass()
Return the command class for this controller. |
String |
getCommandName()
Return the name of the command in the model. |
MessageCodesResolver |
getMessageCodesResolver()
Return the strategy to use for resolving errors into message codes. |
PropertyEditorRegistrar[] |
getPropertyEditorRegistrars()
Return the PropertyEditorRegistrars to be applied to every DataBinder that this controller uses. |
protected Object |
getRenderCommand(RenderRequest request)
Get the command object cached for the render phase. |
protected String |
getRenderCommandSessionAttributeName()
Return the name of the session attribute that holds the render phase command object for this form controller. |
protected BindException |
getRenderErrors(RenderRequest request)
Get the bind and validation errors cached for the render phase. |
protected String |
getRenderErrorsSessionAttributeName()
Return the name of the session attribute that holds the render phase command object for this form controller. |
Validator |
getValidator()
|
Validator[] |
getValidators()
Return the Validators for this controller. |
protected void |
initApplicationContext()
Subclasses can override this for custom initialization behavior. |
protected void |
initBinder(PortletRequest request,
PortletRequestDataBinder binder)
Initialize the given binder instance, for example with custom editors. |
boolean |
isValidateOnBinding()
Return if the Validator should get applied when binding. |
protected void |
onBind(PortletRequest request,
Object command)
Callback for custom post-processing in terms of binding. |
protected void |
onBind(PortletRequest request,
Object command,
BindException errors)
Callback for custom post-processing in terms of binding. |
protected void |
onBindAndValidate(PortletRequest request,
Object command,
BindException errors)
Callback for custom post-processing in terms of binding and validation. |
protected void |
prepareBinder(PortletRequestDataBinder binder)
Prepare the given binder, applying the specified MessageCodesResolver, BindingErrorProcessor and PropertyEditorRegistrars (if any). |
void |
setBindingErrorProcessor(BindingErrorProcessor bindingErrorProcessor)
Set the strategy to use for processing binding errors, that is, required field errors and PropertyAccessException s. |
void |
setCommandClass(Class commandClass)
Set the command class for this controller. |
void |
setCommandName(String commandName)
Set the name of the command in the model. |
void |
setMessageCodesResolver(MessageCodesResolver messageCodesResolver)
Set the strategy to use for resolving errors into message codes. |
void |
setPropertyEditorRegistrar(PropertyEditorRegistrar propertyEditorRegistrar)
Specify a single PropertyEditorRegistrar to be applied to every DataBinder that this controller uses. |
void |
setPropertyEditorRegistrars(PropertyEditorRegistrar[] propertyEditorRegistrars)
Specify one or more PropertyEditorRegistrars to be applied to every DataBinder that this controller uses. |
protected void |
setRenderCommandAndErrors(ActionRequest request,
Object command,
BindException errors)
Set the command object and errors object for the render phase. |
void |
setValidateOnBinding(boolean validateOnBinding)
Set if the Validator should get applied when binding. |
void |
setValidator(Validator validator)
Set the primary Validator for this controller. |
void |
setValidators(Validator[] validators)
Set the Validators for this controller. |
protected boolean |
suppressBinding(PortletRequest request)
Return whether to suppress binding for the given request. |
protected boolean |
suppressValidation(PortletRequest request)
Return whether to suppress validation for the given request. |
protected boolean |
useDirectFieldAccess()
Determine whether to use direct field access instead of bean property access. |
Methods inherited from class org.springframework.web.portlet.mvc.AbstractController |
---|
handleActionRequest, handleActionRequestInternal, handleRenderRequest, handleRenderRequestInternal, isRenderWhenMinimized, isSynchronizeOnSession, setRenderWhenMinimized, setSynchronizeOnSession |
Methods inherited from class org.springframework.web.portlet.handler.PortletContentGenerator |
---|
applyCacheSeconds, cacheForSeconds, check, checkAndPrepare, checkAndPrepare, getCacheSeconds, isRequireSession, preventCaching, setCacheSeconds, setRequireSession |
Methods inherited from class org.springframework.web.portlet.context.PortletApplicationObjectSupport |
---|
getPortletContext, getTempDir, isContextRequired, setPortletContext |
Methods inherited from class org.springframework.context.support.ApplicationObjectSupport |
---|
getApplicationContext, getMessageSourceAccessor, 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 DEFAULT_COMMAND_NAME
Constructor Detail |
---|
public BaseCommandController()
Method Detail |
---|
public final void setCommandName(String commandName)
public final String getCommandName()
public final void setCommandClass(Class commandClass)
public final Class getCommandClass()
public final void setValidator(Validator validator)
setValidators(Validator[])
to set multiple validators.
public final Validator getValidator()
public final void setValidators(Validator[] validators)
public final Validator[] getValidators()
public final void setValidateOnBinding(boolean validateOnBinding)
public final boolean isValidateOnBinding()
public final void setMessageCodesResolver(MessageCodesResolver messageCodesResolver)
Default is null, i.e. using the default strategy of the data binder.
public final MessageCodesResolver getMessageCodesResolver()
public final void setBindingErrorProcessor(BindingErrorProcessor bindingErrorProcessor)
PropertyAccessException
s.
Default is null
, i.e. using the default strategy of
the data binder.
public final BindingErrorProcessor getBindingErrorProcessor()
public final void setPropertyEditorRegistrar(PropertyEditorRegistrar propertyEditorRegistrar)
Allows for factoring out the registration of PropertyEditors
to separate objects, as an alternative to initBinder
.
public final void setPropertyEditorRegistrars(PropertyEditorRegistrar[] propertyEditorRegistrars)
Allows for factoring out the registration of PropertyEditors
to separate objects, as alternative to initBinder
.
public final PropertyEditorRegistrar[] getPropertyEditorRegistrars()
protected void initApplicationContext()
ApplicationObjectSupport
setApplicationContext
after setting the context instance.
Note: Does not get called on reinitialization of the context but rather just on first initialization of this object's context reference.
initApplicationContext
in class ApplicationObjectSupport
protected Object getCommand(PortletRequest request) throws Exception
Default implementation calls createCommand
.
Subclasses can override this.
request
- current portlet request
Exception
createCommand()
protected final Object createCommand() throws Exception
This implementation uses BeanUtils.instantiateClass
,
so the command needs to have a no-arg constructor (supposed to be
public, but not required to).
Exception
- if the command object could not be instantiatedBeanUtils.instantiateClass(Class)
protected final boolean checkCommand(Object command)
command
- the command object to check
protected final PortletRequestDataBinder bindAndValidate(PortletRequest request, Object command) throws Exception
request
- current portlet requestcommand
- the command to bind onto
Exception
- in case of invalid state or argumentsprotected boolean suppressBinding(PortletRequest request)
Default implementation always returns "false". Can be overridden in subclasses to suppress validation, for example, if a special request parameter is set.
request
- current portlet request
suppressValidation(javax.portlet.PortletRequest)
protected PortletRequestDataBinder createBinder(PortletRequest request, Object command) throws Exception
Called by bindAndValidate
. Can be overridden to plug in
custom PortletRequestDataBinder instances.
The default implementation creates a standard PortletRequestDataBinder and
invokes prepareBinder
and initBinder
.
Note that neither prepareBinder
nor initBinder
will be invoked automatically if you override this method! Call those methods
at appropriate points of your overridden method.
request
- current portlet requestcommand
- the command to bind onto
Exception
- in case of invalid state or argumentsbindAndValidate(javax.portlet.PortletRequest, java.lang.Object)
,
prepareBinder(org.springframework.web.portlet.bind.PortletRequestDataBinder)
,
initBinder(javax.portlet.PortletRequest, org.springframework.web.portlet.bind.PortletRequestDataBinder)
protected final void prepareBinder(PortletRequestDataBinder binder)
createBinder
.
binder
- the new binder instancecreateBinder(javax.portlet.PortletRequest, java.lang.Object)
,
setMessageCodesResolver(org.springframework.validation.MessageCodesResolver)
,
setBindingErrorProcessor(org.springframework.validation.BindingErrorProcessor)
protected boolean useDirectFieldAccess()
prepareBinder
.
Default is "false". Can be overridden in subclasses.
protected void initBinder(PortletRequest request, PortletRequestDataBinder 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.
request
- current portlet requestbinder
- new binder instance
Exception
- in case of invalid state or argumentscreateBinder(javax.portlet.PortletRequest, java.lang.Object)
,
DataBinder.registerCustomEditor(java.lang.Class, java.beans.PropertyEditor)
,
CustomDateEditor
protected void onBind(PortletRequest request, Object command, BindException errors) throws Exception
Default implementation delegates to onBind(request, command)
.
request
- current portlet requestcommand
- the command object to perform further binding onerrors
- validation errors holder, allowing for additional
custom registration of binding errors
Exception
- in case of invalid state or argumentsbindAndValidate(javax.portlet.PortletRequest, java.lang.Object)
,
onBind(PortletRequest, Object)
protected void onBind(PortletRequest request, Object command) throws Exception
onBind
version with
all parameters, after standard binding but before validation.
Default implementation is empty.
request
- current portlet requestcommand
- the command object to perform further binding on
Exception
- in case of invalid state or argumentsonBind(PortletRequest, Object, BindException)
protected boolean suppressValidation(PortletRequest request)
Default implementation always returns "false". Can be overridden in subclasses to suppress validation, for example, if a special request parameter is set.
request
- current portlet request
protected void onBindAndValidate(PortletRequest request, Object command, BindException errors) throws Exception
Default implementation is empty.
request
- current portlet requestcommand
- the command object, still allowing for further bindingerrors
- validation errors holder, allowing for additional
custom validation
Exception
- in case of invalid state or argumentsbindAndValidate(javax.portlet.PortletRequest, java.lang.Object)
,
Errors
protected String getRenderCommandSessionAttributeName()
PortletSession.getAttribute(java.lang.String)
protected String getRenderErrorsSessionAttributeName()
PortletSession.getAttribute(java.lang.String)
protected final Object getRenderCommand(RenderRequest request) throws PortletException
protected final BindException getRenderErrors(RenderRequest request) throws PortletException
protected final void setRenderCommandAndErrors(ActionRequest request, Object command, BindException errors) throws Exception
request
- the current action requestcommand
- the command object to preserve for the render phaseerrors
- the errors from binding and validation to preserve for the render phase
Exception
getRenderCommand(javax.portlet.RenderRequest)
,
getRenderErrors(javax.portlet.RenderRequest)
,
getRenderCommandSessionAttributeName()
,
getRenderErrorsSessionAttributeName()
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |