Explorar el Código

Added some documentation about presence in ser.
Will be improved continuously.

Vaclav Kubart hace 20 años
padre
commit
d704f613bc
Se han modificado 4 ficheros con 220 adiciones y 0 borrados
  1. 7 0
      doc/doc_root.xml
  2. 110 0
      doc/presence/biblio.xml
  3. 68 0
      doc/presence/presence.xml
  4. 35 0
      doc/presence/presence_book.xml

+ 7 - 0
doc/doc_root.xml

@@ -32,6 +32,12 @@
 	<xi:include href="seruser/seruser.xml"/>
     </chapter>
 
+    <chapter>
+	<title>Presence Handbook</title>
+	<xi:include href="presence/presence.xml"/>
+	<xi:include href="presence/biblio.xml"/>
+    </chapter>
+	
     <chapter>
     	<title>Module Documentation</title>
 	<xi:include href="../modules/acc/doc/acc.xml"/>
@@ -65,6 +71,7 @@
 	<xi:include href="../modules/pike/doc/pike.xml"/>
 	<xi:include href="../modules/print/doc/print.xml"/>
 	<xi:include href="../modules/registrar/doc/registrar.xml"/>
+	<xi:include href="../modules/rls/doc/rls.xml"/>
 	<xi:include href="../modules/rr/doc/rr.xml"/>
 	<xi:include href="../modules/sl/doc/sl.xml"/>
 	<xi:include href="../modules/sms/doc/sms.xml"/>

+ 110 - 0
doc/presence/biblio.xml

@@ -0,0 +1,110 @@
+<?xml version='1.0' encoding='UTF-8'?>
+
+<!DOCTYPE bibliography PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
+   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<!--********************** BILBIOGRAPHY ***************************-->
+
+<bibliography id="pres_biblio">
+
+<bibliodiv><title>XCAP</title>
+
+<biblioentry id="pres_draft_xcap">
+<abbrev>xcap</abbrev>
+<title><ulink url="http://www.ietf.org/internet-drafts/draft-ietf-simple-xcap-07.txt"
+>draft-ietf-simple-xcap-07.txt</ulink> - XCAP specification</title></biblioentry>
+
+<biblioentry id="pres_draft_xcap_change">
+<abbrev>xcap_diff</abbrev>
+<title><ulink url="http://www.ietf.org/internet-drafts/draft-ietf-simple-xcap-diff-01.txt"
+>draft-ietf-simple-xcap-diff-01.txt</ulink> - XCAP changes notifications format</title>
+</biblioentry>
+
+<biblioentry>
+<abbrev>xcap_profiles</abbrev>
+<title><ulink url="http://www.ietf.org/internet-drafts/draft-ietf-sipping-config-framework-07.txt"
+>draft-ietf-sipping-config-framework-07.txt</ulink> -XCAP user profiles</title>
+</biblioentry>
+
+</bibliodiv>
+
+<bibliodiv><title>Presence</title>
+
+<biblioentry id="pres_rfc_events">
+<abbrev>events</abbrev>
+<title><ulink url="http://www.ietf.org/rfc/rfc3265.txt">RFC 3265 - SIP Events</ulink></title>
+</biblioentry>
+
+<biblioentry id="pres_rfc_presence">
+<abbrev>presence</abbrev>
+<title><ulink url="http://www.ietf.org/rfc/rfc3856.txt">RFC 3856 - Presence Event 
+package</ulink></title>
+</biblioentry>
+
+<biblioentry id="pres_rfc_pidf">
+<abbrev>pidf</abbrev>
+<title><ulink url="http://www.ietf.org/rfc/rfc3863.txt">RFC 3863 - Presence Information 
+Data Format</ulink></title>
+</biblioentry>
+
+<biblioentry id="pres_rfc_publish">
+<abbrev>pidf</abbrev>
+<title><ulink url="http://www.ietf.org/rfc/rfc3903.txt">RFC 3903 - Event state 
+publication</ulink></title>
+</biblioentry>
+
+<biblioentry id="pres_rfc_winfo">
+<abbrev>winfo</abbrev>
+<title><ulink url="http://www.ietf.org/rfc/rfc3857.txt">RFC 3857 - Watcher info event 
+package</ulink></title>
+</biblioentry>
+
+<biblioentry id="pres_rfc_winfo_doc">
+<abbrev>winfo_doc</abbrev>
+<title><ulink url="http://www.ietf.org/rfc/rfc3858.txt">RFC 3858 - Data Format for watcher
+info</ulink></title>
+</biblioentry>
+
+<biblioentry>
+<abbrev>reg</abbrev>
+<title><ulink url="http://www.ietf.org/rfc/rfc3680.txt">RFC 3680 - SIP Reg Events</ulink></title>
+</biblioentry>
+
+</bibliodiv>
+
+<bibliodiv><title>Authorization</title>
+<biblioentry id="pres_draft_common_auth">
+<abbrev>common auth</abbrev>
+<title><ulink
+url="http://www.ietf.org/internet-drafts/draft-ietf-geopriv-common-policy-05.txt"
+>draft-ietf-geopriv-common-policy-05.txt</ulink></title>
+</biblioentry>
+
+<biblioentry id="pres_draft_auth">
+<abbrev>presence auth</abbrev>
+<title><ulink url="http://www.ietf.org/internet-drafts/draft-ietf-simple-presence-rules-03.txt"
+>draft-ietf-simple-presence-rules-03.txt</ulink> - presence authorization XML based data format 
+and usage with XCAP</title>
+</biblioentry>
+</bibliodiv>
+
+<bibliodiv><title>Resource lists</title>
+
+<biblioentry id="pres_draft_rls">
+<abbrev>rls</abbrev>
+<title><ulink url="http://www.ietf.org/internet-drafts/draft-ietf-simple-xcap-list-usage-05.txt"
+>draft-ietf-simple-xcap-list-usage-05.txt</ulink> - XML formats for representing resource 
+lists</title>
+</biblioentry>
+
+<biblioentry id="pres_draft_rls_sip">
+<abbrev>sip rls</abbrev>
+<title><ulink url="http://www.ietf.org/internet-drafts/draft-ietf-simple-event-list-07.txt"
+>draft-ietf-simple-event-list-07.txt</ulink> - Event Notification Extension for Resource 
+Lists</title>
+</biblioentry>
+
+</bibliodiv>
+
+</bibliography>
+

+ 68 - 0
doc/presence/presence.xml

@@ -0,0 +1,68 @@
+<?xml version='1.0' encoding='UTF-8'?>
+
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
+   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<section xmlns:xi="http://www.w3.org/2001/XInclude">
+<title>SER presence basics</title>
+
+<para>Presence is one of quite important components of SER. It allows users to
+watch presence state of other users, process lists of them and manipulate one's 
+own presence state.</para>
+
+<para>Configuration data can be stored on a XCAP server <xref
+linkend="pres_draft_xcap"/> by user's client software and processed by SER
+automaticaly. This may be useful for lists of watched users (resource lists) and
+for authorization rules.</para>
+
+<para>There is a few of modules which serve as parts of "presence".
+<itemizedlist>
+	<listitem><para><link linkend="pa">PA</link> This module acts as a presence
+	server - its main function is processing of subscriptions to presence
+	state and processing presence state publications.</para></listitem>
+	<listitem><para><link linkend="pres_rls">RLS</link> Resource list server - this
+	module processes subscriptions to lists of resources.</para></listitem>
+	<listitem><para><emphasis>RPA </emphasis>Reg events server. Will be used by
+	PA instead of direct callbacks into usrloc. Will be added
+	soon.</para></listitem>
+</itemizedlist>
+</para>
+
+<para>All <quote>presence</quote> modules share common code stored in SER
+libraries. Their interface is described in standalone documents.
+</para>
+
+<section><title>Persistence</title>
+<para>Modules can store their status (working data) into database. This data is
+automatically reloaded on startup, so it is possible to restart SER and
+clients don't note it. Established SIP dialogs are stored in database too.</para>
+<para>Details about database storage are described for each module separately in
+module documentation.
+</para>
+</section>
+
+<section><title>Authorization</title>
+<para>Authorization is one of important things in presence services. The server
+must take care about authorization rules defined by user about whom and
+whom not allow access to user's presence status. More about common authorization
+rules may be found in <xref linkend="pres_draft_common_auth"/> and 
+<xref linkend="pres_draft_auth"/>.</para>
+
+<!-- TODO: types of authorization common for all presence modules -->
+
+<para>Only XCAP storage of authorization rules is supported at this moment. It is 
+<emphasis>not fully implemented</emphasis> now - only basic rule conditions, no sphere 
+and time conditions. Transformations defined in <xref linkend="pres_draft_auth"/> are 
+ignored.
+May be, that in the
+future will be possible other variants like webdav or storing
+authorization rules in SER's own database.</para>
+
+<!-- TODO: examples of authorization documents with description of processing ! -->
+
+<para>Authorization settings may vary from module to module. It is in detail 
+described in documentation of individual modules.</para>
+</section>
+		
+</section>
+

+ 35 - 0
doc/presence/presence_book.xml

@@ -0,0 +1,35 @@
+<?xml version='1.0' encoding='iso-8859-2'?>
+
+<!DOCTYPE article PUBLIC '-//OASIS//DTD DocBook XML V4.2//EN'
+'http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd'>
+
+<article xmlns:xi="http://www.w3.org/2001/XInclude">
+	<title>SER presence handbook</title>
+<!--    <bookinfo>
+	<title>SER presence handbook</title>
+	<authorgroup>
+		<author>
+		<firstname>Václav</firstname>
+		<surname>Kubart</surname>
+		<address>
+			<email>[email protected]</email>
+		</address>
+		</author>
+	</authorgroup>
+	</bookinfo>-->
+	<!-- <toc></toc> -->
+	
+<!--	<chapter id="pres"><title>Presence in SER</title>-->
+		<xi:include href="presence.xml"/>
+		<xi:include href="../../modules/pa/doc/pa.xml"/>
+		<xi:include href="../../modules/rls/doc/rls.xml"/>
+		<xi:include href="biblio.xml"/>
+<!--		<xi:include href="todo.xml"/>-->
+<!--	</chapter>-->
+
+<!--	<chapter><title>Module documentation</title>
+		<xi:include href="../../modules/pa/doc/pa.xml"/> 
+		<xi:include href="../../modules/rls/doc/rls.xml"/>
+	</chapter>-->
+	
+</article>