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

Class AbstractUserInviteController

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.client.controller.AbstractUserInviteController

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:

BlogMemberInviteController, InviteUserToClientController

public abstract class AbstractUserInviteController
extends BaseFormController

Abstract Controller to invite a user

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_INVITATION_FIELDS request attribute for the invitation fields.

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

Method Summary

Modifier and Type	Method and Description
protected Object	formBackingObject(javax.servlet.http.HttpServletRequest request)
protected String	getAliasErrorField(List<String> availableFields)
protected String	getEmailErrorField(List<String> availableFields)
protected List<String>	getErrorFields(String invitationProvider)
protected String	getExternalUsernameErrorField(List<String> availableFields)
protected org.springframework.web.servlet.ModelAndView	getModelAndView(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object command, org.springframework.validation.BindException errors) Get the model and view to show.
protected UserManagement	getUserManagement() returns the user management service
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 abstract InviteUserForm	internalFormBackingObject(javax.servlet.http.HttpServletRequest request) see formBackingObject(HttpServletRequest)
protected abstract boolean	inviteUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, InviteUserForm abstractForm, org.springframework.validation.BindException errors, UserVO userToInvite) Invite the given user.
protected void	validateForm(InviteUserForm form, org.springframework.validation.Errors errors) Validate the given form based on the expected invitation fields.

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, suppressValidation

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

currentFormObject, 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

Field Detail

ATTR_INVITATION_FIELDS

public static final String ATTR_INVITATION_FIELDS

request attribute for the invitation fields. The value is a list of strings with the possible names of InvitationField

See Also:

Constant Field Values

Constructor Detail

AbstractUserInviteController

public AbstractUserInviteController()

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

getAliasErrorField

protected String getAliasErrorField(List<String> availableFields)

Parameters:

availableFields - all error fields

Returns:

the error field matching the alias best

getEmailErrorField

protected String getEmailErrorField(List<String> availableFields)

Parameters:

availableFields - all error fields

Returns:

the error field matching the email best

getErrorFields

protected List<String> getErrorFields(String invitationProvider)

Parameters:

invitationProvider - Identifier of the invitation provider.

Returns:

the list of all error fields for the current invitation provider

getExternalUsernameErrorField

protected String getExternalUsernameErrorField(List<String> availableFields)

Parameters:

availableFields - all error fields

Returns:

the error field matching the external username best

getModelAndView

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

Get the model and view to show. Is called after the invitation has been made (or errors occurred).

Parameters:

request - the request

response - the response

command - the command

errors - the error

Returns:

the ModelAndView to show

Throws:

Exception - in case of an error

getUserManagement

protected UserManagement getUserManagement()

returns the user management service

Returns:

the user management service

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

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

See Also:

com.communote.server.web.commons.controller.BaseFormController#handleOnSubmit(javax.servlet .http.HttpServletRequest, javax.servlet.http.HttpServletResponse, Object, org.springframework.validation.BindException)

internalFormBackingObject

protected abstract InviteUserForm internalFormBackingObject(javax.servlet.http.HttpServletRequest request)
                                                     throws Exception

see formBackingObject(HttpServletRequest)

Parameters:

request - the request

Returns:

the command object

Throws:

Exception - in case of an error

inviteUser

protected abstract boolean inviteUser(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response,
                                      InviteUserForm abstractForm,
                                      org.springframework.validation.BindException errors,
                                      UserVO userToInvite)
                               throws Exception

Invite the given user. Depends on the semantics of the sub class.

Parameters:

request - the request

response - the response

abstractForm - the invite form

errors - the binding errors

userToInvite - the user that should be invited

Returns:

true if the invitation was successfull

Throws:

Exception - in case of an error

validateForm

protected void validateForm(InviteUserForm form,
                            org.springframework.validation.Errors errors)

Validate the given form based on the expected invitation fields.

Parameters:

form - the form to validate

errors - the errors