public abstract class

AbstractCommandController

extends BaseCommandController

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
					↳	org.springframework.web.portlet.mvc.AbstractCommandController

This class is deprecated.
as of Spring 3.0, in favor of annotated controllers

Class Overview

Abstract base class for custom command controllers. Autopopulates a command bean from the request. For command validation, a validator (property inherited from BaseCommandController) can be used.

This command controller should preferrable not be used to handle form submission, because functionality for forms is more offered in more detail by the AbstractFormController and its corresponding implementations.

Exposed configuration properties (and those defined by superclass):
none (so only those available in superclass).

Workflow (and that defined by superclass):

Summary

[Expand]

Inherited Constants

From class org.springframework.web.portlet.mvc.BaseCommandController

[Expand]

Inherited Fields

From class org.springframework.context.support.ApplicationObjectSupport

Public Constructors
	AbstractCommandController() Create a new AbstractCommandController.
	AbstractCommandController(Class commandClass) Create a new AbstractCommandController.
	AbstractCommandController(Class commandClass, String commandName) Create a new AbstractCommandController.

Protected Methods
String	getCommandInSessionParameterName() Return the name of the render parameter that indicates there is a valid command (and errors) object in the session.
abstract void	handleAction(ActionRequest request, ActionResponse response, Object command, BindException errors) Template method for request handling, providing a populated and validated instance of the command class, and an Errors object containing binding and validation errors.
final void	handleActionRequestInternal(ActionRequest request, ActionResponse response) Subclasses are meant to override this method if the controller is expected to handle action requests.
abstract ModelAndView	handleRender(RenderRequest request, RenderResponse response, Object command, BindException errors) Template method for render request handling, providing a populated and validated instance of the command class, and an Errors object containing binding and validation errors.
final ModelAndView	handleRenderRequestInternal(RenderRequest request, RenderResponse response) Subclasses are meant to override this method if the controller is expected to handle render requests.
boolean	isCommandInSession(RenderRequest request) Determine if there is a valid command (and errors) object in the session for this render request.
final void	setCommandInSession(ActionResponse response) Set the action response parameter that indicates there is a command (and errors) object in the session for the render phase.

[Expand]

Inherited Methods

From class org.springframework.web.portlet.mvc.BaseCommandController

final PortletRequestDataBinder	bindAndValidate(PortletRequest request, Object command) Bind the parameters of the given request to the given command object.
final boolean	checkCommand(Object command) Check if the given command object is a valid for this controller, i.e.
PortletRequestDataBinder	createBinder(PortletRequest request, Object command) Create a new binder instance for the given command and request.
final Object	createCommand() Create a new command instance for the command class of this controller.
final BindingErrorProcessor	getBindingErrorProcessor() Return the strategy to use for processing binding errors (if any).
Object	getCommand(PortletRequest request) Retrieve a command object for the given request.
final Class	getCommandClass() Return the command class for this controller.
final String	getCommandName() Return the name of the command in the model.
final MessageCodesResolver	getMessageCodesResolver() Return the strategy to use for resolving errors into message codes (if any).
final PropertyEditorRegistrar[]	getPropertyEditorRegistrars() Return the PropertyEditorRegistrars (if any) to be applied to every DataBinder that this controller uses.
final Object	getRenderCommand(RenderRequest request) Get the command object cached for the render phase.
String	getRenderCommandSessionAttributeName() Return the name of the session attribute that holds the render phase command object for this form controller.
final BindException	getRenderErrors(RenderRequest request) Get the bind and validation errors cached for the render phase.
String	getRenderErrorsSessionAttributeName() Return the name of the session attribute that holds the render phase command object for this form controller.
final Validator	getValidator()
final Validator[]	getValidators() Return the Validators for this controller.
final WebBindingInitializer	getWebBindingInitializer() Return the WebBindingInitializer (if any) which will apply pre-configured configuration to every DataBinder that this controller uses.
void	initApplicationContext() Subclasses can override this for custom initialization behavior.
void	initBinder(PortletRequest request, PortletRequestDataBinder binder) Initialize the given binder instance, for example with custom editors.
final boolean	isValidateOnBinding() Return if the Validator should get applied when binding.
void	onBind(PortletRequest request, Object command) Callback for custom post-processing in terms of binding.
void	onBind(PortletRequest request, Object command, BindException errors) Callback for custom post-processing in terms of binding.
void	onBindAndValidate(PortletRequest request, Object command, BindException errors) Callback for custom post-processing in terms of binding and validation.
final void	prepareBinder(PortletRequestDataBinder binder) Prepare the given binder, applying the specified MessageCodesResolver, BindingErrorProcessor and PropertyEditorRegistrars (if any).
final void	setBindingErrorProcessor(BindingErrorProcessor bindingErrorProcessor) Set the strategy to use for processing binding errors, that is, required field errors and `PropertyAccessException`s.
final void	setCommandClass(Class commandClass) Set the command class for this controller.
final void	setCommandName(String commandName) Set the name of the command in the model.
final void	setMessageCodesResolver(MessageCodesResolver messageCodesResolver) Set the strategy to use for resolving errors into message codes.
final void	setPropertyEditorRegistrar(PropertyEditorRegistrar propertyEditorRegistrar) Specify a single PropertyEditorRegistrar to be applied to every DataBinder that this controller uses.
final void	setPropertyEditorRegistrars(PropertyEditorRegistrar[] propertyEditorRegistrars) Specify one or more PropertyEditorRegistrars to be applied to every DataBinder that this controller uses.
final void	setRenderCommandAndErrors(ActionRequest request, Object command, BindException errors) Set the command object and errors object for the render phase.
final void	setValidateOnBinding(boolean validateOnBinding) Set if the Validator should get applied when binding.
final void	setValidator(Validator validator) Set the primary Validator for this controller.
final void	setValidators(Validator[] validators) Set the Validators for this controller.
final void	setWebBindingInitializer(WebBindingInitializer webBindingInitializer) Specify a WebBindingInitializer which will apply pre-configured configuration to every DataBinder that this controller uses.
boolean	suppressBinding(PortletRequest request) Return whether to suppress binding for the given request.
boolean	suppressValidation(PortletRequest request) Return whether to suppress validation for the given request.
boolean	useDirectFieldAccess() Determine whether to use direct field access instead of bean property access.

From class org.springframework.web.portlet.mvc.AbstractController

void	handleActionRequest(ActionRequest request, ActionResponse response) Process the action request.
void	handleActionRequestInternal(ActionRequest request, ActionResponse response) Subclasses are meant to override this method if the controller is expected to handle action requests.
ModelAndView	handleRenderRequest(RenderRequest request, RenderResponse response) Process the render request and return a ModelAndView object which the DispatcherPortlet will render.
ModelAndView	handleRenderRequestInternal(RenderRequest request, RenderResponse response) Subclasses are meant to override this method if the controller is expected to handle render requests.
final boolean	isRenderWhenMinimized() Return whether controller will render when portlet is minimized.
final boolean	isSynchronizeOnSession() Return whether controller execution should be synchronized on the session.
final void	setRenderWhenMinimized(boolean renderWhenMinimized) Set if the controller should render an view when the portlet is in a minimized window.
final void	setSynchronizeOnSession(boolean synchronizeOnSession) Set if controller execution should be synchronized on the session, to serialize parallel invocations from the same client.

From class org.springframework.web.portlet.handler.PortletContentGenerator

final void	applyCacheSeconds(MimeResponse response, int seconds) Apply the given cache seconds to the render response
final void	cacheForSeconds(MimeResponse response, int seconds) Set portlet response to allow caching for the given number of seconds.
final void	check(PortletRequest request, PortletResponse response) Check and prepare the given request and response according to the settings of this generator.
final void	checkAndPrepare(PortletRequest request, MimeResponse response) Check and prepare the given request and response according to the settings of this generator.
final void	checkAndPrepare(PortletRequest request, MimeResponse response, int cacheSeconds) Check and prepare the given request and response according to the settings of this generator.
final int	getCacheSeconds() Return the number of seconds that content is cached.
final boolean	isRequireSession() Return whether a session is required to handle requests.
final void	preventCaching(MimeResponse response) Prevent the render response from being cached.
final void	setCacheSeconds(int seconds) Cache content for the given number of seconds.
final void	setRequireSession(boolean requireSession) Set whether a session should be required to handle requests.

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

Public Constructors

public AbstractCommandController ()

Create a new AbstractCommandController.

public AbstractCommandController (Class commandClass)

Create a new AbstractCommandController.

Parameters

commandClass	class of the command bean

public AbstractCommandController (Class commandClass, String commandName)

Create a new AbstractCommandController.

Parameters

commandClass	class of the command bean
commandName	name of the command bean

Protected Methods

protected String getCommandInSessionParameterName ()

Return the name of the render parameter that indicates there is a valid command (and errors) object in the session.

Returns

the name of the render parameter

protected abstract void handleAction (ActionRequest request, ActionResponse response, Object command, BindException errors)

Template method for request handling, providing a populated and validated instance of the command class, and an Errors object containing binding and validation errors.

Call errors.getModel() to populate the ModelAndView model with the command and the Errors instance, under the specified command name, as expected by the "spring:bind" tag.

Parameters

request	current action request
response	current action response
command	the populated command object
errors	validation errors holder

Throws

Exception

protected final void handleActionRequestInternal (ActionRequest request, ActionResponse response)

Subclasses are meant to override this method if the controller is expected to handle action requests. The contract is the same as for handleActionRequest.

The default implementation throws a PortletException.

Throws

Exception

protected abstract ModelAndView handleRender (RenderRequest request, RenderResponse response, Object command, BindException errors)

Template method for render request handling, providing a populated and validated instance of the command class, and an Errors object containing binding and validation errors.

Call errors.getModel() to populate the ModelAndView model with the command and the Errors instance, under the specified command name, as expected by the "spring:bind" tag.

Parameters

request	current render request
response	current render response
command	the populated command object
errors	validation errors holder

Returns

a ModelAndView to render, or null if handled directly

Throws

Exception

protected final ModelAndView handleRenderRequestInternal (RenderRequest request, RenderResponse response)

Subclasses are meant to override this method if the controller is expected to handle render requests. The contract is the same as for handleRenderRequest.

The default implementation throws a PortletException.

Throws

Exception

protected boolean isCommandInSession (RenderRequest request)

Determine if there is a valid command (and errors) object in the session for this render request.

Parameters

request	current render request

Returns

if there is a valid command object in the session

protected final void setCommandInSession (ActionResponse response)

Set the action response parameter that indicates there is a command (and errors) object in the session for the render phase.

Parameters

response	the current action response

Interfaces

Classes

AbstractCommandController

Class Overview

See Also

Summary

Public Constructors

public AbstractCommandController ()

public AbstractCommandController (Class commandClass)

Parameters

public AbstractCommandController (Class commandClass, String commandName)

Parameters

Protected Methods

protected String getCommandInSessionParameterName ()

Returns

See Also

protected abstract void handleAction (ActionRequest request, ActionResponse response, Object command, BindException errors)

Parameters

Throws

See Also

protected final void handleActionRequestInternal (ActionRequest request, ActionResponse response)

Throws

protected abstract ModelAndView handleRender (RenderRequest request, RenderResponse response, Object command, BindException errors)

Parameters

Returns

Throws

See Also

protected final ModelAndView handleRenderRequestInternal (RenderRequest request, RenderResponse response)

Throws

protected boolean isCommandInSession (RenderRequest request)

Parameters

Returns

See Also

protected final void setCommandInSession (ActionResponse response)

Parameters

See Also