public abstract class

AbstractCommandController

extends BaseCommandController

java.lang.Object
↳	org.springframework.context.support.ApplicationObjectSupport
	↳	org.springframework.web.context.support.WebApplicationObjectSupport
		↳	org.springframework.web.servlet.support.WebContentGenerator
			↳	org.springframework.web.servlet.mvc.AbstractController
				↳	org.springframework.web.servlet.mvc.BaseCommandController
					↳	org.springframework.web.servlet.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.

In most cases this command controller should not be used to handle form submission, because functionality for forms is 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.servlet.mvc.BaseCommandController

From class org.springframework.web.servlet.support.WebContentGenerator

[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
abstract ModelAndView	handle(HttpServletRequest request, HttpServletResponse 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.
ModelAndView	handleRequestInternal(HttpServletRequest request, HttpServletResponse response) Template method.

[Expand]

Inherited Methods

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

final ServletRequestDataBinder	bindAndValidate(HttpServletRequest 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.
ServletRequestDataBinder	createBinder(HttpServletRequest 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(HttpServletRequest 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 Validator	getValidator() Return the primary Validator for this controller.
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(HttpServletRequest request, ServletRequestDataBinder 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(HttpServletRequest request, Object command) Callback for custom post-processing in terms of binding.
void	onBind(HttpServletRequest request, Object command, BindException errors) Callback for custom post-processing in terms of binding.
void	onBindAndValidate(HttpServletRequest request, Object command, BindException errors) Callback for custom post-processing in terms of binding and validation.
final void	prepareBinder(ServletRequestDataBinder 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 multiple PropertyEditorRegistrars to be applied to every DataBinder that this controller uses.
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(HttpServletRequest request) Return whether to suppress binding for the given request.
boolean	suppressValidation(HttpServletRequest request, Object command) Return whether to suppress validation for the given request.
boolean	suppressValidation(HttpServletRequest request, Object command, BindException errors) Return whether to suppress validation for the given request.
boolean	suppressValidation(HttpServletRequest request) This method is deprecated. as of Spring 2.0.4, in favor of the `suppressValidation(HttpServletRequest, Object)` variant
boolean	useDirectFieldAccess() Determine whether to use direct field access instead of bean property access.

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

From class org.springframework.web.servlet.support.WebContentGenerator

final void	applyCacheSeconds(HttpServletResponse response, int seconds, boolean mustRevalidate) Apply the given cache seconds and generate respective HTTP headers.
final void	applyCacheSeconds(HttpServletResponse response, int seconds) Apply the given cache seconds and generate corresponding HTTP headers, i.e.
final void	cacheForSeconds(HttpServletResponse response, int seconds, boolean mustRevalidate) Set HTTP headers to allow caching for the given number of seconds.
final void	cacheForSeconds(HttpServletResponse response, int seconds) Set HTTP headers to allow caching for the given number of seconds.
final void	checkAndPrepare(HttpServletRequest request, HttpServletResponse response, int cacheSeconds, boolean lastModified) Check and prepare the given request and response according to the settings of this generator.
final void	checkAndPrepare(HttpServletRequest request, HttpServletResponse response, boolean lastModified) 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 String[]	getSupportedMethods() Return the HTTP methods that this content generator supports.
final boolean	isRequireSession() Return whether a session is required to handle requests.
final boolean	isUseCacheControlHeader() Return whether the HTTP 1.1 cache-control header is used.
final boolean	isUseCacheControlNoStore() Return whether the HTTP 1.1 cache-control header value "no-store" is used.
final boolean	isUseExpiresHeader() Return whether the HTTP 1.0 expires header is used.
final void	preventCaching(HttpServletResponse response) Prevent the 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.
final void	setSupportedMethods(String[] methods) Set the HTTP methods that this content generator should support.
final void	setUseCacheControlHeader(boolean useCacheControlHeader) Set whether to use the HTTP 1.1 cache-control header.
final void	setUseCacheControlNoStore(boolean useCacheControlNoStore) Set whether to use the HTTP 1.1 cache-control header value "no-store" when preventing caching.
final void	setUseExpiresHeader(boolean useExpiresHeader) Set whether to use the HTTP 1.0 expires header.

From class org.springframework.web.context.support.WebApplicationObjectSupport

From class org.springframework.context.support.ApplicationObjectSupport

From class java.lang.Object

From interface org.springframework.context.ApplicationContextAware

From interface org.springframework.web.context.ServletContextAware

From interface org.springframework.web.servlet.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 abstract ModelAndView handle (HttpServletRequest request, HttpServletResponse 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 HTTP request
response	current HTTP response
command	the populated command object
errors	validation errors holder

Returns

a ModelAndView to render, or null if handled directly

Throws

Exception

protected ModelAndView handleRequestInternal (HttpServletRequest request, HttpServletResponse response)

Template method. Subclasses must implement this. The contract is the same as for handleRequest.

Throws

Exception

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 abstract ModelAndView handle (HttpServletRequest request, HttpServletResponse response, Object command, BindException errors)

Parameters

Returns

Throws

See Also

protected ModelAndView handleRequestInternal (HttpServletRequest request, HttpServletResponse response)

Throws