Framework Serveur J2EE ACube V3.1.0
CLASSE PRECEDANTE CLASSE SUIVANTE
SOMMAIRE: ATTR CONSTR METH DETAIL: ATTR CONSTR METH

acube.framework.webcomp.action
Classe BaseAction
java.lang.Object
  com.opensymphony.xwork2.ActionSupport
      acube.framework.webcomp.action.BaseAction
Interfaces à implémenter:
com.opensymphony.xwork2.Action, org.apache.struts2.interceptor.ApplicationAware, com.opensymphony.xwork2.LocaleProvider, Serializable, org.apache.struts2.util.ServletContextAware, org.apache.struts2.interceptor.ServletRequestAware, org.apache.struts2.interceptor.ServletResponseAware, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, com.opensymphony.xwork2.ValidationAware
Sous classes directement connues:

abstract public class BaseAction
hérite de com.opensymphony.xwork2.ActionSupport
implémente org.apache.struts2.interceptor.ServletRequestAware, org.apache.struts2.interceptor.ServletResponseAware, org.apache.struts2.interceptor.ApplicationAware, org.apache.struts2.util.ServletContextAware

Abstract class for LISE 2.x actions.

This class provide a compatibility layer between LISE 2 actions based on Struts1.1 and Struts2 Actions.

With LISE 3.x ,the request flow is now handled by this class and an interceptor stack (see package webcomp aand struts-acube.xml)


Sommaire des Attributs
protected Configuration
configMode
configMode configuration of application
private static Map
contentTypes
contentTypes the return content types
private Map
context
context the context
protected org.apache.log4j.Logger
logger
logger logger, visible for all classes
protected String
mecanismeAuthentification
mecanismeAuthentification flag indiquate if the authentification running
protected static String
modeFonctionnement
modeFonctionnement application's working mode
private HttpServletRequest
request
request the HTTP request
private HttpServletResponse
response
response the HTTP response
root
root the data return by the action
private ServletContext
servletContext
servletContext the servlet context
protected final String
THIS_CLASS
Comment for THIS_CLASS nom de la classe courante
Attributs hérités de l'interface com.opensymphony.xwork2.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
Sommaire des Constructeurs
Sommaire des Méthodes
protected void
AnalyseRequest(HttpServletRequest request)
Méthode pour les requetes en multipart avec des datas
String
execute()
{@inheritDoc}
protected String
executeAtEnd(String forward, HttpServletRequest request, HttpServletResponse response, ArrayList beans, ArrayList erreurs, int typeFluxAttendu)
Méthode appelée en fin de traitement: charge la bonne liste de bean au niveau de la servlet (pour la transmettre à strutscx) et choisit la bonne feuille xsl
protected HttpSession
executeAtStart(HttpServletRequest request, HttpServletResponse response, String activite)
Méthode appelée au début de l'action, pour effectuer les différentes initialisations
protected abstract String
getActivite()
Deprecated. use struts.xml
String
getActiviteV1()
Deprecated.
protected abstract ArrayList
getBeansActions(HttpServletRequest request)
This method return data that will be sent to the view
protected Date
getCalandar()
Fonction permettant de récupérer la date du jour.
static String
getModeFonctionnement()
Recuperation de la configuration concernant le mode de fonctionement de l'application: (mode Test Unitaire, mode Test Integration, ...)
protected void
getModeFonctionnement(HttpServletRequest request)
Recuperation de la configuration concernant le mode de fonctionement de l'application: (mode Test Unitaire, mode Test Integration, ...)
protected org.jdom.Element
getProprietes(String propertiesFileName, String tagName)
Trouve un élément dans un fichier de propriétés StrutsCX
protected HttpServletRequest
protected HttpServletResponse
protected abstract int
getTypeOfFlux()
Deprecated. use struts.xml
int
getTypeOfFluxV1()
Deprecated.
void
setApplication(Map context)
{@inheritDoc}
protected void
setError(ArrayList erreurs, HttpServletRequest request, HttpServletResponse response, Date datePassee, int typeFluxAttendu)
void
void
setServletContext(ServletContext arg0)
{@inheritDoc}
void
setServletRequest(HttpServletRequest request)
{@inheritDoc}
void
setServletResponse(HttpServletResponse response)
{@inheritDoc}
void
verifierDroitAcces(HttpServletRequest request, ServletContext context, String nomClasse)
Contrôle le droit d'accès d'un utilisateur à une action.
Méthodes héritées de la classe com.opensymphony.xwork2.ActionSupport
addActionError, addActionMessage, addFieldError, clearErrorsAndMessages, clone, doDefault, execute, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getLocale, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, input, pause, setActionErrors, setActionMessages, setFieldErrors, validate
Méthodes héritées de la classe java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Méthodes héritées de l'interface com.opensymphony.xwork2.Action
execute
Méthodes héritées de l'interface com.opensymphony.xwork2.Validateable
validate
Méthodes héritées de l'interface com.opensymphony.xwork2.ValidationAware
addActionError, addActionMessage, addFieldError, getActionErrors, getActionMessages, getFieldErrors, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors
Méthodes héritées de l'interface com.opensymphony.xwork2.TextProvider
getText, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts
Méthodes héritées de l'interface com.opensymphony.xwork2.LocaleProvider
getLocale
Méthodes héritées de l'interface org.apache.struts2.interceptor.ServletRequestAware
setServletRequest
Méthodes héritées de l'interface org.apache.struts2.interceptor.ServletResponseAware
setServletResponse
Méthodes héritées de l'interface org.apache.struts2.interceptor.ApplicationAware
setApplication
Méthodes héritées de l'interface org.apache.struts2.util.ServletContextAware
setServletContext
Détail des Attributs
contentTypes
private static Map contentTypes
contentTypes the return content types

modeFonctionnement
protected static String modeFonctionnement
modeFonctionnement application's working mode

configMode
protected Configuration configMode
configMode configuration of application

context
private Map context
context the context

logger
protected org.apache.log4j.Logger logger
logger logger, visible for all classes

mecanismeAuthentification
protected String mecanismeAuthentification
mecanismeAuthentification flag indiquate if the authentification running

request
private HttpServletRequest request
request the HTTP request

response
private HttpServletResponse response
response the HTTP response

root
private BaseActionData root
root the data return by the action

servletContext
private ServletContext servletContext
servletContext the servlet context

THIS_CLASS
protected final String THIS_CLASS
Comment for THIS_CLASS nom de la classe courante
Détail des Constructeurs
BaseAction
public BaseAction()
Détail des méthodes
getModeFonctionnement
public static String getModeFonctionnement()
Recuperation de la configuration concernant le mode de fonctionement de l'application: (mode Test Unitaire, mode Test Integration, ...)
Retours:
mode de fonctionnement

AnalyseRequest
protected void AnalyseRequest(HttpServletRequest request)
                       throws TechnicalException,
                              FunctionalException
Méthode pour les requetes en multipart avec des datas
Paramètres:
request - HttpServletRequest
Exceptions:
TechnicalException - exception technique
FunctionalException - exception d'authentification

execute
public String execute()
               throws Exception
{@inheritDoc}
Spécifié par:
execute in interface com.opensymphony.xwork2.Action
Dépacées:
execute in class com.opensymphony.xwork2.ActionSupport
Exceptions:
Exception

executeAtEnd
protected String executeAtEnd(String forward,
                              HttpServletRequest request,
                              HttpServletResponse response,
                              ArrayList beans,
                              ArrayList erreurs,
                              int typeFluxAttendu)
Méthode appelée en fin de traitement: charge la bonne liste de bean au niveau de la servlet (pour la transmettre à strutscx) et choisit la bonne feuille xsl
Paramètres:
forward - ActionForward
request - HttpServletRequest
response - HttpServletResponse
beans - ArrayList
erreurs - ArrayList
typeFluxAttendu - String le type de flux attendu par le client (XML / PDF / ...)
Retours:
ActionForward the ActionForward

executeAtStart
protected HttpSession executeAtStart(HttpServletRequest request,
                                     HttpServletResponse response,
                                     String activite)
                              throws TechnicalException
Méthode appelée au début de l'action, pour effectuer les différentes initialisations
Paramètres:
request - HttpServletRequest
response - HttpServletResponse
activite - String feuille xsl à utiliser pour cette action
Retours:
HttpSession session http
Exceptions:
TechnicalException - exception technique

getActivite
protected abstract String getActivite()
Dépréciée. use struts.xml
This method return the key to find the XSLT Stylesheet to use as view.
Retours:
StrutsCX key (XSL_KEY)

getActiviteV1
public String getActiviteV1()
Dépréciée.
Retours:
String

getBeansActions
protected abstract ArrayList getBeansActions(HttpServletRequest request)
                                      throws Exception
This method return data that will be sent to the view
Paramètres:
request - the HTTP request
Retours:
List of Serializable Object
Exceptions:
Exception

getCalandar
protected Date getCalandar()
Fonction permettant de récupérer la date du jour. Cette date est utilisé pour gérer les directives de cache dans le header HTTP.
Retours:
la date de jour

getModeFonctionnement
protected void getModeFonctionnement(HttpServletRequest request)
                              throws TechnicalException
Recuperation de la configuration concernant le mode de fonctionement de l'application: (mode Test Unitaire, mode Test Integration, ...)
Paramètres:
request - HttpServletRequest
Exceptions:
TechnicalException - exception technique

getProprietes
protected org.jdom.Element getProprietes(String propertiesFileName,
                                         String tagName)
                                  throws ConfigurationException
Trouve un élément dans un fichier de propriétés StrutsCX
Paramètres:
propertiesFileName - nom du fichier de propriétés StrutsCX
tagName - nom de l'élément à chercher
Retours:
Element
Exceptions:

getRequest
protected HttpServletRequest getRequest()
Retours:
the request

getResponse
protected HttpServletResponse getResponse()
Retours:
the response

getRoot
public BaseActionData getRoot()
Retours:
the root BaseActionData

getTypeOfFlux
protected abstract int getTypeOfFlux()
Dépréciée. use struts.xml
This method return the type of return of this action.
Retours:
Type of result

getTypeOfFluxV1
public int getTypeOfFluxV1()
Dépréciée.
Retours:
the type of Flux

setApplication
public void setApplication(Map context)
{@inheritDoc}
Spécifié par:
setApplication in interface org.apache.struts2.interceptor.ApplicationAware

setError
protected void setError(ArrayList erreurs,
                        HttpServletRequest request,
                        HttpServletResponse response,
                        Date datePassee,
                        int typeFluxAttendu)
Paramètres:
erreurs - erreurs
request - request
response - response
datePassee - datePassee
typeFluxAttendu - typeFluxAttendu

setRoot
public void setRoot(BaseActionData root)
Paramètres:
root - the root BaseActionData

setServletContext
public void setServletContext(ServletContext arg0)
{@inheritDoc}
Spécifié par:
setServletContext in interface org.apache.struts2.util.ServletContextAware

setServletRequest
public void setServletRequest(HttpServletRequest request)
{@inheritDoc}
Spécifié par:
setServletRequest in interface org.apache.struts2.interceptor.ServletRequestAware

setServletResponse
public void setServletResponse(HttpServletResponse response)
{@inheritDoc}
Spécifié par:
setServletResponse in interface org.apache.struts2.interceptor.ServletResponseAware

verifierDroitAcces
public void verifierDroitAcces(HttpServletRequest request,
                               ServletContext context,
                               String nomClasse)
                        throws AuthentificationException,
                               TechnicalException
Contrôle le droit d'accès d'un utilisateur à une action. Un utilisateur authentifié doit posséder au moins un rôle dans la liste des rôles définie dans la partie AUTHORISATIONS et la balise d'action correspondante du document variables_fr.xml. Renvoie une AuthentificationException en cas de droits insuffisants.
Paramètres:
request - HttpServletRequest requête HTTP en cours, initialisée avec les rôles de l'utilisateur.
context - ServletContext Le contexte possédant un document variables_fr.xml valide
nomClasse - String Le nom complet de la classe action.
Exceptions:
AuthentificationException - Dans le cas d'un échec d'authentification
TechnicalException - exception technique

Framework Serveur J2EE ACube V3.1.0
CLASSE PRECEDANTE CLASSE SUIVANTE
SOMMAIRE: ATTR CONSTR METH DETAIL: ATTR CONSTR METH

Version 3.1.0 du 06/11/2009 / Etat : Validé
Cette création est mise à disposition selon le Contrat Paternité - Pas d'Utilisation Commerciale - Partage des Conditions Initiales à l'Identique disponible en ligne http://creativecommons.org/licenses/by-nc-sa/2.0/fr/ ou par courrier postal à Creative Commons, 559 Nathan Abbott Way, Stanford,California 94305, USA.
Documentation generated by DocFlex