Package ubic.gemma.web.controller

Class BaseController

java.lang.Object

ubic.gemma.web.controller.BaseController

Direct Known Subclasses:

BibliographicReferenceControllerImpl, CompositeSequenceController, ExperimentalDesignControllerImpl, ExpressionExperimentQCController, ExpressionExperimentSetController, GeneController, PhenotypeController, PubMedQueryControllerImpl, SignupController, UserFormMultiActionController

public abstract class BaseController
extends Object

Extend this to create a simple Single or MultiActionController; includes configuration for sending email and setting messages in the session. Use the \@Controller and \@RequestMapping annotations to configure subclasses.

Author:

keshav

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor	Description
BaseController()

Method Summary

Modifier and Type	Method	Description
protected void	addMessage(javax.servlet.http.HttpServletRequest request, String messageCode, Object[] parameters)
protected MessageUtil	getMessageUtil()
protected String	getText(String msgKey, Object[] args, Locale locale)
protected String	getText(String msgKey, Locale locale)
protected void	saveMessage(javax.servlet.http.HttpServletRequest request, String msg)
protected void	saveMessage(javax.servlet.http.HttpServletRequest request, String key, Object parameter, String defaultMessage)
protected void	sendConfirmationEmail(javax.servlet.http.HttpServletRequest request, String token, String username, String email, Map<String,Object> model, String templateName)
void	setMailEngine(ubic.gemma.persistence.util.MailEngine mailEngine)
void	setMessageSource(MessageSource messageSource)
void	setMessageUtil(MessageUtil messageUtil)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.apache.commons.logging.Log log

Constructor Detail

BaseController

public BaseController()

Method Detail

setMailEngine

public void setMailEngine(ubic.gemma.persistence.util.MailEngine mailEngine)

setMessageSource

public void setMessageSource(MessageSource messageSource)

addMessage

protected void addMessage(javax.servlet.http.HttpServletRequest request,
                          String messageCode,
                          Object[] parameters)

Parameters:

messageCode - - if no message is found, this is used to form the message (instead of throwing an exception).

getMessageUtil

protected MessageUtil getMessageUtil()

Returns:

the messageUtil

setMessageUtil

public void setMessageUtil(MessageUtil messageUtil)

Parameters:

messageUtil - the messageUtil to set

getText

protected String getText(String msgKey,
                         Locale locale)

See Also:

MessageUtilImpl.getText(java.lang.String, java.util.Locale)

getText

protected String getText(String msgKey,
                         Object[] args,
                         Locale locale)

saveMessage

protected void saveMessage(javax.servlet.http.HttpServletRequest request,
                           String msg)

saveMessage

protected void saveMessage(javax.servlet.http.HttpServletRequest request,
                           String key,
                           Object parameter,
                           String defaultMessage)

sendConfirmationEmail

protected void sendConfirmationEmail(javax.servlet.http.HttpServletRequest request,
                                     String token,
                                     String username,
                                     String email,
                                     Map<String,Object> model,
                                     String templateName)