OpenSim::Data::UserDataBase

OpenSim::Data::UserDataBase Class Reference

Inheritance diagram for OpenSim::Data::UserDataBase:

OpenSim::Framework::IUserDataPlugin OpenSim::Framework::IPlugin OpenSim::Data::MSSQL::MSSQLUserData OpenSim::Data::MySQL::MySQLUserData OpenSim::Data::NHibernate::NHibernateUserData OpenSim::Data::SQLite::SQLiteUserData List of all members.

Public Member Functions

abstract UserProfileData GetUserByUUID (UUID user)
 Returns a user profile from a database via their UUID.
abstract UserProfileData GetUserByName (string fname, string lname)
 Returns a users profile by searching their username parts.
abstract UserAgentData GetAgentByUUID (UUID user)
 Returns the current agent for a user searching by it's UUID.
abstract UserAgentData GetAgentByName (string name)
 Returns the current session agent for a user searching by username.
abstract UserAgentData GetAgentByName (string fname, string lname)
 Returns the current session agent for a user searching by username parts.
abstract void StoreWebLoginKey (UUID agentID, UUID webLoginKey)
 Stores new web-login key for user during web page login.
abstract void AddNewUserProfile (UserProfileData user)
 Adds a new User profile to the database.
abstract bool UpdateUserProfile (UserProfileData user)
abstract void AddNewUserAgent (UserAgentData agent)
 Adds a new agent to the database.
abstract void AddNewUserFriend (UUID friendlistowner, UUID friend, uint perms)
 Adds a new friend to the database for XUser.
abstract void RemoveUserFriend (UUID friendlistowner, UUID friend)
 Delete friend on friendlistowner's friendlist.
abstract void UpdateUserFriendPerms (UUID friendlistowner, UUID friend, uint perms)
 Update permissions for friend on friendlistowner's friendlist.
abstract List< FriendListItem > GetUserFriendList (UUID friendlistowner)
 Returns a list of FriendsListItems that describe the friends and permissions in the friend relationship for UUID friendslistowner.
abstract Dictionary< UUID,
FriendRegionInfo > 		GetFriendRegionInfos (List< UUID > uuids)
 Returns a list of <see cref="FriendRegionInfo/>s for the specified UUIDs.
abstract bool MoneyTransferRequest (UUID from, UUID to, uint amount)
 Attempts to move currency units between accounts (NOT RELIABLE / TRUSTWORTHY. DONT TRY RUN YOUR OWN CURRENCY EXCHANGE WITH REAL VALUES).
abstract bool InventoryTransferRequest (UUID from, UUID to, UUID inventory)
 Attempts to move inventory between accounts, if inventory is copyable it will be copied into the target account.
abstract List< AvatarPickerAvatar > GeneratePickerResults (UUID queryID, string query)
 Returns a list of UUIDs firstnames and lastnames that match string query entered into the avatar picker.
abstract AvatarAppearance GetUserAppearance (UUID user)
 Gets the user appearance </summer>.
abstract void UpdateUserAppearance (UUID user, AvatarAppearance appearance)
abstract void ResetAttachments (UUID userID)
abstract void LogoutUsers (UUID regionID)
abstract void Initialise (string connect)
 Initialises the plugin (artificial constructor).
abstract void Initialise ()
 Default-initialises the plugin.
abstract void Dispose ()

Properties

abstract string Version [get]
 Returns the plugin version.
abstract string Name [get]
 Returns the plugin name.

Member Function Documentation

abstract UserProfileData OpenSim::Data::UserDataBase::GetUserByUUID ( UUID  user  )  [pure virtual]

Returns a user profile from a database via their UUID.

Parameters:
user The user's UUID
Returns:
The user data profile. Returns null if no user is found

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract UserProfileData OpenSim::Data::UserDataBase::GetUserByName ( string  fname,
string  lname 
) [pure virtual]

Returns a users profile by searching their username parts.

Parameters:
fname Account firstname
lname Account lastname
Returns:
The user data profile

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract UserAgentData OpenSim::Data::UserDataBase::GetAgentByUUID ( UUID  user  )  [pure virtual]

Returns the current agent for a user searching by it's UUID.

Parameters:
user The users UUID
Returns:
The current agent session

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract UserAgentData OpenSim::Data::UserDataBase::GetAgentByName ( string  name  )  [pure virtual]

Returns the current session agent for a user searching by username.

Parameters:
name The users account name
Returns:
The current agent session

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract UserAgentData OpenSim::Data::UserDataBase::GetAgentByName ( string  fname,
string  lname 
) [pure virtual]

Returns the current session agent for a user searching by username parts.

Parameters:
fname The users first account name
lname The users account surname
Returns:
The current agent session

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract void OpenSim::Data::UserDataBase::StoreWebLoginKey ( UUID  agentID,
UUID  webLoginKey 
) [pure virtual]

Stores new web-login key for user during web page login.

Parameters:
webLoginKey 

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract void OpenSim::Data::UserDataBase::AddNewUserProfile ( UserProfileData  user  )  [pure virtual]

Adds a new User profile to the database.

Parameters:
user UserProfile to add

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract bool OpenSim::Data::UserDataBase::UpdateUserProfile ( UserProfileData  user  )  [pure virtual]

Updates an existing user profile

Parameters:
user UserProfile to update

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract void OpenSim::Data::UserDataBase::AddNewUserAgent ( UserAgentData  agent  )  [pure virtual]

Adds a new agent to the database.

Parameters:
agent The agent to add

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract void OpenSim::Data::UserDataBase::AddNewUserFriend ( UUID  friendlistowner,
UUID  friend,
uint  perms 
) [pure virtual]

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::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract void OpenSim::Data::UserDataBase::RemoveUserFriend ( UUID  friendlistowner,
UUID  friend 
) [pure virtual]

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::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract void OpenSim::Data::UserDataBase::UpdateUserFriendPerms ( UUID  friendlistowner,
UUID  friend,
uint  perms 
) [pure virtual]

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::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract List<FriendListItem> OpenSim::Data::UserDataBase::GetUserFriendList ( UUID  friendlistowner  )  [pure virtual]

Returns a list of FriendsListItems that describe the friends and permissions in the friend relationship for UUID friendslistowner.

Parameters:
friendlistowner The agent that we're retreiving the friends Data.

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract Dictionary<UUID, FriendRegionInfo> OpenSim::Data::UserDataBase::GetFriendRegionInfos ( List< UUID >  uuids  )  [pure virtual]

Returns a list of <see cref="FriendRegionInfo/>s for the specified UUIDs.

Parameters:
uuids A List of <see cref="UUID/>s to fetch info for
Returns:
A Dictionary, mapping the UUIDs to FriendRegionInfos.

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract bool OpenSim::Data::UserDataBase::MoneyTransferRequest ( UUID  from,
UUID  to,
uint  amount 
) [pure virtual]

Attempts to move currency units between accounts (NOT RELIABLE / TRUSTWORTHY. DONT TRY RUN YOUR OWN CURRENCY EXCHANGE WITH REAL VALUES).

Parameters:
from The account to transfer from
to The account to transfer to
amount The amount to transfer
Returns:
Successful?

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract bool OpenSim::Data::UserDataBase::InventoryTransferRequest ( UUID  from,
UUID  to,
UUID  inventory 
) [pure virtual]

Attempts to move inventory between accounts, if inventory is copyable it will be copied into the target account.

Parameters:
from User to transfer from
to User to transfer to
inventory Specified inventory item
Returns:
Successful?

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract List<AvatarPickerAvatar> OpenSim::Data::UserDataBase::GeneratePickerResults ( UUID  queryID,
string  query 
) [pure virtual]

Returns a list of UUIDs firstnames and lastnames that match string query entered into the avatar picker.

Parameters:
queryID ID associated with the user's query. This must match what the client sent
query The filtered contents of the search box when the user hit search.
Returns:
The user data profile

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract AvatarAppearance OpenSim::Data::UserDataBase::GetUserAppearance ( UUID  user  )  [pure virtual]

Gets the user appearance </summer>.

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract void OpenSim::Data::UserDataBase::UpdateUserAppearance ( UUID  user,
AvatarAppearance  appearance 
) [pure virtual]

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract void OpenSim::Data::UserDataBase::ResetAttachments ( UUID  userID  )  [pure virtual]

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract void OpenSim::Data::UserDataBase::LogoutUsers ( UUID  regionID  )  [pure virtual]

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract void OpenSim::Data::UserDataBase::Initialise ( string  connect  )  [pure virtual]

Initialises the plugin (artificial constructor).

Implements OpenSim::Framework::IUserDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract void OpenSim::Data::UserDataBase::Initialise (  )  [pure virtual]

Default-initialises the plugin.

Implements OpenSim::Framework::IPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract void OpenSim::Data::UserDataBase::Dispose (  )  [pure virtual]

Implemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

Property Documentation

abstract string OpenSim::Data::UserDataBase::Version [get]

Returns the plugin version.

Returns:
Plugin version in MAJOR.MINOR.REVISION.BUILD format

Implements OpenSim::Framework::IPlugin.

Reimplemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

abstract string OpenSim::Data::UserDataBase::Name [get]

Returns the plugin name.

Returns:
Plugin name, eg MySQL User Provider

Implements OpenSim::Framework::IPlugin.

Reimplemented in OpenSim::Data::MSSQL::MSSQLUserData, OpenSim::Data::MySQL::MySQLUserData, OpenSim::Data::NHibernate::NHibernateUserData, and OpenSim::Data::SQLite::SQLiteUserData.

The documentation for this class was generated from the following file:
Generated on Mon Jan 5 01:00:38 2009 for OpenSim by  doxygen 1.5.1