org.springframework.web.portlet.mvc
Class BaseCommandController

java.lang.Object
  extended by org.springframework.context.support.ApplicationObjectSupport
      extended by org.springframework.web.portlet.context.PortletApplicationObjectSupport
          extended by org.springframework.web.portlet.handler.PortletContentGenerator
              extended by org.springframework.web.portlet.mvc.AbstractController
                  extended by org.springframework.web.portlet.mvc.BaseCommandController
All Implemented Interfaces:
ApplicationContextAware, PortletContextAware, Controller
Direct Known Subclasses:
AbstractCommandController, AbstractFormController

Deprecated. as of Spring 3.0, in favor of annotated controllers

@Deprecated
public abstract class BaseCommandController
extends AbstractController

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!

Since:
2.0
Author:
Juergen Hoeller, John A. Lewis

Field Summary
static java.lang.String DEFAULT_COMMAND_NAME
          Deprecated.  
 
Fields inherited from class org.springframework.context.support.ApplicationObjectSupport
logger
 
Constructor Summary
BaseCommandController()
          Deprecated.  
 
Method Summary
protected  PortletRequestDataBinder bindAndValidate(javax.portlet.PortletRequest request, java.lang.Object command)
          Deprecated. Bind the parameters of the given request to the given command object.
protected  boolean checkCommand(java.lang.Object command)
          Deprecated. Check if the given command object is a valid for this controller, i.e.
protected  PortletRequestDataBinder createBinder(javax.portlet.PortletRequest request, java.lang.Object command)
          Deprecated. Create a new binder instance for the given command and request.
protected  java.lang.Object createCommand()
          Deprecated. Create a new command instance for the command class of this controller.
 BindingErrorProcessor getBindingErrorProcessor()
          Deprecated. Return the strategy to use for processing binding errors (if any).
protected  java.lang.Object getCommand(javax.portlet.PortletRequest request)
          Deprecated. Retrieve a command object for the given request.
 java.lang.Class getCommandClass()
          Deprecated. Return the command class for this controller.
 java.lang.String getCommandName()
          Deprecated. Return the name of the command in the model.
 MessageCodesResolver getMessageCodesResolver()
          Deprecated. Return the strategy to use for resolving errors into message codes (if any).
 PropertyEditorRegistrar[] getPropertyEditorRegistrars()
          Deprecated. Return the PropertyEditorRegistrars (if any) to be applied to every DataBinder that this controller uses.
protected  java.lang.Object getRenderCommand(javax.portlet.RenderRequest request)
          Deprecated. Get the command object cached for the render phase.
protected  java.lang.String getRenderCommandSessionAttributeName()
          Deprecated. Return the name of the session attribute that holds the render phase command object for this form controller.
protected  BindException getRenderErrors(javax.portlet.RenderRequest request)
          Deprecated. Get the bind and validation errors cached for the render phase.
protected  java.lang.String getRenderErrorsSessionAttributeName()
          Deprecated. Return the name of the session attribute that holds the render phase command object for this form controller.
 Validator getValidator()
          Deprecated.  
 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  void initApplicationContext()
          Deprecated. Subclasses can override this for custom initialization behavior.
protected  void initBinder(javax.portlet.PortletRequest request, PortletRequestDataBinder binder)
          Deprecated. Initialize the given binder instance, for example with custom editors.
 boolean isValidateOnBinding()
          Deprecated. Return if the Validator should get applied when binding.
protected  void onBind(javax.portlet.PortletRequest request, java.lang.Object command)
          Deprecated. Callback for custom post-processing in terms of binding.
protected  void onBind(javax.portlet.PortletRequest request, java.lang.Object command, BindException errors)
          Deprecated. Callback for custom post-processing in terms of binding.
protected  void onBindAndValidate(javax.portlet.PortletRequest request, java.lang.Object command, BindException errors)
          Deprecated. Callback for custom post-processing in terms of binding and validation.
protected  void prepareBinder(PortletRequestDataBinder binder)
          Deprecated. Prepare the given binder, applying the specified MessageCodesResolver, BindingErrorProcessor and PropertyEditorRegistrars (if any).
 void setBindingErrorProcessor(BindingErrorProcessor bindingErrorProcessor)
          Deprecated. Set the strategy to use for processing binding errors, that is, required field errors and PropertyAccessExceptions.
 void setCommandClass(java.lang.Class commandClass)
          Deprecated. Set the command class for this controller.
 void setCommandName(java.lang.String commandName)
          Deprecated. Set the name of the command in the model.
 void setMessageCodesResolver(MessageCodesResolver messageCodesResolver)
          Deprecated. Set the strategy to use for resolving errors into message codes.
 void setPropertyEditorRegistrar(PropertyEditorRegistrar propertyEditorRegistrar)
          Deprecated. Specify a single PropertyEditorRegistrar to be applied to every DataBinder that this controller uses.
 void setPropertyEditorRegistrars(PropertyEditorRegistrar[] propertyEditorRegistrars)
          Deprecated. Specify one or more PropertyEditorRegistrars to be applied to every DataBinder that this controller uses.
protected  void setRenderCommandAndErrors(javax.portlet.ActionRequest request, java.lang.Object command, BindException errors)
          Deprecated. Set the command object and errors object for the render phase.
 void setValidateOnBinding(boolean validateOnBinding)
          Deprecated. Set if the Validator should get applied when binding.
 void setValidator(Validator validator)
          Deprecated. Set the primary Validator for this controller.
 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.
protected  boolean suppressBinding(javax.portlet.PortletRequest request)
          Deprecated. Return whether to suppress binding for the given request.
protected  boolean suppressValidation(javax.portlet.PortletRequest request)
          Deprecated. Return whether to suppress validation for the given request.
protected  boolean useDirectFieldAccess()
          Deprecated. 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, initApplicationContext, requiredContextClass, setApplicationContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_COMMAND_NAME

public static final java.lang.String DEFAULT_COMMAND_NAME
Deprecated. 
See Also:
Constant Field Values
Constructor Detail

BaseCommandController

public BaseCommandController()
Deprecated. 
Method Detail

setCommandName

public final void setCommandName(java.lang.String commandName)
Deprecated. 
Set the name of the command in the model. The command object will be included in the model under this name.


getCommandName

public final java.lang.String getCommandName()
Deprecated. 
Return the name of the command in the model.


setCommandClass

public final void setCommandClass(java.lang.Class commandClass)
Deprecated. 
Set the command class for this controller. An instance of this class gets populated and validated on each request.


getCommandClass

public final java.lang.Class getCommandClass()
Deprecated. 
Return the command class for this controller.


setValidator

public final void setValidator(Validator validator)
Deprecated. 
Set the primary Validator for this controller. The Validator must support the specified command class. If there are one or more existing validators set already when this method is called, only the specified validator will be kept. Use setValidators(Validator[]) to set multiple validators.


getValidator

public final Validator getValidator()
Deprecated. 
Returns:
the primary Validator for this controller.

setValidators

public final void setValidators(Validator[] validators)
Deprecated. 
Set the Validators for this controller. The Validator must support the specified command class.


getValidators

public final Validator[] getValidators()
Deprecated. 
Return the Validators for this controller.


setValidateOnBinding

public final void setValidateOnBinding(boolean validateOnBinding)
Deprecated. 
Set if the Validator should get applied when binding.


isValidateOnBinding

public final boolean isValidateOnBinding()
Deprecated. 
Return if the Validator should get applied when binding.


setMessageCodesResolver

public final void setMessageCodesResolver(MessageCodesResolver messageCodesResolver)
Deprecated. 
Set the strategy to use for resolving errors into message codes. Applies the given strategy to all data binders used by this controller.

Default is null, i.e. using the default strategy of the data binder.

See Also:
createBinder(javax.portlet.PortletRequest, java.lang.Object), DataBinder.setMessageCodesResolver(org.springframework.validation.MessageCodesResolver)

getMessageCodesResolver

public final MessageCodesResolver getMessageCodesResolver()
Deprecated. 
Return the strategy to use for resolving errors into message codes (if any).


setBindingErrorProcessor

public final void setBindingErrorProcessor(BindingErrorProcessor bindingErrorProcessor)
Deprecated. 
Set the strategy to use for processing binding errors, that is, required field errors and PropertyAccessExceptions.

Default is null, i.e. using the default strategy of the data binder.

See Also:
createBinder(javax.portlet.PortletRequest, java.lang.Object), DataBinder.setBindingErrorProcessor(org.springframework.validation.BindingErrorProcessor)

getBindingErrorProcessor

public final BindingErrorProcessor getBindingErrorProcessor()
Deprecated. 
Return the strategy to use for processing binding errors (if any).


setPropertyEditorRegistrar

public final void setPropertyEditorRegistrar(PropertyEditorRegistrar propertyEditorRegistrar)
Deprecated. 
Specify a single PropertyEditorRegistrar to be applied to every DataBinder that this controller uses.

Allows for factoring out the registration of PropertyEditors to separate objects, as an alternative to initBinder.

See Also:
initBinder(javax.portlet.PortletRequest, org.springframework.web.portlet.bind.PortletRequestDataBinder)

setPropertyEditorRegistrars

public final void setPropertyEditorRegistrars(PropertyEditorRegistrar[] propertyEditorRegistrars)
Deprecated. 
Specify one or more PropertyEditorRegistrars to be applied to every DataBinder that this controller uses.

Allows for factoring out the registration of PropertyEditors to separate objects, as alternative to initBinder.

See Also:
initBinder(javax.portlet.PortletRequest, org.springframework.web.portlet.bind.PortletRequestDataBinder)

getPropertyEditorRegistrars

public final PropertyEditorRegistrar[] getPropertyEditorRegistrars()
Deprecated. 
Return the PropertyEditorRegistrars (if any) to be applied to every DataBinder that this controller uses.


setWebBindingInitializer

public final void setWebBindingInitializer(WebBindingInitializer webBindingInitializer)
Deprecated. 
Specify a WebBindingInitializer which will apply pre-configured configuration to every DataBinder that this controller uses.

Allows for factoring out the entire binder configuration to separate objects, as an alternative to initBinder(javax.portlet.PortletRequest, org.springframework.web.portlet.bind.PortletRequestDataBinder).


getWebBindingInitializer

public final WebBindingInitializer getWebBindingInitializer()
Deprecated. 
Return the WebBindingInitializer (if any) which will apply pre-configured configuration to every DataBinder that this controller uses.


initApplicationContext

protected void initApplicationContext()
Deprecated. 
Description copied from class: ApplicationObjectSupport
Subclasses can override this for custom initialization behavior.

The default implementation is empty. Called by ApplicationObjectSupport.initApplicationContext(org.springframework.context.ApplicationContext).

Overrides:
initApplicationContext in class ApplicationObjectSupport
See Also:
ApplicationObjectSupport.setApplicationContext(org.springframework.context.ApplicationContext)

getCommand

protected java.lang.Object getCommand(javax.portlet.PortletRequest request)
                               throws java.lang.Exception
Deprecated. 
Retrieve a command object for the given request.

The default implementation calls createCommand(). Subclasses can override this.

Parameters:
request - current portlet request
Returns:
object command to bind onto
Throws:
java.lang.Exception
See Also:
createCommand()

createCommand

protected final java.lang.Object createCommand()
                                        throws java.lang.Exception
Deprecated. 
Create a new command instance for the command class of this controller.

This implementation uses BeanUtils.instantiateClass, so the command needs to have a no-arg constructor (supposed to be public, but not required to).

Returns:
the new command instance
Throws:
java.lang.Exception - if the command object could not be instantiated
See Also:
BeanUtils.instantiateClass(Class)

checkCommand

protected final boolean checkCommand(java.lang.Object command)
Deprecated. 
Check if the given command object is a valid for this controller, i.e. its command class.

Parameters:
command - the command object to check
Returns:
if the command object is valid for this controller

bindAndValidate

protected final PortletRequestDataBinder bindAndValidate(javax.portlet.PortletRequest request,
                                                         java.lang.Object command)
                                                  throws java.lang.Exception
Deprecated. 
Bind the parameters of the given request to the given command object.

Parameters:
request - current portlet request
command - the command to bind onto
Returns:
the PortletRequestDataBinder instance for additional custom validation
Throws:
java.lang.Exception - in case of invalid state or arguments

suppressBinding

protected boolean suppressBinding(javax.portlet.PortletRequest request)
Deprecated. 
Return whether to suppress binding for the given request.

The default implementation always returns false. Can be overridden in subclasses to suppress validation: for example, if a special request parameter is set.

Parameters:
request - current portlet request
Returns:
whether to suppress binding for the given request
See Also:
suppressValidation(javax.portlet.PortletRequest)

createBinder

protected PortletRequestDataBinder createBinder(javax.portlet.PortletRequest request,
                                                java.lang.Object command)
                                         throws java.lang.Exception
Deprecated. 
Create a new binder instance for the given command and request.

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.

Parameters:
request - current portlet request
command - the command to bind onto
Returns:
the new binder instance
Throws:
java.lang.Exception - in case of invalid state or arguments
See Also:
bindAndValidate(javax.portlet.PortletRequest, java.lang.Object), prepareBinder(org.springframework.web.portlet.bind.PortletRequestDataBinder), initBinder(javax.portlet.PortletRequest, org.springframework.web.portlet.bind.PortletRequestDataBinder)

prepareBinder

protected final void prepareBinder(PortletRequestDataBinder binder)
Deprecated. 
Prepare the given binder, applying the specified MessageCodesResolver, BindingErrorProcessor and PropertyEditorRegistrars (if any). Called by createBinder.

Parameters:
binder - the new binder instance
See Also:
createBinder(javax.portlet.PortletRequest, java.lang.Object), setMessageCodesResolver(org.springframework.validation.MessageCodesResolver), setBindingErrorProcessor(org.springframework.validation.BindingErrorProcessor)

useDirectFieldAccess

protected boolean useDirectFieldAccess()
Deprecated. 
Determine whether to use direct field access instead of bean property access. Applied by prepareBinder.

The default is false. Can be overridden in subclasses.

See Also:
prepareBinder(org.springframework.web.portlet.bind.PortletRequestDataBinder), DataBinder.initDirectFieldAccess()

initBinder

protected void initBinder(javax.portlet.PortletRequest request,
                          PortletRequestDataBinder binder)
                   throws java.lang.Exception
Deprecated. 
Initialize the given binder instance, for example with custom editors. Called by 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.

Parameters:
request - current portlet request
binder - new binder instance
Throws:
java.lang.Exception - in case of invalid state or arguments
See Also:
createBinder(javax.portlet.PortletRequest, java.lang.Object), DataBinder.registerCustomEditor(java.lang.Class, java.beans.PropertyEditor), CustomDateEditor

onBind

protected void onBind(javax.portlet.PortletRequest request,
                      java.lang.Object command,
                      BindException errors)
               throws java.lang.Exception
Deprecated. 
Callback for custom post-processing in terms of binding. Called on each submit, after standard binding but before validation.

The default implementation delegates to onBind(request, command).

Parameters:
request - current portlet request
command - the command object to perform further binding on
errors - validation errors holder, allowing for additional custom registration of binding errors
Throws:
java.lang.Exception - in case of invalid state or arguments
See Also:
bindAndValidate(javax.portlet.PortletRequest, java.lang.Object), onBind(PortletRequest, Object)

onBind

protected void onBind(javax.portlet.PortletRequest request,
                      java.lang.Object command)
               throws java.lang.Exception
Deprecated. 
Callback for custom post-processing in terms of binding. Called by the default implementation of the onBind version with all parameters, after standard binding but before validation.

The default implementation is empty.

Parameters:
request - current portlet request
command - the command object to perform further binding on
Throws:
java.lang.Exception - in case of invalid state or arguments
See Also:
onBind(PortletRequest, Object, BindException)

suppressValidation

protected boolean suppressValidation(javax.portlet.PortletRequest request)
Deprecated. 
Return whether to suppress validation for the given request.

The default implementation always returns false. Can be overridden in subclasses to suppress validation: for example, if a special request parameter is set.

Parameters:
request - current portlet request
Returns:
whether to suppress validation for the given request

onBindAndValidate

protected void onBindAndValidate(javax.portlet.PortletRequest request,
                                 java.lang.Object command,
                                 BindException errors)
                          throws java.lang.Exception
Deprecated. 
Callback for custom post-processing in terms of binding and validation. Called on each submit, after standard binding and validation, but before error evaluation.

The default implementation is empty.

Parameters:
request - current portlet request
command - the command object, still allowing for further binding
errors - validation errors holder, allowing for additional custom validation
Throws:
java.lang.Exception - in case of invalid state or arguments
See Also:
bindAndValidate(javax.portlet.PortletRequest, java.lang.Object), Errors

getRenderCommandSessionAttributeName

protected java.lang.String getRenderCommandSessionAttributeName()
Deprecated. 
Return the name of the session attribute that holds the render phase command object for this form controller.

Returns:
the name of the render phase command object session attribute
See Also:
PortletSession.getAttribute(java.lang.String)

getRenderErrorsSessionAttributeName

protected java.lang.String getRenderErrorsSessionAttributeName()
Deprecated. 
Return the name of the session attribute that holds the render phase command object for this form controller.

Returns:
the name of the render phase command object session attribute
See Also:
PortletSession.getAttribute(java.lang.String)

getRenderCommand

protected final java.lang.Object getRenderCommand(javax.portlet.RenderRequest request)
                                           throws javax.portlet.PortletException
Deprecated. 
Get the command object cached for the render phase.

Throws:
javax.portlet.PortletException
See Also:
getRenderErrors(javax.portlet.RenderRequest), getRenderCommandSessionAttributeName(), setRenderCommandAndErrors(javax.portlet.ActionRequest, java.lang.Object, org.springframework.validation.BindException)

getRenderErrors

protected final BindException getRenderErrors(javax.portlet.RenderRequest request)
                                       throws javax.portlet.PortletException
Deprecated. 
Get the bind and validation errors cached for the render phase.

Throws:
javax.portlet.PortletException
See Also:
getRenderCommand(javax.portlet.RenderRequest), getRenderErrorsSessionAttributeName(), setRenderCommandAndErrors(javax.portlet.ActionRequest, java.lang.Object, org.springframework.validation.BindException)

setRenderCommandAndErrors

protected final void setRenderCommandAndErrors(javax.portlet.ActionRequest request,
                                               java.lang.Object command,
                                               BindException errors)
                                        throws java.lang.Exception
Deprecated. 
Set the command object and errors object for the render phase.

Parameters:
request - the current action request
command - the command object to preserve for the render phase
errors - the errors from binding and validation to preserve for the render phase
Throws:
java.lang.Exception
See Also:
getRenderCommand(javax.portlet.RenderRequest), getRenderErrors(javax.portlet.RenderRequest), getRenderCommandSessionAttributeName(), getRenderErrorsSessionAttributeName()