fr.onema.sispea.struts

Class AbstractSispeaAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

fr.onema.sispea.struts.AbstractSispeaAction

All Implemented Interfaces:

com.opensymphony.xwork2.Action, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, com.opensymphony.xwork2.ValidationAware, Serializable, org.apache.struts2.interceptor.ApplicationAware, org.apache.struts2.interceptor.ParameterAware, org.apache.struts2.interceptor.SessionAware

Direct Known Subclasses:

AbstractDashboardAction, AbstractDataListsAction, AbstractExchangeQueueAction, AbstractExercisesAction, AbstractFileUploadAction, AbstractForgottenPasswordAction, AbstractNewSpeaAction, AbstractPriceEditorAction, AbstractRelevantLevelsAction, AbstractSpeaIndicatorsAction, AbstractSynthDisplayAction, AbstractTaxesEditorAction, AbstractTestNCSAction, AbstractUserAction, AbstractUserMandatesAction, AbstractUserSelectionMultipleAction, AbstractUserSelectionsAction, AbstractUsersManagementAction, AdminAction, AdminSpaceAction, CleanLDAPAction, ContactAction, EditIndicatorsLimitsAction, FileDownloadAction, IndicatorsLimitsAction, InitSessionAction, InitSynthesisAction, LoginAction, LogoutAction, ShowLoginAction, ShowOrganismAction, ShowPersonalSpaceAction, StayAliveAction, SyncLDAPAction, UpdateFullScreenAction

public abstract class AbstractSispeaAction
extends com.opensymphony.xwork2.ActionSupport
implements org.apache.struts2.interceptor.ParameterAware, org.apache.struts2.interceptor.SessionAware, org.apache.struts2.interceptor.ApplicationAware

Super class of all SISPEA struts action classes.

Author:

CS

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	application The application context.
protected SispeaConfiguration	configuration
protected String	formatDate
protected String	formatDateOnly
protected MenuBean	menu Menu container
protected String	nextPage The next page.
protected Map<String,String[]>	parameters The request parameters.
protected ServiceMessages	serviceMessages
protected Map<String,Object>	session The session context.
protected SispeaSession	sispeaSession The business Sispea session object (contains anything in user's session)
protected StrutsMessages	strutsMessages
protected String	submitValue The submit button activated.
protected TerritoryService	territoryService
protected IUserService	userService

Fields inherited from class com.opensymphony.xwork2.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
AbstractSispeaAction()

Method Summary

Methods

Modifier and Type	Method and Description
void	buildMenu() Initializes the menu
Boolean	checkIfUserCanViewDashBoard()
protected void	checkRight() This method should throw an exception if the user has not got the right to access the function.
Boolean	checkUserRight(Right pRight)
boolean	checkUserRight(Right pRight, OrganismDto pOrganism, ExerciseDto pExercise)
Boolean	checkUserRight(Right pRight, TerritoryDto pTerritoryTest, ExerciseDto pExercise)
void	createMenu(boolean pForce) Initializes the menu if not already done.
protected abstract String	doExecute() This method is called by the execute method.
protected String	doHandleException(Exception pException) Handles all exceptions.
protected String	doHandleSispeaException(SispeaException pException) Handles exceptions of the type SispeaException.
String	execute() This method is called by the web app controller.
Map<String,Object>	getApplication() Returns the application context.
UserDto	getCurrentUser()
TerritoryDto	getCurrentUserTerritory()
String	getFormatDate()
String	getFormatDateOnly()
MenuBean	getMenu()
String	getNextPage()
String	getOption(String optionKey)
Map<String,String[]>	getParameters() Returns the request parameters.
Map<String,Object>	getSession() Returns the session context.
SispeaSession	getSispeaSession() Returns the SISPEA session.
String	getSubmitValue()
protected void	initSession() Initializes the session.
boolean	isEnglish() This method returns true if the language is english, false otherwise.
boolean	isFrench() This method returns true if the language is french, false otherwise.
boolean	isSpanish() This method returns true if the language is spanish, false otherwise.
protected void	logException(Exception pException) Logs the exception.
void	openMenu(String pKey) Open the menu corresponding to the key.
protected void	removeSession() Removes the session.
void	setApplication(Map<String,Object> pMap)
void	setMenu(MenuBean pMenu)
void	setNextPage(String pNextPage)
void	setParameters(Map<String,String[]> pMap)
void	setSession(Map<String,Object> pMap)
void	setSubmitValue(String pSubmitValue)

Methods inherited from class com.opensymphony.xwork2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, doDefault, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getFormatted, getLocale, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Field Detail

territoryService

@Autowired
protected transient TerritoryService territoryService

userService

@Autowired
protected transient IUserService userService

serviceMessages

@Autowired
protected transient ServiceMessages serviceMessages

strutsMessages

@Autowired
protected transient StrutsMessages strutsMessages

configuration

@Autowired
protected transient SispeaConfiguration configuration

formatDate

@Value(value="${sispea.format.date}")
protected String formatDate

formatDateOnly

@Value(value="${sispea.format.date.only}")
protected String formatDateOnly

application

protected Map<String,Object> application

The application context. Set by Struts.

session

protected Map<String,Object> session

The session context.

parameters

protected Map<String,String[]> parameters

The request parameters.

submitValue

protected String submitValue

The submit button activated.

nextPage

protected String nextPage

The next page.

menu

protected MenuBean menu

Menu container

sispeaSession

protected transient SispeaSession sispeaSession

The business Sispea session object (contains anything in user's session)

Constructor Detail

AbstractSispeaAction

public AbstractSispeaAction()

Method Detail

doExecute

protected abstract String doExecute()
                             throws Exception

This method is called by the execute method. It should implement the real processing of the action. To be overridden by the subclasses.

Throws:

Exception

getApplication

public Map<String,Object> getApplication()

Returns the application context.

setApplication

public void setApplication(Map<String,Object> pMap)

Specified by:

setApplication in interface org.apache.struts2.interceptor.ApplicationAware

getSession

public Map<String,Object> getSession()

Returns the session context.

setSession

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

Specified by:

setSession in interface org.apache.struts2.interceptor.SessionAware

getParameters

public Map<String,String[]> getParameters()

Returns the request parameters.

setParameters

public void setParameters(Map<String,String[]> pMap)

Specified by:

setParameters in interface org.apache.struts2.interceptor.ParameterAware

execute

public final String execute()
                     throws Exception

This method is called by the web app controller. It is the entry point of all SISPEA actions. It implements common methods such as logging and exception handling. Then it delegates the processing to the doExceute method.

Specified by:

execute in interface com.opensymphony.xwork2.Action

Overrides:

execute in class com.opensymphony.xwork2.ActionSupport

Throws:

Exception

getOption

public String getOption(String optionKey)

checkRight

protected void checkRight()
                   throws SispeaException

This method should throw an exception if the user has not got the right to access the function.

Throws:

SispeaException

doHandleSispeaException

protected String doHandleSispeaException(SispeaException pException)

Handles exceptions of the type SispeaException.

doHandleException

protected String doHandleException(Exception pException)

Handles all exceptions. Forwards towards the ERROR page.

removeSession

protected void removeSession()

Removes the session.

initSession

protected void initSession()

Initializes the session.

logException

protected void logException(Exception pException)

Logs the exception.

getSispeaSession

public SispeaSession getSispeaSession()

Returns the SISPEA session. The session is always existing.

getCurrentUser

public UserDto getCurrentUser()

Returns:

current user if exists, null else

getCurrentUserTerritory

public TerritoryDto getCurrentUserTerritory()

Returns:

current user territory if exists, null else

getNextPage

public String getNextPage()

setNextPage

public void setNextPage(String pNextPage)

isEnglish

public boolean isEnglish()

This method returns true if the language is english, false otherwise.

Returns:

True if the language is english.

isFrench

public boolean isFrench()

This method returns true if the language is french, false otherwise.

Returns:

True if the language is french.

isSpanish

public boolean isSpanish()

This method returns true if the language is spanish, false otherwise.

Returns:

True if the language is spanish.

createMenu

public void createMenu(boolean pForce)
                throws Exception

Initializes the menu if not already done.

Parameters:

pForce - if true, menu is rebuild

Throws:

Exception

buildMenu

public void buildMenu()
               throws SispeaException

Initializes the menu

Throws:

SispeaException

openMenu

public void openMenu(String pKey)

Open the menu corresponding to the key.

checkIfUserCanViewDashBoard

public Boolean checkIfUserCanViewDashBoard()
                                    throws SispeaException

Returns:

true if current user has more than view right

Throws:

SispeaException

checkUserRight

public Boolean checkUserRight(Right pRight)
                       throws SispeaException

Parameters:

pRight -

Returns:

true if current user has right, false else

Throws:

SispeaException

checkUserRight

public Boolean checkUserRight(Right pRight,
                     TerritoryDto pTerritoryTest,
                     ExerciseDto pExercise)
                       throws SispeaException

Parameters:

pRight -

Returns:

true if current user has right, false else

Throws:

SispeaException

checkUserRight

public boolean checkUserRight(Right pRight,
                     OrganismDto pOrganism,
                     ExerciseDto pExercise)
                       throws SispeaException

Parameters:

pRight - The right to check for

pOrganism - Has the user the right pRightName for the organism pOrganism

pExercise - The exercise to check for.

Returns:

true if current user has right, false else

Throws:

SispeaException

getMenu

public MenuBean getMenu()

setMenu

public void setMenu(MenuBean pMenu)

getSubmitValue

public String getSubmitValue()

setSubmitValue

public void setSubmitValue(String pSubmitValue)

getFormatDate

public String getFormatDate()

getFormatDateOnly

public String getFormatDateOnly()