package org.appfuse.webapp.action;
import com.opensymphony.xwork2.ActionContext;
import com.opensymphony.xwork2.ActionSupport;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.struts2.ServletActionContext;
import org.appfuse.Constants;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* Implementation of <strong>ActionSupport</strong> 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.
*
* @author <a href="mailto:matt@raibledesigns.com">Matt Raible</a>
*/
public class BaseAction extends ActionSupport {
private static final long serialVersionUID = 3525445612504421307L;
/**
* Constant for cancel result String
*/
public static final String CANCEL = "cancel";
/**
* Transient log to prevent session synchronization issues - children can use instance for logging.
*/
protected final transient Log log = LogFactory.getLog(getClass());
/**
* Indicator if the user clicked cancel
*/
protected String cancel;
/**
* Indicator for the page the user came from.
*/
protected String from;
/**
* Set to "delete" when a "delete" request parameter is passed in
*/
protected String delete;
/**
* Set to "save" when a "save" request parameter is passed in
*/
protected String save;
/**
* Simple method that returns "cancel" result
*
* @return "cancel"
*/
public String cancel() {
return CANCEL;
}
/**
* Save the message in the session, appending if messages already exist
*
* @param msg the message to put in the session
*/
@SuppressWarnings("unchecked")
protected void saveMessage(String msg) {
List messages = (List) getRequest().getSession().getAttribute("messages");
if (messages == null) {
messages = new ArrayList();
}
messages.add(msg);
getRequest().getSession().setAttribute("messages", messages);
}
/**
* Convenience method to get the Configuration HashMap
* from the servlet context.
*
* @return the user's populated form from the session
*/
protected Map getConfiguration() {
Map config = (HashMap) getRequest().getServletContext().getAttribute(Constants.CONFIG);
// so unit tests don't puke when nothing's been set
if (config == null) {
return new HashMap();
}
return config;
}
/**
* Convenience method to get the request
*
* @return current request
*/
protected HttpServletRequest getRequest() {
return ServletActionContext.getRequest();
}
/**
* Convenience method for setting a "from" parameter to indicate the previous page.
*
* @param from indicator for the originating page
*/
public void setFrom(String from) {
this.from = from;
}
public void setCancel(String cancel) {
this.cancel = cancel;
}
public void setDelete(String delete) {
this.delete = delete;
}
public void setSave(String save) {
this.save = save;
}
}