Package name.matthewgreet.strutscommons.action

Class AbstractActionSupport

java.lang.Object

org.apache.struts2.ActionSupport

com.opensymphony.xwork2.ActionSupport

name.matthewgreet.strutscommons.action.AbstractActionSupport

All Implemented Interfaces:

Action, ValidationAware, LocaleProvider, TextProvider, Validateable, Serializable, BrowserTabAware, BrowserTabAware2, LoggingAware, ValidationAware2, Action, ServletRequestAware, ValidationAware, Validateable

Direct Known Subclasses:

AbstractFormDrivenActionSupport, AbstractJsonServerAction, AbstractViewActionSupport

public abstract class AbstractActionSupport
extends ActionSupport
implements BrowserTabAware, BrowserTabAware2, LoggingAware, ServletRequestAware, ValidationAware2

Base class of Struts 2 Action that supports server state per browser tab.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.opensymphony.xwork2.interceptor.ValidationAware

ValidationAware.LegacyAdapter

Field Summary

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
AbstractActionSupport()

Method Summary

Modifier and Type	Method	Description
void	addActionWarning(String message)	Adds warning message to display to the user.
Collection<String>	getActionWarnings()	Returns warning messages to display to the user.
BrowserTabSession	getBrowserTabSession()	Returns a session that distinguishes between different tabs of the same web browser.
abstract org.apache.logging.log4j.Logger	getLogger()	Returns logger for recording events, which should be overridden by the implementing subclass.
javax.servlet.http.HttpServletRequest	getServletRequest()
String	getTabId()	Deprecated. Suffers from a design flaw of not handling when a user opens a link in a new tab.
boolean	hasActionWarnings()	Returns whether there are any warning messages.
void	setActionWarnings(Collection<String> messages)	Sets warning messages to display to the user.
void	setBrowserTabSession(BrowserTabSession value)	Sets a session that distinguishes between different tabs of the same web browser.
void	setTabId(String value)	Deprecated. Suffers from a design flaw of not handling when a user opens a link in a new tab.
void	withServletRequest(javax.servlet.http.HttpServletRequest request)

Methods inherited from class org.apache.struts2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, execute, 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 java.lang.Object

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

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

execute

Methods inherited from interface name.matthewgreet.strutscommons.action.BrowserTabAware2

copyAttributesFromOldTabToNewTab, handleAttributeFailures

Methods inherited from interface org.apache.struts2.Validateable

validate

Methods inherited from interface org.apache.struts2.interceptor.ValidationAware

addActionError, addActionMessage, addFieldError, getActionErrors, getActionMessages, getFieldErrors, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors

Constructor Details

AbstractActionSupport

public AbstractActionSupport()

Method Details

getLogger

public abstract org.apache.logging.log4j.Logger getLogger()

Returns logger for recording events, which should be overridden by the implementing subclass.

Specified by:

getLogger in interface LoggingAware

getTabId

@Deprecated
public String getTabId()

Deprecated.

Suffers from a design flaw of not handling when a user opens a link in a new tab. Obtain the BrowserTabSession instance using getBrowserTabSession() and place session objects in that.

Returns browser tab id, distinguishing between browser tabs on the same web browser.

Specified by:

getTabId in interface BrowserTabAware

setTabId

@Deprecated
public void setTabId(String value)

Deprecated.

Suffers from a design flaw of not handling when a user opens a link in a new tab. Obtain the BrowserTabSession instance using getBrowserTabSession() and place session objects in that.

Sets browser tab id, distinguishing between browser tabs on the same web browser.

Specified by:

setTabId in interface BrowserTabAware

getBrowserTabSession

public BrowserTabSession getBrowserTabSession()

Returns a session that distinguishes between different tabs of the same web browser.

Specified by:

getBrowserTabSession in interface BrowserTabAware2

setBrowserTabSession

public void setBrowserTabSession(BrowserTabSession value)

Sets a session that distinguishes between different tabs of the same web browser.

Specified by:

setBrowserTabSession in interface BrowserTabAware2

getActionWarnings

public Collection<String> getActionWarnings()

Description copied from interface: ValidationAware2

Returns warning messages to display to the user. New messages should not be added to the result, use #addActionWarning instead.

Specified by:

getActionWarnings in interface ValidationAware2

setActionWarnings

public void setActionWarnings(Collection<String> messages)

Description copied from interface: ValidationAware2

Sets warning messages to display to the user.

Specified by:

setActionWarnings in interface ValidationAware2

addActionWarning

public void addActionWarning(String message)

Description copied from interface: ValidationAware2

Adds warning message to display to the user.

Specified by:

addActionWarning in interface ValidationAware2

hasActionWarnings

public boolean hasActionWarnings()

Description copied from interface: ValidationAware2

Returns whether there are any warning messages.

Specified by:

hasActionWarnings in interface ValidationAware2

getServletRequest

public javax.servlet.http.HttpServletRequest getServletRequest()

withServletRequest

public void withServletRequest(javax.servlet.http.HttpServletRequest request)

Specified by:

withServletRequest in interface ServletRequestAware