gov.va.med.vistalink.management.action

Class VistaLinkActionBase

Object

ActionSupport

VistaLinkActionBase

All Implemented Interfaces:

Action, ParameterNameAware, ValidationAware, LocaleProvider, TextProvider, Validateable, Serializable, ServletRequestAware, SessionAware

Direct Known Subclasses:

ConfiguratorDeleteAction, ConfiguratorEncryptAllAction, ConfiguratorEncryptChangeTypeAction, ConfiguratorListAction, ConfiguratorRetrieveAction, ConfiguratorSaveAction, ConsoleMainAction, DisplayConnectorAction, DisplayConnectorListAction, DisplayInstitutionMappingAction, LogoutAction

public class VistaLinkActionBase
extends ActionSupport
implements ServletRequestAware, SessionAware, ParameterNameAware

Base class for VistaLink console Struts pages, contains some common functionality.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	definitionLabel same as/keep in sync with definitionLabel in portlet's .book file.
protected HttpServletRequest	request
protected Map<String,Object>	userSession

Fields inherited from class ActionSupport

container

Fields inherited from interface Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
VistaLinkActionBase()

Method Summary

Modifier and Type	Method and Description
boolean	acceptableParameterName(String parameterName)
protected void	addPageRenderedTime() Add page rendered to request in specific attribute.
protected void	addSessionTimeoutWarning() synchronized method due to access to sessionTimeout instance variables
protected void	checkIsUserInRole(byte acceptableRoleFlags) Check if user is in one or more of a set of specified role(s).
String	getDefinitionLabel()
String	getPageRenderedTime()
String	getSessionTimeoutWarningIntervalMsg()
int	getSessionTimeoutWarningTime()
String	getVlDomain()
String	getVlUserName()
protected boolean	hasAnyErrors()
void	init()
protected void	setError(String error)
protected void	setError(String error, String info)
protected void	setMessage(String message)
void	setServletRequest(HttpServletRequest request)
void	setSession(Map<String,Object> session)

Methods inherited from class 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, validate

Methods inherited from class Object

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

Field Detail

definitionLabel

protected String definitionLabel

same as/keep in sync with definitionLabel in portlet's .book file. Used to generate portal-compatible label-for and styleId attributes (until Struts has an html:label tag) which the portal prefaces with the portlet definitionLabel.

request

protected HttpServletRequest request

userSession

protected Map<String,Object> userSession

Constructor Detail

VistaLinkActionBase

public VistaLinkActionBase()

Method Detail

getPageRenderedTime

public String getPageRenderedTime()

getVlUserName

public String getVlUserName()

getVlDomain

public String getVlDomain()

getSessionTimeoutWarningTime

public int getSessionTimeoutWarningTime()

getSessionTimeoutWarningIntervalMsg

public String getSessionTimeoutWarningIntervalMsg()

getDefinitionLabel

public String getDefinitionLabel()

init

public void init()

addPageRenderedTime

protected void addPageRenderedTime()

Add page rendered to request in specific attribute.

Parameters:

request -

addSessionTimeoutWarning

protected void addSessionTimeoutWarning()

synchronized method due to access to sessionTimeout instance variables

Parameters:

request -

checkIsUserInRole

protected void checkIsUserInRole(byte acceptableRoleFlags)

Check if user is in one or more of a set of specified role(s). Unchecked SecurityException is thrown if problem found.

Parameters:

request - needed to call isUserInRole

acceptableRoleFlags - pass in bit flags representing permissible roles to check if user has access against

acceptableParameterName

public boolean acceptableParameterName(String parameterName)

Specified by:

acceptableParameterName in interface ParameterNameAware

setSession

public void setSession(Map<String,Object> session)

Specified by:

setSession in interface SessionAware

setServletRequest

public void setServletRequest(HttpServletRequest request)

Specified by:

setServletRequest in interface ServletRequestAware

setMessage

protected void setMessage(String message)

setError

protected void setError(String error)

setError

protected void setError(String error,
                        String info)

hasAnyErrors

protected boolean hasAnyErrors()