Class SampleAction

java.lang.Object

org.apache.struts2.ActionSupport

org.conical.common.bbl.web.struts.actions.BaseAction

org.conical.common.bbl.web.struts.actions.SampleAction

All Implemented Interfaces:

Serializable, org.apache.struts2.action.Action, org.apache.struts2.action.ServletRequestAware, org.apache.struts2.action.ServletResponseAware, org.apache.struts2.interceptor.ValidationAware, org.apache.struts2.locale.LocaleProvider, org.apache.struts2.text.TextProvider, org.apache.struts2.Validateable

public class SampleAction
extends BaseAction

This class exists as a simple child of BaseAction to show how little code must be written to implement an action. It can be used as a model for those learning Struts and the BBL Struts framework.

Author:

rdoherty

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class BaseAction

BaseAction.Developer

Modifier and Type	Class	Description
class	BaseAction.Developer	Encapsulates information about the contact developer for this application

Field Summary

Fields inherited from class BaseAction

PERMISSION_DENIED

Modifier and Type	Field	Description
protected static final String	PERMISSION_DENIED	Should be returned when permission to view a page or perform an action is denied

Fields inherited from class org.apache.struts2.ActionSupport

container

Fields inherited from interface org.apache.struts2.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
SampleAction()

Method Summary

Modifier and Type	Method	Description
protected boolean	actionRequiresLogin()	Returns true since most applications require login.
protected String	doWork()	Performs no side effects; simply returns success.

Methods inherited from class BaseAction

addCookie, doAutoLogin, execute, getApplicationName, getApplicationProperties, getCookies, getCurrentUser, getDeveloper, getEthnicities, getHandednesses, getNameSuffixes, getRaces, getReligions, getRequestUrl, getRequiredAccessRoles, getSession, getSexes, getSexualOrientations, getStates, withServletRequest, withServletResponse

Modifier and Type	Method	Description
void	addCookie(jakarta.servlet.http.Cookie cookie)	Adds the passed cookie to the HTTP response
protected void	doAutoLogin()	Try to log in user automatically using cookies or some other mechanism (implementation dependent).
final String	execute()	Method called by Struts to initiate action logic.
String	getApplicationName()	Returns the name of this application
protected Map<String,String>	getApplicationProperties()	Returns a map of application properties read from the application.properties file.
List<jakarta.servlet.http.Cookie>	getCookies()
final User	getCurrentUser()	Returns the user currently logged into this application, or null if no one is logged in, if the user is no longer valid, or if an error occurs (the error having been logged).
BaseAction.Developer	getDeveloper()	Returns the developer who should be contacted regarding this application
List<Ethnicity>	getEthnicities()
List<Handedness>	getHandednesses()
List<NameSuffix>	getNameSuffixes()
List<Race>	getRaces()
List<Religion>	getReligions()
String	getRequestUrl()	Returns the original URL for this request.
protected Set<String>	getRequiredAccessRoles()	Returns the set of access roles required to execute this action (and access the associated page).
protected Map<String,Object>	getSession()	Exposes session to child classes.
List<Sex>	getSexes()
List<SexualOrientation>	getSexualOrientations()
List<State>	getStates()
void	withServletRequest(jakarta.servlet.http.HttpServletRequest request)
void	withServletResponse(jakarta.servlet.http.HttpServletResponse response)

Methods inherited from class org.apache.struts2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, getActionErrors, getActionMessages, getContainer, getFieldErrors, getFormatted, getLocale, getLocaleProvider, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, toLocale, validate

Methods inherited from class Object

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

Constructor Details

SampleAction

public SampleAction()

Method Details

actionRequiresLogin

protected boolean actionRequiresLogin()

Returns true since most applications require login.

Specified by:

actionRequiresLogin in class BaseAction

Returns:

true

doWork

protected String doWork()
                 throws Exception

Performs no side effects; simply returns success.

Specified by:

doWork in class BaseAction

Returns:

success

Throws:

Exception - if something goes wrong