com.communote.server.web.fe.portal.user.system.communication

Class MailInController

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.system.communication.MailInController

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 MailInController
extends BaseFormController

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_SAVE Action to save form input.
static String	ACTION_START_SERVICE Action to start the service.
static String	ACTION_STOP_SERVICE Action to stop the service.
static String	ACTION_TEST Action to test mail fetching.
static String	MODE_MULTI Mailfetching is multi address mode.
static String	MODE_SINGLE Mailfetching is in single address mode.

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

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.
void	setForcedMode(String mode) Restrict the available modes in the form to single or multi mode.

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

MODE_SINGLE

public static final String MODE_SINGLE

Mailfetching is in single address mode.

See Also:

Constant Field Values

MODE_MULTI

public static final String MODE_MULTI

Mailfetching is multi address mode.

See Also:

Constant Field Values

ACTION_SAVE

public static final String ACTION_SAVE

Action to save form input.

See Also:

Constant Field Values

ACTION_TEST

public static final String ACTION_TEST

Action to test mail fetching.

See Also:

Constant Field Values

ACTION_START_SERVICE

public static final String ACTION_START_SERVICE

Action to start the service.

See Also:

Constant Field Values

ACTION_STOP_SERVICE

public static final String ACTION_STOP_SERVICE

Action to stop the service.

See Also:

Constant Field Values

Constructor Detail

MailInController

public MailInController()

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

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

setForcedMode

public void setForcedMode(String mode)

Restrict the available modes in the form to single or multi mode.

Parameters:

mode - one of the MODE_ constants