OpenSim::Framework::Communications::UserManagerBase

OpenSim::Framework::Communications::UserManagerBase Class Reference

Base class for user management (create, read, etc). More...

Inheritance diagram for OpenSim::Framework::Communications::UserManagerBase:

OpenSim::Framework::Communications::IUserService OpenSim::Framework::Communications::IUserAdminService OpenSim::Framework::Communications::IAvatarService OpenSim::Framework::Communications::IMessagingService OpenSim::Grid::MessagingServer::UserManager OpenSim::Grid::UserServer::UserManager OpenSim::Region::Communications::Local::LocalUserServices List of all members.

Public Member Functions

 UserManagerBase (IInterServiceInventoryServices interServiceInventoryService)
 Constructor.
void AddPlugin (IUserDataPlugin plugin)
 Add a new user data plugin - plugins will be requested in the order they were added.
void AddPlugin (string provider, string connect)
 Add a new user data plugin - plugins will be requested in the order they were added.
UserProfileData GetUserProfile (string fname, string lname)
 Loads a user profile by name.
void LogoutUsers (UUID regionID)
void ResetAttachments (UUID userID)
UserAgentData GetAgentByUUID (UUID userId)
virtual UserProfileData GetUserProfile (UUID uuid)
 Loads a user profile from a database by UUID.
List< AvatarPickerAvatar > GenerateAgentPickerRequestResponse (UUID queryID, string query)
bool UpdateUserProfile (UserProfileData data)
 Updates a user profile from data object.
UserAgentData GetUserAgent (UUID uuid)
 Loads a user agent by uuid (not called directly).
UserAgentData GetUserAgent (string name)
 Loads a user agent by name (not called directly).
UserAgentData GetUserAgent (string fname, string lname)
 Loads a user agent by name (not called directly).
List< FriendListItem > GetUserFriendList (UUID ownerID)
 Loads a user's friend list.
Dictionary< UUID, FriendRegionInfo > GetFriendRegionInfos (List< UUID > uuids)
void StoreWebLoginKey (UUID agentID, UUID webLoginKey)
void AddNewUserFriend (UUID friendlistowner, UUID friend, uint perms)
 Adds a new friend to the database for XUser.
void RemoveUserFriend (UUID friendlistowner, UUID friend)
 Delete friend on friendlistowner's friendlist.
void UpdateUserFriendPerms (UUID friendlistowner, UUID friend, uint perms)
 Update permissions for friend on friendlistowner's friendlist.
void ClearUserAgent (UUID agentID)
 Resets the currentAgent in the user profile.
void CreateAgent (UserProfileData profile, XmlRpcRequest request)
 Creates and initialises a new user agent - make sure to use CommitAgent when done to submit to the DB.
void CreateAgent (UserProfileData profile, OSD request)
bool CommitAgent (ref UserProfileData profile)
 Saves a target agent to the database.
void LogOffUser (UUID userid, UUID regionid, ulong regionhandle, Vector3 position, Vector3 lookat)
 Process a user logoff from OpenSim.
void LogOffUser (UUID userid, UUID regionid, ulong regionhandle, float posx, float posy, float posz)
 Process a user logoff from OpenSim (deprecated as of 2008-08-27).
UUID AddUser (string firstName, string lastName, string password, string email, uint regX, uint regY)
 Add a new user.
UUID AddUser (string firstName, string lastName, string password, string email, uint regX, uint regY, UUID SetUUID)
 Add a new user.
bool ResetUserPassword (string firstName, string lastName, string newPassword)
 Reset a user password.
abstract UserProfileData SetupMasterUser (string firstName, string lastName)
abstract UserProfileData SetupMasterUser (string firstName, string lastName, string password)
abstract UserProfileData SetupMasterUser (UUID uuid)
bool AddUserAgent (UserAgentData agentdata)
 Add agent to DB.
AvatarAppearance GetUserAppearance (UUID user)
 Get avatar appearance information.
void UpdateUserAppearance (UUID user, AvatarAppearance appearance)
 Update avatar appearance information.

Protected Attributes

IInterServiceInventoryServices m_interServiceInventoryService

Detailed Description

Base class for user management (create, read, etc).

Constructor & Destructor Documentation

OpenSim::Framework::Communications::UserManagerBase::UserManagerBase ( IInterServiceInventoryServices  interServiceInventoryService  )  [inline]

Constructor.

Parameters:
interServiceInventoryService 

Member Function Documentation

void OpenSim::Framework::Communications::UserManagerBase::AddPlugin ( IUserDataPlugin  plugin  )  [inline]

Add a new user data plugin - plugins will be requested in the order they were added.

Parameters:
plugin The plugin that will provide user data

void OpenSim::Framework::Communications::UserManagerBase::AddPlugin ( string  provider,
string  connect 
) [inline]

Add a new user data plugin - plugins will be requested in the order they were added.

Parameters:
provider The filename to the user data plugin DLL
connect 

UserProfileData OpenSim::Framework::Communications::UserManagerBase::GetUserProfile ( string  fname,
string  lname 
) [inline]

Loads a user profile by name.

Parameters:
firstName First name
lastName Last name
Returns:
A user profile. Returns null if no profile is found

Implements OpenSim::Framework::Communications::IUserService.

void OpenSim::Framework::Communications::UserManagerBase::LogoutUsers ( UUID  regionID  )  [inline]

void OpenSim::Framework::Communications::UserManagerBase::ResetAttachments ( UUID  userID  )  [inline]

UserAgentData OpenSim::Framework::Communications::UserManagerBase::GetAgentByUUID ( UUID  userId  )  [inline]

Implements OpenSim::Framework::Communications::IUserService.

virtual UserProfileData OpenSim::Framework::Communications::UserManagerBase::GetUserProfile ( UUID  uuid  )  [inline, virtual]

Loads a user profile from a database by UUID.

Parameters:
userId The target UUID
Returns:
A user profile. Returns null if no user profile is found.

Implements OpenSim::Framework::Communications::IUserService.

List<AvatarPickerAvatar> OpenSim::Framework::Communications::UserManagerBase::GenerateAgentPickerRequestResponse ( UUID  queryID,
string  query 
) [inline]

Implements OpenSim::Framework::Communications::IUserService.

bool OpenSim::Framework::Communications::UserManagerBase::UpdateUserProfile ( UserProfileData  data  )  [inline]

Updates a user profile from data object.

Parameters:
data 
Returns:

Implements OpenSim::Framework::Communications::IUserService.

UserAgentData OpenSim::Framework::Communications::UserManagerBase::GetUserAgent ( UUID  uuid  )  [inline]

Loads a user agent by uuid (not called directly).

Parameters:
uuid The agent's UUID
Returns:
Agent profiles

UserAgentData OpenSim::Framework::Communications::UserManagerBase::GetUserAgent ( string  name  )  [inline]

Loads a user agent by name (not called directly).

Parameters:
name The agent's name
Returns:
A user agent

UserAgentData OpenSim::Framework::Communications::UserManagerBase::GetUserAgent ( string  fname,
string  lname 
) [inline]

Loads a user agent by name (not called directly).

Parameters:
fname The agent's firstname
lname The agent's lastname
Returns:
A user agent

List<FriendListItem> OpenSim::Framework::Communications::UserManagerBase::GetUserFriendList ( UUID  ownerID  )  [inline]

Loads a user's friend list.

Parameters:
name the UUID of the friend list owner
Returns:
A List of FriendListItems that contains info about the user's friends

Implements OpenSim::Framework::Communications::IUserService.

Dictionary<UUID, FriendRegionInfo> OpenSim::Framework::Communications::UserManagerBase::GetFriendRegionInfos ( List< UUID >  uuids  )  [inline]

Implements OpenSim::Framework::Communications::IMessagingService.

void OpenSim::Framework::Communications::UserManagerBase::StoreWebLoginKey ( UUID  agentID,
UUID  webLoginKey 
) [inline]

void OpenSim::Framework::Communications::UserManagerBase::AddNewUserFriend ( UUID  friendlistowner,
UUID  friend,
uint  perms 
) [inline]

Adds a new friend to the database for XUser.

Parameters:
friendlistowner The agent that who's friends list is being added to
friend The agent that being added to the friends list of the friends list owner
perms A uint bit vector for set perms that the friend being added has; 0 = none, 1=This friend can see when they sign on, 2 = map, 4 edit objects

Implements OpenSim::Framework::Communications::IUserService.

void OpenSim::Framework::Communications::UserManagerBase::RemoveUserFriend ( UUID  friendlistowner,
UUID  friend 
) [inline]

Delete friend on friendlistowner's friendlist.

Parameters:
friendlistowner The agent that who's friends list is being updated
friend The Ex-friend agent

Implements OpenSim::Framework::Communications::IUserService.

void OpenSim::Framework::Communications::UserManagerBase::UpdateUserFriendPerms ( UUID  friendlistowner,
UUID  friend,
uint  perms 
) [inline]

Update permissions for friend on friendlistowner's friendlist.

Parameters:
friendlistowner The agent that who's friends list is being updated
friend The agent that is getting or loosing permissions
perms A uint bit vector for set perms that the friend being added has; 0 = none, 1=This friend can see when they sign on, 2 = map, 4 edit objects

Implements OpenSim::Framework::Communications::IUserService.

void OpenSim::Framework::Communications::UserManagerBase::ClearUserAgent ( UUID  agentID  )  [inline]

Resets the currentAgent in the user profile.

Parameters:
agentID The agent's ID

Implements OpenSim::Framework::Communications::IUserService.

void OpenSim::Framework::Communications::UserManagerBase::CreateAgent ( UserProfileData  profile,
XmlRpcRequest  request 
) [inline]

Creates and initialises a new user agent - make sure to use CommitAgent when done to submit to the DB.

Parameters:
profile The users profile
request The users loginrequest

void OpenSim::Framework::Communications::UserManagerBase::CreateAgent ( UserProfileData  profile,
OSD  request 
) [inline]

bool OpenSim::Framework::Communications::UserManagerBase::CommitAgent ( ref UserProfileData  profile  )  [inline]

Saves a target agent to the database.

Parameters:
profile The users profile
Returns:
Successful?

void OpenSim::Framework::Communications::UserManagerBase::LogOffUser ( UUID  userid,
UUID  regionid,
ulong  regionhandle,
Vector3  position,
Vector3  lookat 
) [inline]

Process a user logoff from OpenSim.

Parameters:
userid 
regionid 
regionhandle 
position 
lookat 

Implements OpenSim::Framework::Communications::IUserService.

void OpenSim::Framework::Communications::UserManagerBase::LogOffUser ( UUID  userid,
UUID  regionid,
ulong  regionhandle,
float  posx,
float  posy,
float  posz 
) [inline]

Process a user logoff from OpenSim (deprecated as of 2008-08-27).

Parameters:
userid 
regionid 
regionhandle 
posx 
posy 
posz 

Implements OpenSim::Framework::Communications::IUserService.

UUID OpenSim::Framework::Communications::UserManagerBase::AddUser ( string  firstName,
string  lastName,
string  password,
string  email,
uint  regX,
uint  regY 
) [inline]

Add a new user.

Parameters:
firstName first name
lastName last name
password password
email email
regX location X
regY location Y
Returns:
The UUID of the created user profile. On failure, returns UUID.Zero

Implements OpenSim::Framework::Communications::IUserAdminService.

UUID OpenSim::Framework::Communications::UserManagerBase::AddUser ( string  firstName,
string  lastName,
string  password,
string  email,
uint  regX,
uint  regY,
UUID  SetUUID 
) [inline]

Add a new user.

Parameters:
firstName first name
lastName last name
password password
email email
regX location X
regY location Y
SetUUID UUID of avatar.
Returns:
The UUID of the created user profile. On failure, returns UUID.Zero

Implements OpenSim::Framework::Communications::IUserAdminService.

bool OpenSim::Framework::Communications::UserManagerBase::ResetUserPassword ( string  firstName,
string  lastName,
string  newPassword 
) [inline]

Reset a user password.

Parameters:
firstName 
lastName 
newPassword 
Returns:
true if the update was successful, false otherwise

Implements OpenSim::Framework::Communications::IUserAdminService.

abstract UserProfileData OpenSim::Framework::Communications::UserManagerBase::SetupMasterUser ( string  firstName,
string  lastName 
) [pure virtual]

Implements OpenSim::Framework::Communications::IUserService.

Implemented in OpenSim::Grid::MessagingServer::UserManager, OpenSim::Grid::UserServer::UserManager, and OpenSim::Region::Communications::Local::LocalUserServices.

abstract UserProfileData OpenSim::Framework::Communications::UserManagerBase::SetupMasterUser ( string  firstName,
string  lastName,
string  password 
) [pure virtual]

Implements OpenSim::Framework::Communications::IUserService.

Implemented in OpenSim::Grid::MessagingServer::UserManager, OpenSim::Grid::UserServer::UserManager, and OpenSim::Region::Communications::Local::LocalUserServices.

abstract UserProfileData OpenSim::Framework::Communications::UserManagerBase::SetupMasterUser ( UUID  uuid  )  [pure virtual]

Implements OpenSim::Framework::Communications::IUserService.

Implemented in OpenSim::Grid::MessagingServer::UserManager, OpenSim::Grid::UserServer::UserManager, and OpenSim::Region::Communications::Local::LocalUserServices.

bool OpenSim::Framework::Communications::UserManagerBase::AddUserAgent ( UserAgentData  agentdata  )  [inline]

Add agent to DB.

Parameters:
agentdata The agent data to be added

AvatarAppearance OpenSim::Framework::Communications::UserManagerBase::GetUserAppearance ( UUID  user  )  [inline]

Get avatar appearance information.

Parameters:
user 
Returns:

Implements OpenSim::Framework::Communications::IAvatarService.

void OpenSim::Framework::Communications::UserManagerBase::UpdateUserAppearance ( UUID  user,
AvatarAppearance  appearance 
) [inline]

Update avatar appearance information.

Parameters:
user 
appearance 

Implements OpenSim::Framework::Communications::IAvatarService.

Member Data Documentation

IInterServiceInventoryServices OpenSim::Framework::Communications::UserManagerBase::m_interServiceInventoryService [protected]

The documentation for this class was generated from the following file:
Generated on Fri Jan 9 01:00:46 2009 for OpenSim by  doxygen 1.5.1