OpenSim::Data::MSSQL::MSSQLUserData Class Reference

A database interface class to a user profile storage system. More...

Inheritance diagram for OpenSim::Data::MSSQL::MSSQLUserData:


Public Member Functions
override void	Initialise ()
	Default-initialises the plugin.
override void	Initialise (string connect)
	Loads and initialises the MSSQL storage plugin.
override void	Dispose ()
	Releases unmanaged and - optionally - managed resources.
override UserProfileData	GetUserByName (string user, string last)
	Searches the database for a specified user profile by name components.
override UserProfileData	GetUserByUUID (UUID uuid)
	See IUserDataPlugin.
override void	AddNewUserProfile (UserProfileData user)
	Creates a new users profile.
override bool	UpdateUserProfile (UserProfileData user)
	update a user profile
override UserAgentData	GetAgentByName (string name)
	Returns a user session searching by name.
override UserAgentData	GetAgentByName (string user, string last)
	Returns a user session by account name.
override UserAgentData	GetAgentByUUID (UUID uuid)
	Returns an agent session by account UUID.
override void	AddNewUserAgent (UserAgentData agent)
	Creates a new agent.
override void	AddNewUserFriend (UUID friendlistowner, UUID friend, uint perms)
	Add a new friend in the friendlist.
override void	RemoveUserFriend (UUID friendlistowner, UUID friend)
	Remove an friend from the friendlist.
override void	UpdateUserFriendPerms (UUID friendlistowner, UUID friend, uint perms)
	Update friendlist permission flag for a friend.
override List< FriendListItem >	GetUserFriendList (UUID friendlistowner)
	Get (fetch?) the user's friendlist.
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)
	Performs a money transfer request between two accounts.
override bool	InventoryTransferRequest (UUID from, UUID to, UUID item)
	Performs an inventory transfer request between two accounts.
override AvatarAppearance	GetUserAppearance (UUID user)
	Gets the user appearance.
override void	UpdateUserAppearance (UUID user, AvatarAppearance appearance)
	Update a user appearence into database.
Hashtable	GetUserAttachments (UUID agentID)
	Gets all attachment of a agent.
void	UpdateUserAttachments (UUID agentID, Hashtable data)
	Updates all attachments of the agent.
override void	ResetAttachments (UUID agentID)
	Resets all attachments of a agent in the database.
override void	LogoutUsers (UUID regionID)
override List< AvatarPickerAvatar >	GeneratePickerResults (UUID queryID, string query)
override void	StoreWebLoginKey (UUID AgentID, UUID WebLoginKey)
	Store a weblogin key.
Public Attributes
MSSQLManager	database
	Database manager for MSSQL.
Properties
override string	Name `[get]`
	Database provider name.
override string	Version `[get]`
	Database provider version.

Detailed Description

A database interface class to a user profile storage system.

Member Function Documentation

override void OpenSim::Data::MSSQL::MSSQLUserData::Initialise ( ) [inline, virtual]

Default-initialises the plugin.

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MSSQL::MSSQLUserData::Initialise ( string connect ) [inline, virtual]

Loads and initialises the MSSQL storage plugin.

Parameters:

connect

connectionstring

use mssql_connection.ini

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MSSQL::MSSQLUserData::Dispose ( ) [inline, virtual]

Releases unmanaged and - optionally - managed resources.

Implements OpenSim::Data::UserDataBase.

override UserProfileData OpenSim::Data::MSSQL::MSSQLUserData::GetUserByName	(	string	user,
		string	last
	)			`[inline, virtual]`

Searches the database for a specified user profile by name components.

Parameters:

	user	The first part of the account name
	last	The second part of the account name

Returns:: A user profile

Implements OpenSim::Data::UserDataBase.

override UserProfileData OpenSim::Data::MSSQL::MSSQLUserData::GetUserByUUID ( UUID uuid ) [inline, virtual]

See IUserDataPlugin.

Parameters:

uuid

Returns:

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MSSQL::MSSQLUserData::AddNewUserProfile ( UserProfileData user ) [inline, virtual]

Creates a new users profile.

Parameters:

user

The user profile to create

Implements OpenSim::Data::UserDataBase.

override bool OpenSim::Data::MSSQL::MSSQLUserData::UpdateUserProfile ( UserProfileData user ) [inline, virtual]

update a user profile

Parameters:

user

the profile to update

Returns:

Implements OpenSim::Data::UserDataBase.

override UserAgentData OpenSim::Data::MSSQL::MSSQLUserData::GetAgentByName ( string name ) [inline, virtual]

Returns a user session searching by name.

Parameters:

name

The account name

Returns:: The users session

Implements OpenSim::Data::UserDataBase.

override UserAgentData OpenSim::Data::MSSQL::MSSQLUserData::GetAgentByName	(	string	user,
		string	last
	)			`[inline, virtual]`

Returns a user session by account name.

Parameters:

	user	First part of the users account name
	last	Second part of the users account name

Returns:: The users session

Implements OpenSim::Data::UserDataBase.

override UserAgentData OpenSim::Data::MSSQL::MSSQLUserData::GetAgentByUUID ( UUID uuid ) [inline, virtual]

Returns an agent session by account UUID.

Parameters:

uuid

The accounts UUID

Returns:: The users session

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MSSQL::MSSQLUserData::AddNewUserAgent ( UserAgentData agent ) [inline, virtual]

Creates a new agent.

Parameters:

agent

The agent to create

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MSSQL::MSSQLUserData::AddNewUserFriend	(	UUID	friendlistowner,
		UUID	friend,
		uint	perms
	)			`[inline, virtual]`

Add a new friend in the friendlist.

Parameters:

	friendlistowner	UUID of the friendlist owner
	friend	Friend's UUID
	perms	Permission flag

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MSSQL::MSSQLUserData::RemoveUserFriend	(	UUID	friendlistowner,
		UUID	friend
	)			`[inline, virtual]`

Remove an friend from the friendlist.

Parameters:

	friendlistowner	UUID of the friendlist owner
	friend	UUID of the not-so-friendly user to remove from the list

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MSSQL::MSSQLUserData::UpdateUserFriendPerms	(	UUID	friendlistowner,
		UUID	friend,
		uint	perms
	)			`[inline, virtual]`

Update friendlist permission flag for a friend.

Parameters:

	friendlistowner	UUID of the friendlist owner
	friend	UUID of the friend
	perms	new permission flag

Implements OpenSim::Data::UserDataBase.

override List<FriendListItem> OpenSim::Data::MSSQL::MSSQLUserData::GetUserFriendList ( UUID friendlistowner ) [inline, virtual]

Get (fetch?) the user's friendlist.

Parameters:

friendlistowner

UUID of the friendlist owner

Returns:: Friendlist list

Implements OpenSim::Data::UserDataBase.

override Dictionary<UUID, FriendRegionInfo> OpenSim::Data::MSSQL::MSSQLUserData::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::MSSQL::MSSQLUserData::MoneyTransferRequest	(	UUID	from,
		UUID	to,
		uint	amount
	)			`[inline, virtual]`

Performs a money transfer request between two accounts.

Parameters:

	from	The senders account ID
	to	The receivers account ID
	amount	The amount to transfer

Returns:: false

Implements OpenSim::Data::UserDataBase.

override bool OpenSim::Data::MSSQL::MSSQLUserData::InventoryTransferRequest	(	UUID	from,
		UUID	to,
		UUID	item
	)			`[inline, virtual]`

Performs an inventory transfer request between two accounts.

TODO: Move to inventory server

Parameters:

	from	The senders account ID
	to	The receivers account ID
	item	The item to transfer

Returns:: false

Implements OpenSim::Data::UserDataBase.

override AvatarAppearance OpenSim::Data::MSSQL::MSSQLUserData::GetUserAppearance ( UUID user ) [inline, virtual]

Gets the user appearance.

Parameters:

user

The user.

Returns:

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MSSQL::MSSQLUserData::UpdateUserAppearance	(	UUID	user,
		AvatarAppearance	appearance
	)			`[inline, virtual]`

Update a user appearence into database.

Parameters:

	user	the used UUID
	appearance	the appearence

Implements OpenSim::Data::UserDataBase.

Hashtable OpenSim::Data::MSSQL::MSSQLUserData::GetUserAttachments ( UUID agentID ) [inline]

Gets all attachment of a agent.

Parameters:

agentID

agent ID.

Returns:

void OpenSim::Data::MSSQL::MSSQLUserData::UpdateUserAttachments	(	UUID	agentID,
		Hashtable	data
	)			`[inline]`

Updates all attachments of the agent.

Parameters:

	agentID	agentID.
	data	data with all items on attachmentpoints

override void OpenSim::Data::MSSQL::MSSQLUserData::ResetAttachments ( UUID agentID ) [inline, virtual]

Resets all attachments of a agent in the database.

Parameters:

agentID

agentID.

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MSSQL::MSSQLUserData::LogoutUsers ( UUID regionID ) [inline, virtual]

Implements OpenSim::Data::UserDataBase.

override List<AvatarPickerAvatar> OpenSim::Data::MSSQL::MSSQLUserData::GeneratePickerResults	(	UUID	queryID,
		string	query
	)			`[inline, virtual]`

Parameters:

	queryID
	query

Returns:

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MSSQL::MSSQLUserData::StoreWebLoginKey	(	UUID	AgentID,
		UUID	WebLoginKey
	)			`[inline, virtual]`

Store a weblogin key.

Parameters:

	AgentID	The agent UUID
	WebLoginKey	the WebLogin Key

unused ?

Implements OpenSim::Data::UserDataBase.

Member Data Documentation

MSSQLManager OpenSim::Data::MSSQL::MSSQLUserData::database

Database manager for MSSQL.

Property Documentation

override string OpenSim::Data::MSSQL::MSSQLUserData::Name [get]

Database provider name.

Returns:: Provider name

Reimplemented from OpenSim::Data::UserDataBase.

override string OpenSim::Data::MSSQL::MSSQLUserData::Version [get]

Database provider version.

Returns:: provider version

Reimplemented from OpenSim::Data::UserDataBase.

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

/home/sdague/opensim-docs/OpenSim/Data/MSSQL/MSSQLUserData.cs

Generated on Mon Jan 5 01:00:38 2009 for OpenSim by

1.5.1

OpenSim::Data::MSSQL::MSSQLUserData Class Reference

Public Member Functions

Public Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation