Protokoll JTalker Version 0.5:
by ChrM 26.03.2005
------------------------------

0.) Allgemein:
      * Beim JTalker-Protokoll handelt es sich um nach XML 1.0 formatierte Daten-Pakete
      * Jedes Daten-Paket muss in ein <JTALKER> Root-Tag eingebettet werden
      * Die Datenpakete dürfen _keine_ Zeilenumbrüche enthalten (CR/LF)
      * Das Prtotokoll definiert folgende Tags:
	 - <MEMBER>	: Benutzerdaten
	 - <NEW_MEMBER>	: Anweisung für den Server, einen neuen Benutzer anzulegen
	 - <MESSAGE>	: Standard-Tag für alle sonstigen Nachrichten
	 
      Alle Tags werden nachfolgend näher spezifiziert.


-------------------------------------------------------
1.) Server connection -> Willkommen-String.
	 Empfangen:
	       "<JTALKER>
		  <MESSAGE content="Welcome on JTalker-Server" type="info" />
	        </JTALKER>"

		
-------------------------------------------------------
2.) Login.
	Senden: 
	       "<JTALKER>
		  <MEMBER name="UserB" passwd="passwd" [status="normal"] [type="webclient"] />
	        </JTALKER>"
		
		bzw.:
		
		"<JTALKER>
		  <MEMBER sid="asjadf6434gi8sdfk" />
	        </JTALKER>"
	
	Erklärung:
	 Mit Hilfe des <MEMBER>-Tags leitet man das Login ein.
	 * name:     Beinhaltet den User-Namen.
         * passwd:   User Passwort
	 * status:   Staus des Users, zB: "normal" oder "busy". Default ist "normal"
	 * type:     Gibt den Verbindugstypen an. Default ist "persistent".
	 * sid:      Session ID der letzten Session (nur für Webclients)
	 
	 Als Antwort sendet der Server entweder eine Fehlermeldung (Login nicht möglich),
	 oder eine Information, die die Session-ID beinhaltet (nur beim type="webclient") und 
	 die Liste aller gerade angemeldeten User (siehe 3.).

-------------------------------------------------------
3.) Liste eingelogter User:
	Empfangen: 
	       "<JTALKER>
		  <MEMBER name="UserA" status="normal" ip="192.168.0.1" />
		  <MEMBER name="CHAT01" status="busy" ip="192.168.0.2" [type="chatroom"] />
	        </JTALKER>"
	
        Erklärung:
	 Das <MEMBER>-Tag liefert Status-Informationen über die gerade angemeldeten Benutzer.
	 * name:     Beinhaltet den User-Namen.
	 * status:   Staus des Users, zB: "normal" oder "busy"
	 * ip:	     Die IP-Adresse des User-Rechners, zB.: "127.0.0.1"
	 * type:     Gibt den speziellen User-Typen an. Dieser wird nur angegeben, wenn der 
		     User eine besondere Aufgabe hat, zB.: "chatroom".
      

-------------------------------------------------------
4.) Account erzeugen.
	Senden: 
	       "<JTALKER>
		  <NEW_MEMBER name="UserB" passwd="md5hash" />
	        </JTALKER>"


-------------------------------------------------------
5.) Messages ->
        Senden:
	       "<JTALKER>
		  <MESSAGE content="Nachrichtentext" 
		     [to="empf1;;empf2"] 
		     [type="[normal|error|info|command|file|command_response]"] 
		     [subject="..."] 
		     [sid="..."] />
	        </JTALKER>"
	 
        Erklärung:
	 * content:  Inhalt der Nachricht (ohne Zeilenumbrüche). Sie kann HTML enthalten
	 * to:	     Empfänger der Nachricht. Sind keine angegeben, fühlt sich der Server selbst
		     für diese Nachricht zuständig (zB. ein Server-Kommando).
		     Geht die Nachricht an mehrere Empf�ger, so werden diese durch ";;" getrennt
		     angegeben.
	 * type:     Typ der Nachricht. Ist kein Typ angegeben, wird der Typ "normal" angenommen.
		     Der Typ "normal" kenzeichnet eine normal Text-Mitteilung. Weitere Typen
		     sind: error, info, command oder file. Mit "command" wird ein Kommando verschickt.
		     Ein Kommando hat folgende Syntax: "modul::funktion(param1, param2)".
		     Eine Funktion kann keinen, einen oder mehrere Parameter enthalten. Alle Parameter
		     sind vom Typ String und mssen in "" gesetzt werden.
		     Welche Funktionen ein Modul zur Verfgung stellt, erfahren Sie mit der Funktion:
		     "modul::getMethods()". Der Rückgabewert ist vom type="command_response".
		     Mit "file" wird eine Datei versendet. Die Daten sind innerhalb des "content"
		     Properties eingebettet und nach BASE64 kodiert.
	 * subject:  Mit "subject" kann ein Titel (oder zB. Dateiname) passend zu dem "content"
		     übertragen werden.
	 * sid:	     Wird bei einer Anmeldung mit einem Webclient (nicht persistent) vom Server
		     gesendet und beinhaltet die Session-ID
	 
	Senden (Bsp.): 
	       "<JTALKER>
		  <MESSAGE content="Eine Nachricht" to="UserB;;UserN" type="normal"/>
	        </JTALKER>"
	
        Empfangen (Bsp.): 
	 "<JTALKER>
	       <MEMBER name="UserA" ip="192.168.0.1" />
	       <MEMBER name="UserB" ip="192.168.0.2" />
	       <MESSAGE content="Eine Nachricht1" sender="UserA" type="normal" />
	       <MESSAGE content="Eine Nachricht2" sender="UserC" type="normal" />
	       <MESSAGE content="plugin::foo()" sender="UserD" type="command" />
	       <MESSAGE content="Server OS is Linux" sender="UserD" type="command_response" />
	 </JTALKER>"


-------------------------------------------------------
6) Meldungen (Fehler/Information) ->
	 Empfangen:
	       "<JTALKER>
		  <MESSAGE content="NO XML-STREAM! Try again!" 
			   [sender="..."] 
			   type="error" />
	       </JTALKER>"
	 bzw:
	       "<JTALKER>
		  <MESSAGE content="Account successfully created." 
			   [sender="..."] 
			   type="info" />
	       </JTALKER>"



--------------------------------------------------------------

Server-Kommunikation Ablaufdiagramm.
   
   Legende:
   (>) Server Antwort
   (<) Gesendete Daten


   * CONNECT +--(>) GREETING --+--(<) LOGIN --+--(>) USER_LIST --+--(<) MESSAGES
                               |              |                  |
			       |              |                  +--(<) USER_STATUS
			       |              |
			       |              +--(>) ERROR/INFO
                               |
			       +--(<) CREATE_ACCOUNT --(>) ERROR/INFO -->DISCONNECT