org.openmrs.web.controller

Class OptionsFormController

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

org.openmrs.web.controller.OptionsFormController

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 OptionsFormController
extends org.springframework.web.servlet.mvc.SimpleFormController

This is the controller for the "My Profile" page. This lets logged in users set personal preferences, update their own information, etc.

See Also:

OptionsForm

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log Logger for this class and subclasses

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

Method Summary

Modifier and Type	Method and Description
protected Object	formBackingObject(javax.servlet.http.HttpServletRequest request) This is called prior to displaying a form for the first time.
protected org.springframework.web.servlet.ModelAndView	onSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object obj, org.springframework.validation.BindException errors) The onSubmit function receives the form/command object that was modified by the input form and saves it to the db
protected org.springframework.web.servlet.ModelAndView	processFormSubmission(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object object, org.springframework.validation.BindException errors) This implementation calls SimpleFormController.showForm(HttpServletRequest, HttpServletResponse, BindException) in case of errors, and delegates to the full SimpleFormController.onSubmit(HttpServletRequest, HttpServletResponse, Object, BindException)'s variant else.
protected Map<String,Object>	referenceData(javax.servlet.http.HttpServletRequest request) Called prior to form display.

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

doSubmitAction, getFormView, getSuccessView, isFormChangeRequest, isFormChangeRequest, onFormChange, onFormChange, onSubmit, onSubmit, referenceData, setFormView, setSuccessView, showForm, 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, initBinder, 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

log

protected final org.apache.commons.logging.Log log

Logger for this class and subclasses

Constructor Detail

OptionsFormController

public OptionsFormController()

Method Detail

processFormSubmission

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

Description copied from class: org.springframework.web.servlet.mvc.SimpleFormController

This implementation calls SimpleFormController.showForm(HttpServletRequest, HttpServletResponse, BindException) in case of errors, and delegates to the full SimpleFormController.onSubmit(HttpServletRequest, HttpServletResponse, Object, BindException)'s variant else.

This can only be overridden to check for an action that should be executed without respect to binding errors, like a cancel action. To just handle successful submissions without binding errors, override one of the onSubmit methods or SimpleFormController.doSubmitAction(java.lang.Object).

Overrides:

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

Parameters:

request - current servlet request

response - current servlet response

object - form object with request parameters bound onto it

errors - holder 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:

AbstractFormController.processFormSubmission(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Object, org.springframework.validation.BindException)

onSubmit

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

The onSubmit function receives the form/command object that was modified by the input form and saves it to the db

Overrides:

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

Parameters:

request - current servlet request

response - current servlet response

obj - 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:

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

Expected Behavior:

Should accept 2 characters as username

Should accept email address as username if enabled

Should reject 1 character as username

Should reject invalid email address as username if enabled

formBackingObject

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

This is called prior to displaying a form for the first time. It tells Spring the form/command object to load into the request

Overrides:

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

Parameters:

request - current HTTP request

Returns:

the backing object

Throws:

javax.servlet.ServletException

See Also:

AbstractFormController.formBackingObject(javax.servlet.http.HttpServletRequest)

referenceData

protected Map<String,Object> referenceData(javax.servlet.http.HttpServletRequest request)
                                    throws Exception

Called prior to form display. Allows for data to be put in the request to be used in the view

Overrides:

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

Parameters:

request - current HTTP request

Returns:

a Map with reference data entries, or null if none

Throws:

Exception - in case of invalid state or arguments

See Also:

SimpleFormController.referenceData(javax.servlet.http.HttpServletRequest)