197 lines
6.2 KiB
C++
197 lines
6.2 KiB
C++
/*------------------------------------------------------------------------------
|
|
|
|
Copyright (c) 2004 Media Development Loan Fund
|
|
|
|
This file is part of the LiveSupport project.
|
|
http://livesupport.campware.org/
|
|
To report bugs, send an e-mail to bugs@campware.org
|
|
|
|
LiveSupport is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
LiveSupport is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with LiveSupport; if not, write to the Free Software
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
|
|
Author : $Author: fgerlits $
|
|
Version : $Revision: 1.4 $
|
|
Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/authentication/include/LiveSupport/Authentication/Attic/WebAuthenticationClient.h,v $
|
|
|
|
------------------------------------------------------------------------------*/
|
|
#ifndef WebAuthenticationClient_h
|
|
#define WebAuthenticationClient_h
|
|
|
|
#ifndef __cplusplus
|
|
#error This is a C++ include file
|
|
#endif
|
|
|
|
|
|
/* ============================================================ include files */
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
#include "configure.h"
|
|
#endif
|
|
|
|
#include <stdexcept>
|
|
|
|
#include "LiveSupport/Core/Ptr.h"
|
|
#include "LiveSupport/Core/Configurable.h"
|
|
#include "LiveSupport/Core/SessionId.h"
|
|
#include "LiveSupport/Core/AuthenticationClientInterface.h"
|
|
|
|
|
|
namespace LiveSupport {
|
|
namespace Authentication {
|
|
|
|
using namespace LiveSupport;
|
|
using namespace LiveSupport::Core;
|
|
|
|
/* ================================================================ constants */
|
|
|
|
|
|
/* =================================================================== macros */
|
|
|
|
|
|
/* =============================================================== data types */
|
|
|
|
/**
|
|
* 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 webAuthentication configuration element may look like the following:
|
|
*
|
|
* <pre><code>
|
|
* <webAuthentication>
|
|
* <location
|
|
* server="localhost"
|
|
* port="80"
|
|
* path="/storage/var/xmlrpc/xrLocStor.php"
|
|
* />
|
|
* </webAuthentication>
|
|
* </code></pre>
|
|
*
|
|
* The DTD for the above element is:
|
|
*
|
|
* <pre><code>
|
|
* <!ELEMENT webAuthentication (location) >
|
|
* <!ELEMENT location EMPTY >
|
|
* <!ATTLIST location server CDATA #REQUIRED >
|
|
* <!ATTLIST location port NMTOKEN #REQUIRED >
|
|
* <!ATTLIST location path CDATA #REQUIRED >
|
|
* </code></pre>
|
|
*
|
|
* @author $Author: fgerlits $
|
|
* @version $Revision: 1.4 $
|
|
*/
|
|
class WebAuthenticationClient :
|
|
virtual public Configurable,
|
|
virtual public AuthenticationClientInterface
|
|
{
|
|
private:
|
|
/**
|
|
* The name of the configuration XML elmenent used by
|
|
* WebAuthenticationClient
|
|
*/
|
|
static const std::string configElementNameStr;
|
|
|
|
/**
|
|
* The name of the storage server, e.g. "myserver.mycompany.com".
|
|
*/
|
|
std::string storageServerName;
|
|
|
|
/**
|
|
* The port wher the storage server is listening (default is 80).
|
|
*/
|
|
int storageServerPort;
|
|
|
|
/**
|
|
* The path to the storage server php page.
|
|
*/
|
|
std::string storageServerPath;
|
|
|
|
|
|
public:
|
|
/**
|
|
* A virtual destructor, as this class has virtual functions.
|
|
*/
|
|
virtual
|
|
~WebAuthenticationClient(void) throw ()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Return the name of the XML element this object expects
|
|
* to be sent to a call to configure().
|
|
*
|
|
* @return the name of the expected XML configuration element.
|
|
*/
|
|
static const std::string
|
|
getConfigElementName(void) throw ()
|
|
{
|
|
return configElementNameStr;
|
|
}
|
|
|
|
/**
|
|
* Configure the object based on the XML element supplied.
|
|
*
|
|
* @param element the XML element to configure the object from.
|
|
* @exception std::invalid_argument if the supplied XML element
|
|
* contains bad configuraiton information
|
|
* @exception std::logic_error if the scheduler daemon has already
|
|
* been configured, and can not be reconfigured.
|
|
*/
|
|
virtual void
|
|
configure(const xmlpp::Element & element)
|
|
throw (std::invalid_argument,
|
|
std::logic_error);
|
|
|
|
/**
|
|
* Login to the storage server, using the data read from the
|
|
* configuration file.
|
|
* 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
|
|
login(const std::string &login, const std::string &password)
|
|
throw ();
|
|
|
|
/**
|
|
* Logout from the storage server.
|
|
*
|
|
* @param sessionId the ID of the session to end
|
|
* @return true if logged out successfully, false if not
|
|
*/
|
|
virtual const bool
|
|
logout(Ptr<SessionId>::Ref sessionId)
|
|
throw ();
|
|
|
|
};
|
|
|
|
|
|
/* ================================================= external data structures */
|
|
|
|
|
|
/* ====================================================== function prototypes */
|
|
|
|
|
|
} // namespace Authentication
|
|
} // namespace LiveSupport
|
|
|
|
#endif // WebAuthenticationClient_h
|
|
|