Some work on restructuring the namespaces / project names. Note this doesn't compile yet as not all the code has been changed to use the new namespaces. Am committing it now for feedback on the namespaces.

author: MW 2007-06-27 15:28:52 +0000
committer: MW 2007-06-27 15:28:52 +0000
commit: 646bbbc84b8010e0dacbeed5342cdb045f46cc49 (patch)
tree: 770b34d19855363c3c113ab9a0af9a56d821d887 /OpenSim/Framework/Data/UserData.cs
download: opensim-SC-646bbbc84b8010e0dacbeed5342cdb045f46cc49.zip
opensim-SC-646bbbc84b8010e0dacbeed5342cdb045f46cc49.tar.gz
opensim-SC-646bbbc84b8010e0dacbeed5342cdb045f46cc49.tar.bz2
opensim-SC-646bbbc84b8010e0dacbeed5342cdb045f46cc49.tar.xz
1 files changed, 131 insertions, 0 deletions
diff --git a/OpenSim/Framework/Data/UserData.cs b/OpenSim/Framework/Data/UserData.cs
new file mode 100644
index 0000000..2e15b47
--- /dev/null
+++ b/OpenSim/Framework/Data/UserData.cs
@@ -0,0 +1,131 @@
+/*
+* Copyright (c) Contributors, http://www.openmetaverse.org/
+* See CONTRIBUTORS.TXT for a full list of copyright holders.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*     * Redistributions of source code must retain the above copyright
+*       notice, this list of conditions and the following disclaimer.
+*     * Redistributions in binary form must reproduce the above copyright
+*       notice, this list of conditions and the following disclaimer in the
+*       documentation and/or other materials provided with the distribution.
+*     * Neither the name of the OpenSim Project nor the
+*       names of its contributors may be used to endorse or promote products
+*       derived from this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS AND ANY
+* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+* 
+*/
+using System;
+using System.Collections.Generic;
+using System.Text;
+using libsecondlife;
+namespace OpenSim.Framework.Data
+{
+    /// <summary>
+    /// An interface for connecting to user storage servers.
+    /// </summary>
+    public interface IUserData
+    {
+        /// <summary>
+        /// Returns a user profile from a database via their UUID
+        /// </summary>
+        /// <param name="user">The accounts UUID</param>
+        /// <returns>The user data profile</returns>
+        UserProfileData getUserByUUID(LLUUID user);
+        /// <summary>
+        /// Returns a users profile by searching their username
+        /// </summary>
+        /// <param name="name">The users username</param>
+        /// <returns>The user data profile</returns>
+        UserProfileData getUserByName(string name);
+        /// <summary>
+        /// Returns a users profile by searching their username parts
+        /// </summary>
+        /// <param name="fname">Account firstname</param>
+        /// <param name="lname">Account lastname</param>
+        /// <returns>The user data profile</returns>
+        UserProfileData getUserByName(string fname, string lname);
+        /// <summary>
+        /// Returns the current agent for a user searching by it's UUID
+        /// </summary>
+        /// <param name="user">The users UUID</param>
+        /// <returns>The current agent session</returns>
+        UserAgentData getAgentByUUID(LLUUID user);
+        /// <summary>
+        /// Returns the current session agent for a user searching by username
+        /// </summary>
+        /// <param name="name">The users account name</param>
+        /// <returns>The current agent session</returns>
+        UserAgentData getAgentByName(string name);
+        /// <summary>
+        /// Returns the current session agent for a user searching by username parts
+        /// </summary>
+        /// <param name="fname">The users first account name</param>
+        /// <param name="lname">The users account surname</param>
+        /// <returns>The current agent session</returns>
+        UserAgentData getAgentByName(string fname, string lname);
+        /// <summary>
+        /// Adds a new User profile to the database 
+        /// </summary>
+        /// <param name="user">UserProfile to add</param>
+        void addNewUserProfile(UserProfileData user);
+        /// <summary>
+        /// Adds a new agent to the database
+        /// </summary>
+        /// <param name="agent">The agent to add</param>
+        void addNewUserAgent(UserAgentData agent);
+        /// <summary>
+        /// Attempts to move currency units between accounts (NOT RELIABLE / TRUSTWORTHY. DONT TRY RUN YOUR OWN CURRENCY EXCHANGE WITH REAL VALUES)
+        /// </summary>
+        /// <param name="from">The account to transfer from</param>
+        /// <param name="to">The account to transfer to</param>
+        /// <param name="amount">The amount to transfer</param>
+        /// <returns>Successful?</returns>
+        bool moneyTransferRequest(LLUUID from, LLUUID to, uint amount);
+        /// <summary>
+        /// Attempts to move inventory between accounts, if inventory is copyable it will be copied into the target account.
+        /// </summary>
+        /// <param name="from">User to transfer from</param>
+        /// <param name="to">User to transfer to</param>
+        /// <param name="inventory">Specified inventory item</param>
+        /// <returns>Successful?</returns>
+        bool inventoryTransferRequest(LLUUID from, LLUUID to, LLUUID inventory);
+        /// <summary>
+        /// Returns the plugin version
+        /// </summary>
+        /// <returns>Plugin version in MAJOR.MINOR.REVISION.BUILD format</returns>
+        string getVersion();
+        /// <summary>
+        /// Returns the plugin name
+        /// </summary>
+        /// <returns>Plugin name, eg MySQL User Provider</returns>
+        string getName();
+        /// <summary>
+        /// Initialises the plugin (artificial constructor)
+        /// </summary>
+        void Initialise();
+    }
+}
author	MW	2007-06-27 15:28:52 +0000
committer	MW	2007-06-27 15:28:52 +0000
commit	646bbbc84b8010e0dacbeed5342cdb045f46cc49 (patch)
tree	770b34d19855363c3c113ab9a0af9a56d821d887 /OpenSim/Framework/Data/UserData.cs
download	opensim-SC-646bbbc84b8010e0dacbeed5342cdb045f46cc49.zip opensim-SC-646bbbc84b8010e0dacbeed5342cdb045f46cc49.tar.gz opensim-SC-646bbbc84b8010e0dacbeed5342cdb045f46cc49.tar.bz2 opensim-SC-646bbbc84b8010e0dacbeed5342cdb045f46cc49.tar.xz

diff --git a/OpenSim/Framework/Data/UserData.cs b/OpenSim/Framework/Data/UserData.cs new file mode 100644 index 0000000..2e15b47 --- /dev/null +++ b/OpenSim/Framework/Data/UserData.cs
@@ -0,0 +1,131 @@
	1	/*
	2	* Copyright (c) Contributors, http://www.openmetaverse.org/
	3	* See CONTRIBUTORS.TXT for a full list of copyright holders.
	4	*
	5	* Redistribution and use in source and binary forms, with or without
	6	* modification, are permitted provided that the following conditions are met:
	7	* * Redistributions of source code must retain the above copyright
	8	* notice, this list of conditions and the following disclaimer.
	9	* * Redistributions in binary form must reproduce the above copyright
	10	* notice, this list of conditions and the following disclaimer in the
	11	* documentation and/or other materials provided with the distribution.
	12	* * Neither the name of the OpenSim Project nor the
	13	* names of its contributors may be used to endorse or promote products
	14	* derived from this software without specific prior written permission.
	15	*
	16	* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS AND ANY
	17	* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
	18	* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	19	* DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
	20	* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
	21	* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
	22	* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
	23	* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	24	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
	25	* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	26	*
	27	*/
	28	using System;
	29	using System.Collections.Generic;
	30	using System.Text;
	31	using libsecondlife;
	32
	33	namespace OpenSim.Framework.Data
	34	{
	35	/// <summary>
	36	/// An interface for connecting to user storage servers.
	37	/// </summary>
	38	public interface IUserData
	39	{
	40	/// <summary>
	41	/// Returns a user profile from a database via their UUID
	42	/// </summary>
	43	/// <param name="user">The accounts UUID</param>
	44	/// <returns>The user data profile</returns>
	45	UserProfileData getUserByUUID(LLUUID user);
	46
	47	/// <summary>
	48	/// Returns a users profile by searching their username
	49	/// </summary>
	50	/// <param name="name">The users username</param>
	51	/// <returns>The user data profile</returns>
	52	UserProfileData getUserByName(string name);
	53
	54	/// <summary>
	55	/// Returns a users profile by searching their username parts
	56	/// </summary>
	57	/// <param name="fname">Account firstname</param>
	58	/// <param name="lname">Account lastname</param>
	59	/// <returns>The user data profile</returns>
	60	UserProfileData getUserByName(string fname, string lname);
	61
	62	/// <summary>
	63	/// Returns the current agent for a user searching by it's UUID
	64	/// </summary>
	65	/// <param name="user">The users UUID</param>
	66	/// <returns>The current agent session</returns>
	67	UserAgentData getAgentByUUID(LLUUID user);
	68
	69	/// <summary>
	70	/// Returns the current session agent for a user searching by username
	71	/// </summary>
	72	/// <param name="name">The users account name</param>
	73	/// <returns>The current agent session</returns>
	74	UserAgentData getAgentByName(string name);
	75
	76	/// <summary>
	77	/// Returns the current session agent for a user searching by username parts
	78	/// </summary>
	79	/// <param name="fname">The users first account name</param>
	80	/// <param name="lname">The users account surname</param>
	81	/// <returns>The current agent session</returns>
	82	UserAgentData getAgentByName(string fname, string lname);
	83
	84	/// <summary>
	85	/// Adds a new User profile to the database
	86	/// </summary>
	87	/// <param name="user">UserProfile to add</param>
	88	void addNewUserProfile(UserProfileData user);
	89
	90	/// <summary>
	91	/// Adds a new agent to the database
	92	/// </summary>
	93	/// <param name="agent">The agent to add</param>
	94	void addNewUserAgent(UserAgentData agent);
	95
	96	/// <summary>
	97	/// Attempts to move currency units between accounts (NOT RELIABLE / TRUSTWORTHY. DONT TRY RUN YOUR OWN CURRENCY EXCHANGE WITH REAL VALUES)
	98	/// </summary>
	99	/// <param name="from">The account to transfer from</param>
	100	/// <param name="to">The account to transfer to</param>
	101	/// <param name="amount">The amount to transfer</param>
	102	/// <returns>Successful?</returns>
	103	bool moneyTransferRequest(LLUUID from, LLUUID to, uint amount);
	104
	105	/// <summary>
	106	/// Attempts to move inventory between accounts, if inventory is copyable it will be copied into the target account.
	107	/// </summary>
	108	/// <param name="from">User to transfer from</param>
	109	/// <param name="to">User to transfer to</param>
	110	/// <param name="inventory">Specified inventory item</param>
	111	/// <returns>Successful?</returns>
	112	bool inventoryTransferRequest(LLUUID from, LLUUID to, LLUUID inventory);
	113
	114	/// <summary>
	115	/// Returns the plugin version
	116	/// </summary>
	117	/// <returns>Plugin version in MAJOR.MINOR.REVISION.BUILD format</returns>
	118	string getVersion();
	119
	120	/// <summary>
	121	/// Returns the plugin name
	122	/// </summary>
	123	/// <returns>Plugin name, eg MySQL User Provider</returns>
	124	string getName();
	125
	126	/// <summary>
	127	/// Initialises the plugin (artificial constructor)
	128	/// </summary>
	129	void Initialise();
	130	}
	131	}