channels 1.0
API Documentation
A C D F G I L M O R S T

A

Action - class org.esupportail.portal.utils.channels.Action.
Action

Cette classe décrit une action que peut effectuer la channel
Les actions de la channel sont référencées dans une haspmap accessible à partir de l'objet configActions de la classe principale du channel.
Action() - Constructor for class org.esupportail.portal.utils.channels.Action
 
addAction(Action) - Method in class org.esupportail.portal.utils.channels.ConfigChannel
Méthode appelée par le digester lorsqu'une action a été lue dans le fichier de config
addDefaultXslParameters() - Method in class org.esupportail.portal.utils.channels.SubChannel
Ajoute des paramètres XSL par défaut aux paramètres existant baseActionURL = url vers la channel en cours prefForm = prefixe à utiliser dans la feuille xslt pour s'assurer de l'unicité du nom des objects javascript mediaPath = chemins d'accès aux médias (images)
addPool(Database) - Method in class org.esupportail.portal.utils.channels.ConfigChannel
Méthode appelée par le digester lorsqu'un pool a été lu dans le fichier de config

C

CHANNEL_CACHE_TYPE - Static variable in class org.esupportail.portal.utils.channels.Action
 
ConfigChannel - class org.esupportail.portal.utils.channels.ConfigChannel.
ConfigChannel

Classe permettant d'accéder à la configuration de la channel CAdresses

(c)Copyright CRI Nancy 2 2004
calcCurrentAction(ChannelRuntimeData) - Method in class org.esupportail.portal.utils.channels.MainChannel
Détermination de l'action en cours à partir des paramères HTTP
callInit(ISubChannel, Action, ChannelRuntimeData) - Static method in class org.esupportail.portal.utils.channels.SubChannelFactory
Appel de la méthode init d'une action (méthode 1/3 du cycle de vie)
callSetOutput(ISubChannel, Action, ChannelRuntimeData) - Static method in class org.esupportail.portal.utils.channels.SubChannelFactory
Appel de la méthode setOutput d'une action (méthode 3/3 du cycle de vie)
callSetXML(ISubChannel, Action, ChannelRuntimeData) - Static method in class org.esupportail.portal.utils.channels.SubChannelFactory
Appel de la méthode setXML d'une action (méthode 2/3 du cycle de vie)
clearChannel() - Method in interface org.esupportail.portal.utils.channels.ISubChannel
Méthode appellée lorsque la channel est réutilisée.
clearChannel() - Method in class org.esupportail.portal.utils.channels.SubChannel
 
clearChannelsMap() - Method in class org.esupportail.portal.utils.channels.MainChannel
Effacement de la liste des subChannels déjà instanciées
clearServantResults() - Method in class org.esupportail.portal.utils.channels.MainChannel
Mise à null du résultat d'un servant

D

DEFAULT_CACHE_TYPE - Static variable in class org.esupportail.portal.utils.channels.Action
 

F

FatalError - class org.esupportail.portal.utils.channels.plugins.FatalError.
Ce plug-in ajoute une page qui permet d'afficher un message d'erreur fatale

(c)Copyright ESup-Portail 2004
FatalError(MainChannel) - Constructor for class org.esupportail.portal.utils.channels.plugins.FatalError
Constructeur
fatalError(HashMap, String) - Static method in class org.esupportail.portal.utils.channels.plugins.FatalError
Méthode statique qui efface toutes les actions pour ne laisser que le plug-in d'erreur fatale comme page par défaut (à faire avant le setruntimedata)

G

generateKey() - Method in class org.esupportail.portal.utils.channels.MainChannel
 
generateKey() - Method in class org.esupportail.portal.utils.channels.SubChannel
 
getActions() - Method in class org.esupportail.portal.utils.channels.ConfigChannel
 
getActions() - Method in interface org.esupportail.portal.utils.channels.IConfigActions
La liste des actions liée à la configuration
getCachetype() - Method in class org.esupportail.portal.utils.channels.Action
Le type de cache
getClassname() - Method in class org.esupportail.portal.utils.channels.Action
Le nom complet de la classe à instancier pour l'action (DOIT ETRE UNIQUE pour une channel)
getConfigActions() - Method in class org.esupportail.portal.utils.channels.MainChannel
Retourne une référence vers la configuration des actions
getCurrentAction() - Method in class org.esupportail.portal.utils.channels.MainChannel
Action en cours
getDefaultCacheKey() - Method in class org.esupportail.portal.utils.channels.MainChannel
Retourne la clé par défaut du cache pour l'action en cours
getDefaultCacheValid(Object) - Method in class org.esupportail.portal.utils.channels.MainChannel
 
getInit() - Method in class org.esupportail.portal.utils.channels.Action
Le nom de la méthode d'initialisation de l'action (init par défaut)
getMainChannel() - Method in class org.esupportail.portal.utils.channels.SubChannel
Récupére l'instance de la channel principale
getMediaPath() - Method in class org.esupportail.portal.utils.channels.SubChannel
Retourne le chemin d'accès aux médis
getName() - Method in class org.esupportail.portal.utils.channels.Action
Le nom de l'action
getPackageName(Class) - Static method in class org.esupportail.portal.utils.channels.SubChannel
Retourne le nom du package en cours
getParam() - Method in class org.esupportail.portal.utils.channels.Action
Le paramètre associé à l'action
getPools() - Method in class org.esupportail.portal.utils.channels.ConfigChannel
 
getPrefForm() - Method in class org.esupportail.portal.utils.channels.MainChannel
Retourne l'identifiant à utiliser dans les pages html pour les noms d'objets
getPrefParam(String) - Method in class org.esupportail.portal.utils.channels.MainChannel
Permet de rendre unique un nom de paramètre en le préfixant par l'identifiant unique de la classe
getPreviousAction() - Method in class org.esupportail.portal.utils.channels.MainChannel
Action précédente
getRenderType() - Method in class org.esupportail.portal.utils.channels.Action
Le type de rendu de l'action : xsl ou ssl (xsl par défaut)
getRenderXML() - Method in class org.esupportail.portal.utils.channels.Action
Le nom de la méthode qui fait le rendu XML pour l'action (renderXML par défaut)
getRuntimeData() - Method in class org.esupportail.portal.utils.channels.SubChannel
Récupère les runtimeData de la sous-channel
getSSL() - Method in interface org.esupportail.portal.utils.channels.ISubChannel
Récupère le fichier SSL à utiliser lors la transformation XSLT
getSSL() - Method in class org.esupportail.portal.utils.channels.SubChannel
 
getServantResults() - Method in class org.esupportail.portal.utils.channels.MainChannel
Donne le résultat du servant
getServantfinish() - Method in class org.esupportail.portal.utils.channels.Action
Le nom de l'action à initier lorsque le servant est terminé
getSetOutput() - Method in class org.esupportail.portal.utils.channels.Action
Le nom de la méthode qui fixe les paramètres de rendu xml (setOutput par défaut)
getSetXML() - Method in class org.esupportail.portal.utils.channels.Action
Le nom de la méthode qui fixe le XML pour le rendu (setXML par défaut)
getSslFile() - Method in class org.esupportail.portal.utils.channels.Action
Le nom du fichier ssl à utiliser lorsque l'action est du type ssl (null par défaut)
getSslTitle() - Method in class org.esupportail.portal.utils.channels.Action
Le "title" à utiliser dans la feuille ssl lorsque l'action est du type ssl
getStaticData() - Method in class org.esupportail.portal.utils.channels.MainChannel
Retourne les staticData de la channel principale
getType() - Method in class org.esupportail.portal.utils.channels.Action
Le type de l'action (normal ou servant / normal par défaut)
getXML() - Method in interface org.esupportail.portal.utils.channels.ISubChannel
Récupère le XML à utiliser lors de l'affichage
getXML() - Method in class org.esupportail.portal.utils.channels.SubChannel
 
getXSL() - Method in interface org.esupportail.portal.utils.channels.ISubChannel
Récupère le fichier XSL à utiliser lors de l'affichage
getXSL() - Method in class org.esupportail.portal.utils.channels.SubChannel
 
getXSLParameter() - Method in interface org.esupportail.portal.utils.channels.ISubChannel
Récupère les paramètres à passer à la feuille XSL
getXSLParameter() - Method in class org.esupportail.portal.utils.channels.SubChannel
 
getXslFile() - Method in class org.esupportail.portal.utils.channels.Action
Le nom du fichier xsl à utiliser lorsque l'action est du type xsl (par défaut getName() + ".xsl")

I

IConfigActions - interface org.esupportail.portal.utils.channels.IConfigActions.
IConfigActions

Interface décrivant les méthodes que doit implémenter une classe de configuration pour une channel utilisant le principe des actions

(c)Copyright ESup-Portail 2004
INSTANCE_CACHE_TYPE - Static variable in class org.esupportail.portal.utils.channels.Action
 
ISubChannel - interface org.esupportail.portal.utils.channels.ISubChannel.
ISubChannel

Interface qui décrit les méthodes que doit implémenter une sous-channel (SubChannel)

(c)Copyright ESup-Portail 2004
init(ChannelRuntimeData) - Method in interface org.esupportail.portal.utils.channels.ISubChannel
Dans le cycle de vie d'une SubChannel, intervient en tout premier, juste après l'instanciation
init(ChannelRuntimeData) - Method in class org.esupportail.portal.utils.channels.SubChannel
 
initServant(IServant) - Method in class org.esupportail.portal.utils.channels.MainChannel
Initialisation du servant Cette méthode est appellée par ServantFactory juste après l'instanciation du servant.
instantiateAction(MainChannel, Action) - Static method in class org.esupportail.portal.utils.channels.SubChannelFactory
Méthode statique qui permet d'instancier une SubChannel correspondant à une action
instantiateServant(MainChannel, Action) - Static method in class org.esupportail.portal.utils.channels.ServantFactory
Méthode statique qui permet d'instancier une SubChannel correspondant à une action
isCacheValid(Object) - Method in class org.esupportail.portal.utils.channels.MainChannel
 
isCacheValid(Object) - Method in class org.esupportail.portal.utils.channels.SubChannel
 
isCurrentAction(String) - Method in class org.esupportail.portal.utils.channels.MainChannel
Permet de tester si l'action en cours est celle dont le nom est passé en paramètre
isInCache() - Method in class org.esupportail.portal.utils.channels.MainChannel
Indique si le cache est actif
isServant() - Method in class org.esupportail.portal.utils.channels.Action
Indique si l'action en cours est un servant

L

logConfigActions() - Method in class org.esupportail.portal.utils.channels.MainChannel
Loggue les actions de la channel dans le log uPortal
logParams() - Method in class org.esupportail.portal.utils.channels.MainChannel
Loggue les paramètres runtimeData reçus par la MainChannel A retrouver dans le log principale uPortal

M

MainChannel - class org.esupportail.portal.utils.channels.MainChannel.
MainChannel

Implémentation "type" d'une classe principale d'un channel (MainChannel)

(c)Copyright ESup-Portail 2004
MainChannel() - Constructor for class org.esupportail.portal.utils.channels.MainChannel
 
Message - class org.esupportail.portal.utils.channels.plugins.Message.
Message

Ce plug-in ajoute une page qui permet d'afficher un message (une ou plusieurs lignes avec des puces) et un bouton ok qui renvoie vers une nouvelle action
Cela correspond à une fenêtre de confirmation

(c)Copyright ESup-Portail 2004
Message(MainChannel) - Constructor for class org.esupportail.portal.utils.channels.plugins.Message
Constructeur
message(MainChannel, ChannelRuntimeData, String, String) - Static method in class org.esupportail.portal.utils.channels.plugins.Message
Méthode statique qui permet d'afficher la page avec un message sur une ligne
message(MainChannel, ChannelRuntimeData, Vector, String) - Static method in class org.esupportail.portal.utils.channels.plugins.Message
Méthode statique qui permet d'afficher la page avec une liste de messages

O

org.esupportail.portal.utils.channels - package org.esupportail.portal.utils.channels
 
org.esupportail.portal.utils.channels.plugins - package org.esupportail.portal.utils.channels.plugins
 

R

RENDER_TYPE_SSL - Static variable in class org.esupportail.portal.utils.channels.Action
 
RENDER_TYPE_XSL - Static variable in class org.esupportail.portal.utils.channels.Action
 
redirect(ChannelRuntimeData, String) - Method in class org.esupportail.portal.utils.channels.MainChannel
Effectue une "redirection" depuis une action vers une autre Attention : cette redirection ne peut-être faite que dans les méthode init, setXML ou setOutput!!!
register(HashMap) - Static method in class org.esupportail.portal.utils.channels.plugins.FatalError
Méthode statique qui permet d'enregistrer le plug-in Todo dans la liste des actions d'une channel
register(HashMap) - Static method in class org.esupportail.portal.utils.channels.plugins.Message
Méthode statique qui permet d'enregistrer le plug-in message dans la liste des actions d'une channel
register(HashMap) - Static method in class org.esupportail.portal.utils.channels.plugins.Todo
Méthode statique qui permet d'enregistrer le plug-in Todo dans la liste des actions d'une channel
renderXML(ContentHandler) - Method in interface org.esupportail.portal.utils.channels.ISubChannel
Fait le rendu xml.
renderXML(ContentHandler) - Method in class org.esupportail.portal.utils.channels.MainChannel
Rendu XML/XSLT de la channel principale qui consiste en une déléguation du rendu soit à la sous-channel en cours soit au servant en cours La MainChannel n'effectue pas de rendu propre.
renderXML(ContentHandler) - Method in class org.esupportail.portal.utils.channels.SubChannel
 

S

ServantFactory - class org.esupportail.portal.utils.channels.ServantFactory.
ServantFactory

"Usine" qui fabrique des Servant à la demande d'une MainChannel

(c)Copyright ESup-Portail 2004
ServantFactory() - Constructor for class org.esupportail.portal.utils.channels.ServantFactory
 
SubChannel - class org.esupportail.portal.utils.channels.SubChannel.
SubChannel

Classe abstraite qui propose une implémentation "type" de l'interface ISubChannel

(c)Copyright ESup-Portail 2004
SubChannel(MainChannel) - Constructor for class org.esupportail.portal.utils.channels.SubChannel
Constructeur d'une SubChannel Positionne une référence vers la channel principale
SubChannelFactory - class org.esupportail.portal.utils.channels.SubChannelFactory.
SubChannelFactory

"Usine" qui fabrique des SubChannel à la demande d'une MainChannel

(c)Copyright ESup-Portail 2004
SubChannelFactory() - Constructor for class org.esupportail.portal.utils.channels.SubChannelFactory
 
setActions(HashMap) - Method in class org.esupportail.portal.utils.channels.ConfigChannel
 
setActions(HashMap) - Method in interface org.esupportail.portal.utils.channels.IConfigActions
Positionne la liste des actions liée à la configuration
setCachetype(String) - Method in class org.esupportail.portal.utils.channels.Action
Positionne le type de cache
setClassname(String) - Method in class org.esupportail.portal.utils.channels.Action
Positionnement du nom de la classe de l'action
setConfigActions(IConfigActions) - Method in class org.esupportail.portal.utils.channels.MainChannel
Positionne la référence vers la configuration des actions
setDefaultXslParameters() - Method in class org.esupportail.portal.utils.channels.SubChannel
Efface les paramètres XSL en cours et ajoute ceux par défaut
setInit(String) - Method in class org.esupportail.portal.utils.channels.Action
Positionnement de la méthode d'initialisation de l'action
setName(String) - Method in class org.esupportail.portal.utils.channels.Action
Positionnement du nom de l'action
setOutput() - Method in interface org.esupportail.portal.utils.channels.ISubChannel
Avant-derniere méthode appelée lors du cycle de vie d'une sous-channel Permet de positionner le nom du fichier xsl ou ssl
setOutput() - Method in class org.esupportail.portal.utils.channels.SubChannel
 
setParam(Object) - Method in class org.esupportail.portal.utils.channels.Action
Positionne le paramètre associé à l'action
setPools(HashMap) - Method in class org.esupportail.portal.utils.channels.ConfigChannel
 
setRendertype(String) - Method in class org.esupportail.portal.utils.channels.Action
Positionnement du type de rendu de l'action
setRenderxml(String) - Method in class org.esupportail.portal.utils.channels.Action
Positionnement du nom de la méthode qui assure le rendu XML pour l'action
setRuntimeData(ChannelRuntimeData) - Method in class org.esupportail.portal.utils.channels.MainChannel
Positionnement des RuntimeData Il s'agit du "coeur" du processus qui va soit : - Instancier(ou réutiliser) une sous-channel et lancer son cycle de vie : init/setXML/setOutput - Instancier un servant ou passer la main au servant déjà instancié
setSSL(String) - Method in interface org.esupportail.portal.utils.channels.ISubChannel
Positionne la feuille ssl (null si pas de feuille ssl)
setSSL(String) - Method in class org.esupportail.portal.utils.channels.SubChannel
 
setServantfinish(String) - Method in class org.esupportail.portal.utils.channels.Action
Positionnement du nom l'action à initier lorsque le servant est terminé
setSetoutput(String) - Method in class org.esupportail.portal.utils.channels.Action
Positionnement du nom de la méthode qui fixe les paramètres de rendu XML
setSetxml(String) - Method in class org.esupportail.portal.utils.channels.Action
Positionnement du XML à utiliser dans la transformation XSLT
setSslfile(String) - Method in class org.esupportail.portal.utils.channels.Action
Positionnement du nom du fichier ssl
setSsltitle(String) - Method in class org.esupportail.portal.utils.channels.Action
Positionnement du title à utiliser dans la feuille ssl
setType(String) - Method in class org.esupportail.portal.utils.channels.Action
Positionnement du type de l'action (normal ou servant)
setXML(String) - Method in interface org.esupportail.portal.utils.channels.ISubChannel
Positionne la valeur du xml
setXML() - Method in interface org.esupportail.portal.utils.channels.ISubChannel
Dans le cycle de vie d'une sous-channel, méthode qui est appelée après l'initiation
setXML(String) - Method in class org.esupportail.portal.utils.channels.SubChannel
 
setXML() - Method in class org.esupportail.portal.utils.channels.SubChannel
 
setXML() - Method in class org.esupportail.portal.utils.channels.plugins.FatalError
Positionnement du XML pour le plug-in
setXML() - Method in class org.esupportail.portal.utils.channels.plugins.Message
Positionnement du XML pour le plug-in
setXML() - Method in class org.esupportail.portal.utils.channels.plugins.Todo
Positionnement du XML pour le plug-in
setXSL(String) - Method in interface org.esupportail.portal.utils.channels.ISubChannel
Positionne la valeur du fichier xsl
setXSL(String) - Method in class org.esupportail.portal.utils.channels.SubChannel
 
setXSLParameter(Hashtable) - Method in interface org.esupportail.portal.utils.channels.ISubChannel
Positionne les paramètres de la feuille Xsl
setXSLParameter(Hashtable) - Method in class org.esupportail.portal.utils.channels.SubChannel
 
setXslfile(String) - Method in class org.esupportail.portal.utils.channels.Action
Positionnement du nom du fichier xsl
stack2string(Exception) - Static method in class org.esupportail.portal.utils.channels.SubChannelFactory
Récupération de la stacktrace dans une string suite à une exception lors de l'invocation dynamaique de méthodes

T

Todo - class org.esupportail.portal.utils.channels.plugins.Todo.
Todo

Ce plug-in ajoute une page qui permet d'afficher un message qui dit que la fonctionnalité reste à développer
Utile pour mettre en place rapidement le squelette d'une application avec toutes ses actions mêmes si elles ne sont pas encore développées

(c)Copyright ESup-Portail 2004
Todo(MainChannel) - Constructor for class org.esupportail.portal.utils.channels.plugins.Todo
Constructeur
todo(MainChannel, ChannelRuntimeData, String) - Static method in class org.esupportail.portal.utils.channels.plugins.Todo
Méthode statique qui permet d'afficher la page du plug-in

A C D F G I L M O R S T
channels 1.0
API Documentation