OpenSim::Data::NHibernate::NHibernateUserData

OpenSim::Data::NHibernate::NHibernateUserData Class Reference

A User storage interface for the DB4o database system. More...

Inheritance diagram for OpenSim::Data::NHibernate::NHibernateUserData:

OpenSim::Data::UserDataBase OpenSim::Framework::IUserDataPlugin OpenSim::Framework::IPlugin List of all members.

Public Member Functions

override void Initialise ()
 Default-initialises the plugin.
override void Initialise (string connect)
 Initialises the plugin (artificial constructor).
override UserProfileData GetUserByUUID (UUID uuid)
 Returns a user profile from a database via their UUID.
override void AddNewUserProfile (UserProfileData profile)
 Adds a new User profile to the database.
override bool UpdateUserProfile (UserProfileData profile)
override void AddNewUserAgent (UserAgentData agent)
 Adds a new agent to the database.
void UpdateUserAgent (UserAgentData agent)
override UserAgentData GetAgentByUUID (UUID uuid)
 Returns the current agent for a user searching by it's UUID.
override UserProfileData GetUserByName (string fname, string lname)
 Returns a users profile by searching their username parts.
override UserAgentData GetAgentByName (string fname, string lname)
 Returns the current session agent for a user searching by username parts.
override UserAgentData GetAgentByName (string name)
 Returns the current session agent for a user searching by username.
override List< AvatarPickerAvatar > GeneratePickerResults (UUID queryID, string query)
 Returns a list of UUIDs firstnames and lastnames that match string query entered into the avatar picker.
override void StoreWebLoginKey (UUID agentID, UUID webLoginKey)
 Stores new web-login key for user during web page login.
override void AddNewUserFriend (UUID friendlistowner, UUID friend, uint perms)
 Adds a new friend to the database for XUser.
override void RemoveUserFriend (UUID friendlistowner, UUID friend)
 Delete friend on friendlistowner's friendlist.
override void UpdateUserFriendPerms (UUID friendlistowner, UUID friend, uint perms)
 Update permissions for friend on friendlistowner's friendlist.
override List< FriendListItem > GetUserFriendList (UUID friendlistowner)
 Returns a list of FriendsListItems that describe the friends and permissions in the friend relationship for UUID friendslistowner.
override Dictionary< UUID,
FriendRegionInfo > 		GetFriendRegionInfos (List< UUID > uuids)
 Returns a list of <see cref="FriendRegionInfo/>s for the specified UUIDs.
override 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).
override 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.
override AvatarAppearance GetUserAppearance (UUID user)
override void UpdateUserAppearance (UUID user, AvatarAppearance appearance)
override void ResetAttachments (UUID userID)
override void LogoutUsers (UUID regionID)
override void Dispose ()

Properties

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

Detailed Description

A User storage interface for the DB4o database system.

Member Function Documentation

override void OpenSim::Data::NHibernate::NHibernateUserData::Initialise (  )  [inline, virtual]

Default-initialises the plugin.

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::NHibernate::NHibernateUserData::Initialise ( string  connect  )  [inline, virtual]

Initialises the plugin (artificial constructor).

Implements OpenSim::Data::UserDataBase.

override UserProfileData OpenSim::Data::NHibernate::NHibernateUserData::GetUserByUUID ( UUID  uuid  )  [inline, 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::Data::UserDataBase.

override void OpenSim::Data::NHibernate::NHibernateUserData::AddNewUserProfile ( UserProfileData  profile  )  [inline, virtual]

Adds a new User profile to the database.

Parameters:
user UserProfile to add

Implements OpenSim::Data::UserDataBase.

override bool OpenSim::Data::NHibernate::NHibernateUserData::UpdateUserProfile ( UserProfileData  profile  )  [inline, virtual]

Updates an existing user profile

Parameters:
user UserProfile to update

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::NHibernate::NHibernateUserData::AddNewUserAgent ( UserAgentData  agent  )  [inline, virtual]

Adds a new agent to the database.

Parameters:
agent The agent to add

Implements OpenSim::Data::UserDataBase.

void OpenSim::Data::NHibernate::NHibernateUserData::UpdateUserAgent ( UserAgentData  agent  )  [inline]

override UserAgentData OpenSim::Data::NHibernate::NHibernateUserData::GetAgentByUUID ( UUID  uuid  )  [inline, 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::Data::UserDataBase.

override UserProfileData OpenSim::Data::NHibernate::NHibernateUserData::GetUserByName ( string  fname,
string  lname 
) [inline, virtual]

Returns a users profile by searching their username parts.

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

Implements OpenSim::Data::UserDataBase.

override UserAgentData OpenSim::Data::NHibernate::NHibernateUserData::GetAgentByName ( string  fname,
string  lname 
) [inline, 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::Data::UserDataBase.

override UserAgentData OpenSim::Data::NHibernate::NHibernateUserData::GetAgentByName ( string  name  )  [inline, 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::Data::UserDataBase.

override List<AvatarPickerAvatar> OpenSim::Data::NHibernate::NHibernateUserData::GeneratePickerResults ( UUID  queryID,
string  query 
) [inline, 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::Data::UserDataBase.

override void OpenSim::Data::NHibernate::NHibernateUserData::StoreWebLoginKey ( UUID  agentID,
UUID  webLoginKey 
) [inline, virtual]

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

Parameters:
webLoginKey 

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::NHibernate::NHibernateUserData::AddNewUserFriend ( UUID  friendlistowner,
UUID  friend,
uint  perms 
) [inline, 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::Data::UserDataBase.

override void OpenSim::Data::NHibernate::NHibernateUserData::RemoveUserFriend ( UUID  friendlistowner,
UUID  friend 
) [inline, 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::Data::UserDataBase.

override void OpenSim::Data::NHibernate::NHibernateUserData::UpdateUserFriendPerms ( UUID  friendlistowner,
UUID  friend,
uint  perms 
) [inline, 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::Data::UserDataBase.

override List<FriendListItem> OpenSim::Data::NHibernate::NHibernateUserData::GetUserFriendList ( UUID  friendlistowner  )  [inline, 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::Data::UserDataBase.

override Dictionary<UUID, FriendRegionInfo> OpenSim::Data::NHibernate::NHibernateUserData::GetFriendRegionInfos ( List< UUID >  uuids  )  [inline, 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::Data::UserDataBase.

override bool OpenSim::Data::NHibernate::NHibernateUserData::MoneyTransferRequest ( UUID  from,
UUID  to,
uint  amount 
) [inline, 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::Data::UserDataBase.

override bool OpenSim::Data::NHibernate::NHibernateUserData::InventoryTransferRequest ( UUID  from,
UUID  to,
UUID  inventory 
) [inline, 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::Data::UserDataBase.

override AvatarAppearance OpenSim::Data::NHibernate::NHibernateUserData::GetUserAppearance ( UUID  user  )  [inline, virtual]

Appearance TODO: stubs for now to get us to a compiling state gently

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::NHibernate::NHibernateUserData::UpdateUserAppearance ( UUID  user,
AvatarAppearance  appearance 
) [inline, virtual]

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::NHibernate::NHibernateUserData::ResetAttachments ( UUID  userID  )  [inline, virtual]

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::NHibernate::NHibernateUserData::LogoutUsers ( UUID  regionID  )  [inline, virtual]

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::NHibernate::NHibernateUserData::Dispose (  )  [inline, virtual]

Implements OpenSim::Data::UserDataBase.

Property Documentation

override string OpenSim::Data::NHibernate::NHibernateUserData::Name [get]

Returns the plugin name.

Returns:
Plugin name, eg MySQL User Provider

Reimplemented from OpenSim::Data::UserDataBase.

override string OpenSim::Data::NHibernate::NHibernateUserData::Version [get]

Returns the plugin version.

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

Reimplemented from OpenSim::Data::UserDataBase.

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