submarine.core
Class ChannelInfos

java.lang.Object
  |
  +--submarine.core.ChannelInfos
All Implemented Interfaces:
java.io.Serializable

public class ChannelInfos
extends java.lang.Object
implements java.io.Serializable

Informations de configuration d'un Channel.

Ces informations sont externalisées dans cette classe plutôt que directement dans la classe Channel car un Channel doit être "poolable" donc potentiellement sans état.

See Also:
Channel.init(submarine.core.ChannelInfos), Serialized Form

Field Summary
 boolean[] archive
          Un tableau de 4 boolean pour paraméter ce qui doit être archivé.
 java.lang.String destination
          La destination du Channel.
 java.lang.String errorWriterName
          Le nom de la WritingFunction servant à traiter les erreur su ce Channel.
static int IN
          Le message java.lang.Object entrant.
static int IN_XML
          Le message org.w3c.xml.Document entrant.
 java.lang.String msgType
          Le type du message.
 java.lang.String name
          Le nom du Channel.
static int OUT
          Le message java.lang.Object sortant, le résultat de la fonction Channel.submit(java.lang.Object, submarine.core.RouteInfos, submarine.core.Message.MsgContext, submarine.core.ChannelInfos).
static int OUT_XML
          Le message org.w3c.xml.Document sortant, après la transformation XSL.
 java.lang.String parserClassName
          Le nom complet de la classe qui doit implémenter Serializer pour le parsing vers XML.
 java.lang.String serializerClassName
          Le nom complet de la classe qui doit implémenter Serializer pour la serialisation depuis XML.
 java.lang.String source
          La source du Channel.
 java.lang.String writerName
          Le nom de la WritingFunction servant à transmettre le message transformé à la destination.
 org.w3c.dom.Element xmlParserConfig
          L'element xml pour la configuration du parser.
 org.w3c.dom.Element xmlSerializerConfig
          L'element xml pour la configuration du sérialiser.
 XSLTransformInfos xslInfos
          Les informations relatives à la transformation XSL.
 
Constructor Summary
ChannelInfos()
          Construit une nouvelle instance vide.
ChannelInfos(org.w3c.dom.Element xml)
          Contruit une nouvelle instance à partir d'un élément XML.
 
Method Summary
 void init(org.w3c.dom.Element xml)
          Initialise l'instance de l'objet depuis un element XML.
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

IN

public static final int IN
Le message java.lang.Object entrant. Code pour EAISystem.archive(java.lang.String, java.lang.Object, submarine.core.Message.MsgContext, int).

IN_XML

public static final int IN_XML
Le message org.w3c.xml.Document entrant. Code pour EAISystem.archive(java.lang.String, java.lang.Object, submarine.core.Message.MsgContext, int).

OUT

public static final int OUT
Le message java.lang.Object sortant, le résultat de la fonction Channel.submit(java.lang.Object, submarine.core.RouteInfos, submarine.core.Message.MsgContext, submarine.core.ChannelInfos). Code pour EAISystem.archive(java.lang.String, java.lang.Object, submarine.core.Message.MsgContext, int).

OUT_XML

public static final int OUT_XML
Le message org.w3c.xml.Document sortant, après la transformation XSL. Code pour EAISystem.archive(java.lang.String, java.lang.Object, submarine.core.Message.MsgContext, int).

name

public java.lang.String name
Le nom du Channel.
See Also:
EAISystem.selectChannels(submarine.core.RouteInfos)

msgType

public java.lang.String msgType
Le type du message.
See Also:
EAISystem.selectChannels(submarine.core.RouteInfos)

parserClassName

public java.lang.String parserClassName
Le nom complet de la classe qui doit implémenter Serializer pour le parsing vers XML. Dans ce cas seule la fonction Serializer.serializeObject(java.lang.Object) sera utilisée.

source

public java.lang.String source
La source du Channel.
See Also:
EAISystem.selectChannels(submarine.core.RouteInfos)

serializerClassName

public java.lang.String serializerClassName
Le nom complet de la classe qui doit implémenter Serializer pour la serialisation depuis XML. Dans ce cas seule la fonction Serializer.serializeXML(org.w3c.dom.Document) sera utilisée.

destination

public java.lang.String destination
La destination du Channel.
See Also:
EAISystem.selectChannels(submarine.core.RouteInfos)

writerName

public java.lang.String writerName
Le nom de la WritingFunction servant à transmettre le message transformé à la destination.

errorWriterName

public java.lang.String errorWriterName
Le nom de la WritingFunction servant à traiter les erreur su ce Channel. Facultatif.

archive

public boolean[] archive
Un tableau de 4 boolean pour paraméter ce qui doit être archivé. Si archive[x] est vrai alors l'archive de l'étape x sera réalisée. x prend les valeurs IN, IN_XML, OUT, OUT_XML.

xslInfos

public XSLTransformInfos xslInfos
Les informations relatives à la transformation XSL.
See Also:
XSLTransformInfos

xmlParserConfig

public org.w3c.dom.Element xmlParserConfig
L'element xml pour la configuration du parser. Cet élément est envoyé à la fonction XMLConfigurable.init(org.w3c.dom.Element) pour le parser.

xmlSerializerConfig

public org.w3c.dom.Element xmlSerializerConfig
L'element xml pour la configuration du sérialiser. Cet élément est envoyé à la fonction XMLConfigurable.init(org.w3c.dom.Element) pour le parser.
Constructor Detail

ChannelInfos

public ChannelInfos()
Construit une nouvelle instance vide.

ChannelInfos

public ChannelInfos(org.w3c.dom.Element xml)
Contruit une nouvelle instance à partir d'un élément XML.
Parameters:
xml - L'élément XML contenant les informations.
See Also:
pour la structure de l'élément xml.
Method Detail

init

public void init(org.w3c.dom.Element xml)
Initialise l'instance de l'objet depuis un element XML. La syntaxe de l'élément XML est la suivante :
 <!-- un élément quelconque, la méthode ne le teste pas -->
 <element name="nom du Channel">
 	<msgType>Le type du message</msgType>
 	<parser class="package.class"/> 
 		<!-- class="eai-empty" pour ne pas avoir de parser. 
 			Dans ce cas le Channel tente de caster le message 
 			en entrée en un document XML --> 
 		<!-- voir Serializer -->
 	<source>Le nom de la source</source>
 	<xsl-template> <!-- XSLTransformInfos.XSLTransformInfos(Element) 
 --> 
 		<file>file/subdir/stylesheet.xsl</file> 
 	</xsl-template>
 	<serializer class="package.class"/> <!-- class="eai-empty" pour ne pas 
 			avoir de serializer. Dans ce cas le Channel transmet le document XML à la 
 			WritingFunction --> <!-- voir Serializer -->
 	<destination>Le nom de la destination</destination> 
 	<writer>le nom de la WritingFunction</writer><!-- voir EAISystem.setConfig(java.lang.String) -->
 	<on-error-writer>name</on-error-writer>
 		<!-- le nom de la WritingFunction pour le traitement des erreurs -->
 	<archive in="yes" in.xml="yes" out.xml="yes" out="yes"/> <!-- 
 défini quel 
 résulat d'étape doit être archivé. voir EAISystem.archive(java.lang.String, java.lang.Object, submarine.core.Message.MsgContext, int) -->
 </element>
 
Parameters:
xml - l'élément XML dans lequel sera lue la configuration.

Submarine project. free distribution of this software must include the opensource licence.
Guénolé de Cadoudal.