Congegni
/
sintonia
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added some more documentation to the authentication client

This commit is contained in:
fgerlits 2004-11-23 16:31:14 +00:00
parent 7a1e167ca9
commit d453f7d664
4 changed files with 1212 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1144
livesupport/modules/authentication/etc/doxygen.config Normal file
View File

File diff suppressed because it is too large Load Diff

34
livesupport/modules/authentication/include/LiveSupport/Authentication/WebAuthenticationClient.h
View File

@ -22,7 +22,7 @@
Author : $Author: fgerlits $
Version : $Revision: 1.2 $
Version : $Revision: 1.3 $
Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/authentication/include/LiveSupport/Authentication/Attic/WebAuthenticationClient.h,v $
------------------------------------------------------------------------------*/
@ -63,10 +63,36 @@ using namespace LiveSupport::Core;
/* =============================================================== data types */
/**
* An interface to the (possibly remote) php storage server.
* An interface to the authentication methods on the php storage server.
*
* This object has to be configured with an XML configuration element
* called webAuthentication. This element contains a child element
* specifying the location of the authentication server.
*
* A authenticationClientFactory configuration element may look like the following:
*
* <pre><code>
* &lt;webAuthentication&gt;
* &lt;location
* server="localhost"
* port="80"
* path="/storage/var/xmlrpc/xrLocStor.php"
* /&gt;
* &lt;/webAuthentication&gt;
* </code></pre>
*
* The DTD for the above element is:
*
* <pre><code>
* &lt;!ELEMENT webAuthentication (location) &gt;
* &lt;!ELEMENT location EMPTY &gt;
* &lt;!ATTLIST location server CDATA #REQUIRED &gt;
* &lt;!ATTLIST location port NMTOKEN #REQUIRED &gt;
* &lt;!ATTLIST location path CDATA #REQUIRED &gt;
* </code></pre>
*
* @author $Author: fgerlits $
* @version $Revision: 1.2 $
* @version $Revision: 1.3 $
*/
class WebAuthenticationClient :
virtual public Configurable,
@ -136,6 +162,8 @@ class WebAuthenticationClient :
* Returns a new session ID; in case of an error, returns a
* null pointer.
*
* For testing, use the login "root" with the password "q".
*
* @return the new session ID
*/
virtual Ptr<SessionId>::Ref

6
livesupport/modules/authentication/src/WebAuthenticationClientTest.h
View File

@ -22,7 +22,7 @@
Author : $Author: fgerlits $
Version : $Revision: 1.2 $
Version : $Revision: 1.3 $
Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/authentication/src/WebAuthenticationClientTest.h,v $
------------------------------------------------------------------------------*/
@ -58,10 +58,10 @@ using namespace LiveSupport::Core;
/* =============================================================== data types */
/**
* Unit test for the UploadPlaylistMetohd class.
* Unit test for the WebAuthenticationClient class.
*
* @author $Author: fgerlits $
* @version $Revision: 1.2 $
* @version $Revision: 1.3 $
* @see WebAuthenticationClient
*/
class WebAuthenticationClientTest : public CPPUNIT_NS::TestFixture

37
livesupport/modules/storage/src/WebStorageClient.h
View File

@ -22,7 +22,7 @@
Author : $Author: fgerlits $
Version : $Revision: 1.3 $
Version : $Revision: 1.4 $
Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/storage/src/WebStorageClient.h,v $
------------------------------------------------------------------------------*/
@ -65,10 +65,41 @@ using namespace LiveSupport::Core;
/* =============================================================== data types */
/**
* An interface to the (possibly remote) php storage server.
* An interface to the php storage server.
*
* This object has to be configured with an XML configuration element
* called webStorage. This element contains a child element
* specifying the location of the authentication server, and an attribute
* called tempFiles which specifies where the temporary playlist files are
* going to be created. The name of the temp files will be the tempFiles
* attribute value, plus a random string, plus a ".smil" extension.
*
* A authenticationClientFactory configuration element may look like the following:
*
* <pre><code>
* &lt;webStorage
* tempFiles="file:///tmp/tempPlaylist" &gt;
* &lt;location
* server="localhost"
* port="80"
* path="/storage/var/xmlrpc/xrLocStor.php"
* /&gt;
* &lt;/webStorage&gt;
* </code></pre>
*
* The DTD for the above element is:
*
* <pre><code>
* &lt;!ELEMENT webStorage (location) &gt;
* &lt;!ATTLIST webStorage tempFiles CDATA #REQUIRED &gt;
* &lt;!ELEMENT location EMPTY &gt;
* &lt;!ATTLIST location server CDATA #REQUIRED &gt;
* &lt;!ATTLIST location port NMTOKEN #REQUIRED &gt;
* &lt;!ATTLIST location path CDATA #REQUIRED &gt;
* </code></pre>
*
* @author $Author: fgerlits $
* @version $Revision: 1.3 $
* @version $Revision: 1.4 $
*/
class WebStorageClient :
virtual public Configurable,