PollenActionSupport (Pollen :: UI (struts2) 1.5.5 API)

java.lang.Object
- com.opensymphony.xwork2.ActionSupport
- - org.nuiton.web.struts2.BaseAction
  - - org.chorem.pollen.ui.actions.PollenActionSupport

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.ServletRequestAware

Direct Known Subclasses:

AbstractDisplayChoice, AbstractJSONPaginedAction, AbstractJSONSimpleAction, AbstractVoteAction, AttachPoll, ChangeLang, ClosePoll, Confirm, Confirm, ConfirmDeleteChoice, ConfirmDeleteComment, ConfirmDeleteVote, ConfirmPollAction, DeleteChoice, DeleteComment, DeleteFavoriteList, DeleteFavoriteListVoter, DeletePoll, DeleteUser, DeleteVote, DisplayPersonToList, DisplayVotingList, ExportPoll, GenerateChart, GetPollFeed, GetPollImageChoice, ImportPersonListToVotingList, Login, Logout, LostPassword, ManagePolls, ManageUsers, PollenActionSupportForEdition, PollenActionSupportForVote, ResultForPoll, SelectPersonListToVotingList, SummaryPoll
```
public class PollenActionSupport
extends org.nuiton.web.struts2.BaseAction
implements org.apache.struts2.interceptor.ServletRequestAware
```
Pollen action support.
Note : All actions must implement this class to have a better i18n support, when a i18n key is not translated it has a empty translation and we do NOT want this behaviour in gui, prefer to return the marked untranslated key.

Since:

1.3

Author:

tchemit

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static List<String>`	`SAFE_LANGUAGES`
`protected PollenServiceContext`	`serviceContext`
`protected PollenServiceFactory`	`serviceFactory` Provides a way to get a service.
`protected org.nuiton.topia.TopiaContext`	`transaction`

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

PollenActionSupport()

PollenActionSupport(PageSkin skin)

Constructors
Constructor and Description
`PollenActionSupport()`
`PollenActionSupport(PageSkin skin)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addFlashError(String message)`
`void`	`addFlashMessage(String message)`
`void`	`addFlashWarning(String message)`
`void`	`clearFlashErrors()`
`void`	`clearFlashMessages()`
`URL`	`getApplicationUrl()`
`static String`	`getApplicationVersion()`
`PollenConfiguration`	`getConfiguration()`
`String`	`getCurrentUrl()`
`protected FavoriteService`	`getFavoriteService()`
`Collection<String>`	`getFlashErrors()`
`Collection<String>`	`getFlashMessages()`
`Collection<String>`	`getFlashWarnings()`
`String`	`getJqueryTheme()`
`String`	`getPageLogo()`
`protected Map<String,String[]>`	`getParameters()` Obtain the injected request parameters.
`protected PollCommentService`	`getPollCommentService()`
`static PollenApplicationContext`	`getPollenApplicationContext()`
`PollenSession`	`getPollenSession()`
`UserAccount`	`getPollenUserAccount()`
`protected PollExportService`	`getPollExportService()`
`protected PollFeedService`	`getPollFeedService()`
`protected PollService`	`getPollService()`
`PollUri`	`getPollUri()` Gets the `PollUri` from the incoming request.
`protected PollUrlService`	`getPollUrlService()`
`protected PollVoteCountingService`	`getPollVoteCountingService()`
`protected PreventRuleService`	`getPreventRuleService()`
`String`	`getSafeLanguage()`
`protected SecurityService`	`getSecurityService()`
`protected <S extends PollenServiceSupport> S`	`getService(Class<S> serviceType)` Get a instance of a service for the given `serviceType`.
`protected PollenServiceContext`	`getServiceContext()` Fabrique pour récupérer le ServiceContext tel qu'il devrait être fourni à la fabrication d'un service.
`PageSkin`	`getSkin()`
`org.nuiton.topia.TopiaContext`	`getTransaction()`
`protected PollenUserSecurityContext`	`getUserSecurityContext()` Obtain the injected security context.
`protected UserService`	`getUserService()`
`protected VoteCounting`	`getVoteCounting(Poll poll)`
`VoteCountingFactory`	`getVoteCountingFactory()`
`protected VoteService`	`getVoteService()`
`boolean`	`hasAnyErrors()`
`boolean`	`hasFlashErrors()`
`boolean`	`hasFlashMessages()`
`boolean`	`hasFlashWarnings()`
`protected boolean`	`isGetMethod()` Tests if the incoming http request is a get method.
`boolean`	`isUserAdmin()`
`boolean`	`isUserLoggued()`
`void`	`setParameters(Map<String,String[]> parameters)` Keep in this action the incoming request parameters.
`void`	`setPollenUserSecurityContext(PollenUserSecurityContext pollenUserSecurityContext)` Keep in this action the incoming security context.
`void`	`setServletRequest(javax.servlet.http.HttpServletRequest request)` Keep in this action the incoming request.

Methods inherited from class org.nuiton.web.struts2.BaseAction
_

Methods inherited from class com.opensymphony.xwork2.ActionSupport
addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, doDefault, execute, 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
  - serviceFactory
```
protected transient PollenServiceFactory serviceFactory
```
    Provides a way to get a service.
    Actions may not call it directly by use getService(Class) instead.
  - serviceContext
```
protected transient PollenServiceContext serviceContext
```
  - transaction
```
protected transient org.nuiton.topia.TopiaContext transaction
```
  - SAFE_LANGUAGES
```
public static final List<String> SAFE_LANGUAGES
```
- Constructor Detail
  - PollenActionSupport
```
public PollenActionSupport()
```
  - PollenActionSupport
```
public PollenActionSupport(PageSkin skin)
```
- Method Detail
  - getPollenApplicationContext
```
public static PollenApplicationContext getPollenApplicationContext()
```
  - getConfiguration
```
public PollenConfiguration getConfiguration()
```
  - getSkin
```
public final PageSkin getSkin()
```
  - getPageLogo
```
public final String getPageLogo()
```
  - getJqueryTheme
```
public final String getJqueryTheme()
```
  - getPollenSession
```
public PollenSession getPollenSession()
```
  - getPollenUserAccount
```
public UserAccount getPollenUserAccount()
```
  - isUserLoggued
```
public boolean isUserLoggued()
```
  - isUserAdmin
```
public boolean isUserAdmin()
```
  - getApplicationVersion
```
public static String getApplicationVersion()
```
  - getApplicationUrl
```
public URL getApplicationUrl()
```
  - setServletRequest
```
public final void setServletRequest(javax.servlet.http.HttpServletRequest request)
```
    Keep in this action the incoming request.
    
    Specified by:
    
    setServletRequest in interface org.apache.struts2.interceptor.ServletRequestAware
    
    Parameters:
    request - the http request to set (can not be null)
    Since:
    
    1.4.5
    
    See Also:
    ServletRequestAware
  - setParameters
```
public final void setParameters(Map<String,String[]> parameters)
```
    Keep in this action the incoming request parameters.
    Note: This method will be invoked only if your action implements the ParameterAware contract.
    
    Parameters:
    parameters - paramters of the request (can not be null)
    Since:
    
    1.4.5
    
    See Also:
    ParameterAware
  - setPollenUserSecurityContext
```
public final void setPollenUserSecurityContext(PollenUserSecurityContext pollenUserSecurityContext)
```
    Keep in this action the incoming security context.
    Note: This method will be invoked only if your action implements the PollenUserSecurityAware contract.
    
    Parameters:
    pollenUserSecurityContext - pollen security context to set (can not be null)
    Since:
    
    1.4.5
    
    See Also:
    PollenUserSecurityAware
  - getPollUri
```
public PollUri getPollUri()
```
    Gets the PollUri from the incoming request.
    If the action is PollenUserSecurityAware, then will take it from PollenUserSecurityContext.getPollUri(), otherwise will return null (this means you must override this method in your action.
    
    Returns:
    the pollUri register in this action or null.
    Since:
    
    1.4.5
  - getVoteCountingFactory
```
public VoteCountingFactory getVoteCountingFactory()
```
  - getTransaction
```
public org.nuiton.topia.TopiaContext getTransaction()
```
  - getSafeLanguage
```
public String getSafeLanguage()
```
  - getCurrentUrl
```
public String getCurrentUrl()
```
  - addFlashMessage
```
public void addFlashMessage(String message)
```
  - addFlashError
```
public void addFlashError(String message)
```
  - addFlashWarning
```
public void addFlashWarning(String message)
```
  - getFlashMessages
```
public Collection<String> getFlashMessages()
```
  - getFlashErrors
```
public Collection<String> getFlashErrors()
```
  - getFlashWarnings
```
public Collection<String> getFlashWarnings()
```
  - hasFlashMessages
```
public boolean hasFlashMessages()
```
  - hasFlashErrors
```
public boolean hasFlashErrors()
```
  - hasFlashWarnings
```
public boolean hasFlashWarnings()
```
  - clearFlashMessages
```
public void clearFlashMessages()
```
  - clearFlashErrors
```
public void clearFlashErrors()
```
  - hasAnyErrors
```
public boolean hasAnyErrors()
```
  - getPollService
```
protected final PollService getPollService()
```
  - getPollUrlService
```
protected final PollUrlService getPollUrlService()
```
  - getPollExportService
```
protected final PollExportService getPollExportService()
```
  - getPollVoteCountingService
```
protected final PollVoteCountingService getPollVoteCountingService()
```
  - getVoteService
```
protected final VoteService getVoteService()
```
  - getPollCommentService
```
protected final PollCommentService getPollCommentService()
```
  - getPollFeedService
```
protected final PollFeedService getPollFeedService()
```
  - getUserService
```
protected final UserService getUserService()
```
  - getFavoriteService
```
protected final FavoriteService getFavoriteService()
```
  - getPreventRuleService
```
protected final PreventRuleService getPreventRuleService()
```
  - getSecurityService
```
protected final SecurityService getSecurityService()
```
  - getService
```
protected final <S extends PollenServiceSupport> S getService(Class<S> serviceType)
```
    Get a instance of a service for the given serviceType.
    
    Type Parameters:
    S - type of the required service
    Parameters:
    serviceType - type of the required service
    
    Returns:
    instance of the service
    Since:
    
    1.4.5
  - isGetMethod
```
protected boolean isGetMethod()
```
    Tests if the incoming http request is a get method.
    Note: request must not be null.
    
    Returns:
    true if incoming request uses GET method.
    Since:
    
    1.4.5
  - getUserSecurityContext
```
protected final PollenUserSecurityContext getUserSecurityContext()
```
    Obtain the injected security context.
    Note: securityContext must not be null (concrete action should implements PollenUserSecurityAware).
    
    Returns:
    the injected security context
    Since:
    
    1.4.5
    
    See Also:
    PollenUserSecurityContext, PollenUserSecurityAware
  - getParameters
```
protected final Map<String,String[]> getParameters()
```
    Obtain the injected request parameters.
    Note: parameters must not be null (concrete action should implements ParameterAware).
    
    Returns:
    the injected request parameters
    Since:
    
    1.4.5
    
    See Also:
    ParameterAware
  - getVoteCounting
```
protected VoteCounting getVoteCounting(Poll poll)
```
  - getServiceContext
```
protected PollenServiceContext getServiceContext()
```
    Fabrique pour récupérer le ServiceContext tel qu'il devrait être fourni à la fabrication d'un service.
    
    Returns:
    service context

Class PollenActionSupport

Field Summary

Fields inherited from class com.opensymphony.xwork2.ActionSupport

Fields inherited from interface com.opensymphony.xwork2.Action

Constructor Summary

Method Summary

Methods inherited from class org.nuiton.web.struts2.BaseAction

Methods inherited from class com.opensymphony.xwork2.ActionSupport

Methods inherited from class java.lang.Object

Field Detail

serviceFactory

serviceContext

transaction

SAFE_LANGUAGES

Constructor Detail

PollenActionSupport

PollenActionSupport

Method Detail

getPollenApplicationContext

getConfiguration

getSkin

getPageLogo

getJqueryTheme

getPollenSession

getPollenUserAccount

isUserLoggued

isUserAdmin

getApplicationVersion

getApplicationUrl

setServletRequest

setParameters

setPollenUserSecurityContext

getPollUri

getVoteCountingFactory

getTransaction

getSafeLanguage

getCurrentUrl

addFlashMessage

addFlashError

addFlashWarning

getFlashMessages

getFlashErrors

getFlashWarnings

hasFlashMessages

hasFlashErrors

hasFlashWarnings

clearFlashMessages

clearFlashErrors

hasAnyErrors

getPollService

getPollUrlService

getPollExportService

getPollVoteCountingService

getVoteService

getPollCommentService

getPollFeedService

getUserService

getFavoriteService

getPreventRuleService

getSecurityService

getService

isGetMethod

getUserSecurityContext

getParameters

getVoteCounting

getServiceContext