com.communote.server.web.commons.controller

Class BaseFormController

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.AbstractFormController

org.springframework.web.servlet.mvc.SimpleFormController

com.communote.server.web.commons.controller.BaseFormController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller

Direct Known Subclasses:

AbstractUserInviteController, AcceptTermsController, AddUpdateIPRangeController, AuthenticationController, BlogManagementController, CacheInvalidationController, ClientConfluenceAuthConfigController, ClientGeneralSettingsController, ClientLdapAuthenticationController, ClientPermissionsController, ClientProfileController, ClientUserManagementSettingsController, FileStorageController, FileUploadController, ForgottenPWController, FormViewController, IntegrationOverviewController, MailInController, MailOutController, ServerController, SslChannelConfigurationController, UserManagementUserProfileController, UserProfileChangeEmailController, UserProfileDetailsController, UserProfileNotificationsController, VirusScanningController, XmppAdvancedController, XmppController

public abstract class BaseFormController
extends org.springframework.web.servlet.mvc.SimpleFormController

Basic class for Communote controllers with forms. One task is to replace the MODULE in a tiles defs name with the current active module.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields inherited from class org.springframework.web.servlet.mvc.BaseCommandController

DEFAULT_COMMAND_NAME

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

METHOD_GET, METHOD_HEAD, METHOD_POST

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Constructor Summary

Constructors

Constructor and Description
BaseFormController()

Method Summary

Modifier and Type	Method and Description
protected Locale	getLocale(javax.servlet.http.HttpServletRequest request)
protected abstract org.springframework.web.servlet.ModelAndView	handleOnSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object command, org.springframework.validation.BindException errors) Is called by onSubmit(HttpServletRequest, HttpServletResponse, Object, BindException) Submit callback with all parameters.
protected void	initBinder(javax.servlet.http.HttpServletRequest request, org.springframework.web.bind.ServletRequestDataBinder binder) Override to disable autogrowth.
boolean	isRefuseOnExternalAuthentication() Returns true if the access to this form is not allowed on activated external authentiaction e.g.
protected org.springframework.web.servlet.ModelAndView	onSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object command, org.springframework.validation.BindException errors)
protected org.springframework.web.servlet.ModelAndView	onSubmit(Object command) Is final to avoid inheriting subclasse.
protected org.springframework.web.servlet.ModelAndView	onSubmit(Object command, org.springframework.validation.BindException errors) Is final to avoid inheriting subclasse.
void	setRefuseOnExternalAuthentication(boolean redirectOnExternalAuthentication) If the form is refused on activated external authentication, the user will be redirected to the portal home page.
protected org.springframework.web.servlet.ModelAndView	showForm(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.validation.BindException errors)

Methods inherited from class org.springframework.web.servlet.mvc.SimpleFormController

doSubmitAction, getFormView, getSuccessView, isFormChangeRequest, isFormChangeRequest, onFormChange, onFormChange, processFormSubmission, referenceData, referenceData, setFormView, setSuccessView, showForm, suppressValidation

Methods inherited from class org.springframework.web.servlet.mvc.AbstractFormController

currentFormObject, formBackingObject, getCommand, getErrorsForNewForm, getFormSessionAttributeName, getFormSessionAttributeName, handleInvalidSubmit, handleRequestInternal, isBindOnNewForm, isFormSubmission, isSessionForm, onBindOnNewForm, onBindOnNewForm, setBindOnNewForm, setSessionForm, showForm, showForm, showNewForm

Methods inherited from class org.springframework.web.servlet.mvc.BaseCommandController

bindAndValidate, checkCommand, createBinder, createCommand, getBindingErrorProcessor, getCommandClass, getCommandName, getMessageCodesResolver, getPropertyEditorRegistrars, getValidator, getValidators, getWebBindingInitializer, initApplicationContext, isValidateOnBinding, onBind, onBind, onBindAndValidate, prepareBinder, setBindingErrorProcessor, setCommandClass, setCommandName, setMessageCodesResolver, setPropertyEditorRegistrar, setPropertyEditorRegistrars, setValidateOnBinding, setValidator, setValidators, setWebBindingInitializer, suppressBinding, suppressValidation, suppressValidation, useDirectFieldAccess

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setAlwaysMustRevalidate, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

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

Constructor Detail

BaseFormController

public BaseFormController()

Method Detail

getLocale

protected Locale getLocale(javax.servlet.http.HttpServletRequest request)

Parameters:

request - the request

Returns:

the locale of the current user. will never be null

handleOnSubmit

protected abstract org.springframework.web.servlet.ModelAndView handleOnSubmit(javax.servlet.http.HttpServletRequest request,
                                                                               javax.servlet.http.HttpServletResponse response,
                                                                               Object command,
                                                                               org.springframework.validation.BindException errors)
                                                                        throws Exception

Is called by onSubmit(HttpServletRequest, HttpServletResponse, Object, BindException)
Submit 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 onSubmit(Object, BindException). For simply performing a submit action and rendering the specified success view, consider implementing SimpleFormController.doSubmitAction(java.lang.Object) rather than an onSubmit variant.

Subclasses can override this to provide custom submission handling like storing the object to the database. Implementations can also perform custom validation and call showForm to return to the form. Do not implement multiple onSubmit 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.

Parameters:

request - current servlet request

response - current servlet response

command - form object with request parameters bound onto it

errors - Errors instance without errors (subclass can add errors if it wants to)

Returns:

the prepared model and view, or null

Throws:

Exception - in case of errors

See Also:

onSubmit(Object, BindException), SimpleFormController.doSubmitAction(java.lang.Object), showForm(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.springframework.validation.BindException), Errors, BindException.getModel()

initBinder

protected void initBinder(javax.servlet.http.HttpServletRequest request,
                          org.springframework.web.bind.ServletRequestDataBinder binder)
                   throws Exception

Override to disable autogrowth.

Overrides:

initBinder in class org.springframework.web.servlet.mvc.BaseCommandController

Throws:

Exception

isRefuseOnExternalAuthentication

public boolean isRefuseOnExternalAuthentication()

Returns true if the access to this form is not allowed on activated external authentiaction e.g. LDAP

Returns:

the refuseOnExternalAuthentication

onSubmit

protected org.springframework.web.servlet.ModelAndView onSubmit(javax.servlet.http.HttpServletRequest request,
                                                                javax.servlet.http.HttpServletResponse response,
                                                                Object command,
                                                                org.springframework.validation.BindException errors)
                                                         throws Exception

Overrides:

onSubmit in class org.springframework.web.servlet.mvc.SimpleFormController

Throws:

Exception

onSubmit

protected final org.springframework.web.servlet.ModelAndView onSubmit(Object command)
                                                               throws Exception

Is final to avoid inheriting subclasse. They should use handleOnSubmit(HttpServletRequest, HttpServletResponse, Object, BindException) instead.

Overrides:

onSubmit in class org.springframework.web.servlet.mvc.SimpleFormController

Throws:

Exception

onSubmit

protected final org.springframework.web.servlet.ModelAndView onSubmit(Object command,
                                                                      org.springframework.validation.BindException errors)
                                                               throws Exception

Is final to avoid inheriting subclasse. They should use handleOnSubmit(HttpServletRequest, HttpServletResponse, Object, BindException) instead.

Overrides:

onSubmit in class org.springframework.web.servlet.mvc.SimpleFormController

Throws:

Exception

setRefuseOnExternalAuthentication

public void setRefuseOnExternalAuthentication(boolean redirectOnExternalAuthentication)

If the form is refused on activated external authentication, the user will be redirected to the portal home page.

Parameters:

redirectOnExternalAuthentication - the redirectOnExternalAuthentication to set

showForm

protected org.springframework.web.servlet.ModelAndView showForm(javax.servlet.http.HttpServletRequest request,
                                                                javax.servlet.http.HttpServletResponse response,
                                                                org.springframework.validation.BindException errors)
                                                         throws Exception

Overrides:

showForm in class org.springframework.web.servlet.mvc.SimpleFormController

Throws:

Exception

See Also:

SimpleFormController.showForm(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.springframework.validation.BindException)