org.appfuse.webapp.controller
Class BaseFormController

java.lang.Object
  org.appfuse.webapp.controller.BaseFormController

All Implemented Interfaces:

org.springframework.web.context.ServletContextAware

Direct Known Subclasses:

FileUploadController, SignupController, UserFormController

public class BaseFormController
extends java.lang.Object
implements org.springframework.web.context.ServletContextAware

Implementation of SimpleFormController that contains convenience methods for subclasses. For example, getting the current user and saving messages/errors. This class is intended to be a base class for all Form controllers.

View Source

Author:

Matt Raible

Field Summary

protected java.lang.String	cancelView
protected org.apache.commons.logging.Log	log
protected MailEngine	mailEngine
protected org.springframework.mail.SimpleMailMessage	message
static java.lang.String	MESSAGES_KEY
protected java.lang.String	successView
protected java.lang.String	templateName

Constructor Summary

BaseFormController()

Method Summary

java.lang.String	getCancelView()
java.util.Map	getConfiguration() Convenience method to get the Configuration HashMap from the servlet context.
protected javax.servlet.ServletContext	getServletContext()
java.lang.String	getSuccessView()
java.lang.String	getText(java.lang.String msgKey, java.util.Locale locale) Convenience method for getting a i18n key's value.
java.lang.String	getText(java.lang.String msgKey, java.lang.Object[] args, java.util.Locale locale) Convenience method for getting a i18n key's value with arguments.
java.lang.String	getText(java.lang.String msgKey, java.lang.String arg, java.util.Locale locale) Convenient method for getting a i18n key's value with a single string argument.
UserManager	getUserManager()
protected void	initBinder(javax.servlet.http.HttpServletRequest request, org.springframework.web.bind.ServletRequestDataBinder binder) Set up a custom property editor for converting form inputs to real objects
void	saveError(javax.servlet.http.HttpServletRequest request, java.lang.String error)
void	saveMessage(javax.servlet.http.HttpServletRequest request, java.lang.String msg)
protected void	sendUserMessage(User user, java.lang.String msg, java.lang.String url) Convenience message to send messages to users, includes app URL as footer.
BaseFormController	setCancelView(java.lang.String cancelView)
void	setMailEngine(MailEngine mailEngine)
void	setMessage(org.springframework.mail.SimpleMailMessage message)
void	setMessages(org.springframework.context.MessageSource messageSource)
void	setServletContext(javax.servlet.ServletContext servletContext)
BaseFormController	setSuccessView(java.lang.String successView)
void	setTemplateName(java.lang.String templateName)
void	setUserManager(UserManager userManager)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

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

MESSAGES_KEY

public static final java.lang.String MESSAGES_KEY

See Also:

Constant Field Values

mailEngine

protected MailEngine mailEngine

message

protected org.springframework.mail.SimpleMailMessage message

templateName

protected java.lang.String templateName

cancelView

protected java.lang.String cancelView

successView

protected java.lang.String successView

Constructor Detail

BaseFormController

public BaseFormController()

Method Detail

setMessages

public void setMessages(org.springframework.context.MessageSource messageSource)

setUserManager

public void setUserManager(UserManager userManager)

getUserManager

public UserManager getUserManager()

saveError

public void saveError(javax.servlet.http.HttpServletRequest request,
                      java.lang.String error)

saveMessage

public void saveMessage(javax.servlet.http.HttpServletRequest request,
                        java.lang.String msg)

getText

public java.lang.String getText(java.lang.String msgKey,
                                java.util.Locale locale)

Convenience method for getting a i18n key's value. Calling getMessageSourceAccessor() is used because the RequestContext variable is not set in unit tests b/c there's no DispatchServlet Request.

Parameters:

msgKey -

locale - the current locale

Returns:

getText

public java.lang.String getText(java.lang.String msgKey,
                                java.lang.String arg,
                                java.util.Locale locale)

Convenient method for getting a i18n key's value with a single string argument.

Parameters:

msgKey -

arg -

locale - the current locale

Returns:

getText

public java.lang.String getText(java.lang.String msgKey,
                                java.lang.Object[] args,
                                java.util.Locale locale)

Convenience method for getting a i18n key's value with arguments.

Parameters:

msgKey -

args -

locale - the current locale

Returns:

getConfiguration

public java.util.Map getConfiguration()

Convenience method to get the Configuration HashMap from the servlet context.

Returns:

the user's populated form from the session

initBinder

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

Set up a custom property editor for converting form inputs to real objects

Parameters:

request - the current request

binder - the data binder

sendUserMessage

protected void sendUserMessage(User user,
                               java.lang.String msg,
                               java.lang.String url)

Convenience message to send messages to users, includes app URL as footer.

Parameters:

user - the user to send a message to.

msg - the message to send.

url - the URL of the application.

setMailEngine

public void setMailEngine(MailEngine mailEngine)

setMessage

public void setMessage(org.springframework.mail.SimpleMailMessage message)

setTemplateName

public void setTemplateName(java.lang.String templateName)

setCancelView

public final BaseFormController setCancelView(java.lang.String cancelView)

getCancelView

public final java.lang.String getCancelView()

getSuccessView

public final java.lang.String getSuccessView()

setSuccessView

public final BaseFormController setSuccessView(java.lang.String successView)

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

Specified by:

setServletContext in interface org.springframework.web.context.ServletContextAware

getServletContext

protected javax.servlet.ServletContext getServletContext()