com.communote.server.web.fe.portal.user.controller

Class AcceptTermsController

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

com.communote.server.web.fe.portal.user.controller.AcceptTermsController

All Implemented Interfaces:

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

public class AcceptTermsController
extends BaseFormController

Controller to accept the terms of use and the privacy policy. Gets a user id from session attribute and shows a form with terms of use and privacy policy.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCEPT_TERMS_SEND value for the hidden form field.
static String	PARAM_SEND param to determine if the form was sent.

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
AcceptTermsController()

Method Summary

Modifier and Type	Method and Description
protected Object	formBackingObject(javax.servlet.http.HttpServletRequest request)
protected 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 BaseFormController.onSubmit(HttpServletRequest, HttpServletResponse, Object, BindException) Submit callback with all parameters.
protected org.springframework.web.servlet.ModelAndView	handleRequestInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	setErrorRedirectTarget(String errorTarget) Sets the error redirect target.
void	setStartpageRegistry(StartpageRegistry startpageRegistry) Set the start-page registry which will be used to resolve the redirect targets if successRedirectTarget or errorRedirectTarget are undefined.
void	setSuccessRedirectTarget(String successTarget) Sets the success redirect target.
void	setTargetUrlParameter(String targetUrlParameter) Name of a request parameter to check for a URL to redirect to instead of the configured static successRedirectTarget or errorRedirectTarget.
protected boolean	suppressValidation(javax.servlet.http.HttpServletRequest request, Object command)

Methods inherited from class com.communote.server.web.commons.controller.BaseFormController

getLocale, initBinder, isRefuseOnExternalAuthentication, onSubmit, onSubmit, onSubmit, setRefuseOnExternalAuthentication, showForm

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

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

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

currentFormObject, getCommand, getErrorsForNewForm, getFormSessionAttributeName, getFormSessionAttributeName, handleInvalidSubmit, 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

Field Detail

ACCEPT_TERMS_SEND

public static final String ACCEPT_TERMS_SEND

value for the hidden form field.

See Also:

Constant Field Values

PARAM_SEND

public static final String PARAM_SEND

param to determine if the form was sent.

See Also:

Constant Field Values

Constructor Detail

AcceptTermsController

public AcceptTermsController()

Method Detail

formBackingObject

protected Object formBackingObject(javax.servlet.http.HttpServletRequest request)
                            throws Exception

Overrides:

formBackingObject in class org.springframework.web.servlet.mvc.AbstractFormController

Throws:

Exception

handleOnSubmit

protected 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

Description copied from class: BaseFormController

Is called by BaseFormController.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 BaseFormController.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.

Specified by:

handleOnSubmit in class BaseFormController

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:

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

handleRequestInternal

protected org.springframework.web.servlet.ModelAndView handleRequestInternal(javax.servlet.http.HttpServletRequest request,
                                                                             javax.servlet.http.HttpServletResponse response)
                                                                      throws Exception

Overrides:

handleRequestInternal in class org.springframework.web.servlet.mvc.AbstractFormController

Throws:

Exception

setErrorRedirectTarget

public void setErrorRedirectTarget(String errorTarget)

Sets the error redirect target.

Parameters:

errorTarget - the new error redirect target

setStartpageRegistry

public void setStartpageRegistry(StartpageRegistry startpageRegistry)

Set the start-page registry which will be used to resolve the redirect targets if successRedirectTarget or errorRedirectTarget are undefined.

Parameters:

startpageRegistry - the registry

setSuccessRedirectTarget

public void setSuccessRedirectTarget(String successTarget)

Sets the success redirect target.

Parameters:

successTarget - the new success redirect target

setTargetUrlParameter

public void setTargetUrlParameter(String targetUrlParameter)

Name of a request parameter to check for a URL to redirect to instead of the configured static successRedirectTarget or errorRedirectTarget.

Parameters:

targetUrlParameter - name of the parameter that holds the target URL. The parameter name is expected to consist only of ASCII alpha-numeric characters.

suppressValidation

protected boolean suppressValidation(javax.servlet.http.HttpServletRequest request,
                                     Object command)

Overrides:

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