interreality.org [VOS]
[Home] [About]
[Screenshots]
[Download]
[News]
[Community]
[Documentation] [Manual]
[Bugs & Requests] [Wiki]

VOS::RemotePasswordAuth Class Reference
[libvos]

#include <vos/vos/passwordauth.hh>

Inheritance diagram for VOS::RemotePasswordAuth:

VOS::MetaObject VOS::Vobject VOS::Dispatchable VUtil::RefCounted List of all members.

Detailed Description

Definition at line 56 of file passwordauth.hh.

Public Member Functions

Static Public Member Functions


Constructor & Destructor Documentation

virtual VOS::RemotePasswordAuth::~RemotePasswordAuth (  )  [virtual]

destructor


Member Function Documentation

void VOS::RemotePasswordAuth::authenticate ( const std::string &  password  ) 

Using the supplied password, will attempt an authentication protocol with the server in order to take on this Identity.

The cleartext password is never sent during the validation protocol.

Parameters:
password the password (cleartext)
Exceptions:
AccessControlError if the authentication fails

virtual const std::string VOS::RemotePasswordAuth::getVOSType (  )  [virtual]

Returns:
VOS type "core:passwordauth"

Reimplemented from VOS::MetaObject.

static MetaObject* VOS::RemotePasswordAuth::new_RemotePasswordAuth ( VobjectBase superobject,
const std::string &  type 
) [static]

used by metaobject factory, never call directly

void VOS::RemotePasswordAuth::setPassword ( const std::string &  password  ) 

Request that the password be changed to the supplied password.

You must have already taken on this this Identity using authenticate(). Note that this will send a CLEARTEXT password, that is, someone can sniff the password-set message to learn the password (unlike the authentication protocol which never sends the password) so use with care.

Parameters:
password the password (cleartext)
Exceptions:
AccessControlError if setting the password was not allowed


The documentation for this class was generated from the following file: