org.appfuse.webapp.action
Class BaseAction

java.lang.Object
  com.opensymphony.xwork2.ActionSupport
      org.appfuse.webapp.action.BaseAction

All Implemented Interfaces:

com.opensymphony.xwork2.Action, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, com.opensymphony.xwork2.ValidationAware, java.io.Serializable

Direct Known Subclasses:

FileUploadAction, PasswordHintAction, ReloadAction, SignupAction, UserAction

public class BaseAction
extends com.opensymphony.xwork2.ActionSupport

Implementation of ActionSupport 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 Action classes.

View Source

Author:

Matt Raible

See Also:

Serialized Form

Field Summary

protected java.lang.String	cancel
static java.lang.String	CANCEL
protected java.lang.String	delete
protected java.lang.String	from
protected org.apache.commons.logging.Log	log
protected org.appfuse.service.MailEngine	mailEngine
protected org.springframework.mail.SimpleMailMessage	message
protected org.appfuse.service.RoleManager	roleManager
protected java.lang.String	save
protected java.lang.String	templateName
protected org.appfuse.service.UserManager	userManager

Fields inherited from class com.opensymphony.xwork2.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

BaseAction()

Method Summary

java.lang.String	cancel()
protected java.util.Map	getConfiguration() Convenience method to get the Configuration HashMap from the servlet context.
protected javax.servlet.http.HttpServletRequest	getRequest() Convenience method to get the request
protected javax.servlet.http.HttpServletResponse	getResponse() Convenience method to get the response
protected javax.servlet.http.HttpSession	getSession() Convenience method to get the session
protected void	saveMessage(java.lang.String msg)
protected void	sendUserMessage(org.appfuse.model.User user, java.lang.String msg, java.lang.String url)
void	setDelete(java.lang.String delete)
void	setFrom(java.lang.String from) Convenience method for setting a "from" parameter to indicate the previous page.
void	setMailEngine(org.appfuse.service.MailEngine mailEngine)
void	setMessage(org.springframework.mail.SimpleMailMessage message)
void	setRoleManager(org.appfuse.service.RoleManager roleManager)
void	setSave(java.lang.String save)
void	setTemplateName(java.lang.String templateName)
void	setUserManager(org.appfuse.service.UserManager userManager)

Methods inherited from class com.opensymphony.xwork2.ActionSupport

addActionError, addActionMessage, addFieldError, clearErrorsAndMessages, clone, execute, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getLocale, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, input, pause, setActionErrors, setActionMessages, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Field Detail

CANCEL

public static final java.lang.String CANCEL

See Also:

Constant Field Values

log

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

userManager

protected org.appfuse.service.UserManager userManager

roleManager

protected org.appfuse.service.RoleManager roleManager

from

protected java.lang.String from

cancel

protected java.lang.String cancel

delete

protected java.lang.String delete

save

protected java.lang.String save

mailEngine

protected org.appfuse.service.MailEngine mailEngine

message

protected org.springframework.mail.SimpleMailMessage message

templateName

protected java.lang.String templateName

Constructor Detail

BaseAction

public BaseAction()

Method Detail

cancel

public java.lang.String cancel()

saveMessage

protected void saveMessage(java.lang.String msg)

getConfiguration

protected java.util.Map getConfiguration()

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

Returns:

the user's populated form from the session

getRequest

protected javax.servlet.http.HttpServletRequest getRequest()

Convenience method to get the request

Returns:

current request

getResponse

protected javax.servlet.http.HttpServletResponse getResponse()

Convenience method to get the response

Returns:

current response

getSession

protected javax.servlet.http.HttpSession getSession()

Convenience method to get the session

sendUserMessage

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

setUserManager

public void setUserManager(org.appfuse.service.UserManager userManager)

setRoleManager

public void setRoleManager(org.appfuse.service.RoleManager roleManager)

setMailEngine

public void setMailEngine(org.appfuse.service.MailEngine mailEngine)

setMessage

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

setTemplateName

public void setTemplateName(java.lang.String templateName)

setFrom

public void setFrom(java.lang.String from)

Convenience method for setting a "from" parameter to indicate the previous page.

Parameters:

from -

setDelete

public void setDelete(java.lang.String delete)

setSave

public void setSave(java.lang.String save)