* Bringing Sugilite in to trunk

author: Adam Frisby 2007-07-11 08:10:25 +0000
committer: Adam Frisby 2007-07-11 08:10:25 +0000
commit: e2ff441e31328e60c8bb1d4bb32fa4ac64f91978 (patch)
tree: 8405b6cef57b66a58f31a24c859846085d0b81f7 /OpenSim/Framework/Data/UserData.cs
parent: * Wiping trunk in prep for Sugilite (diff)
parent: * Applying dalien's patches from bug#177 and #179 (diff)
download: opensim-SC_OLD-e2ff441e31328e60c8bb1d4bb32fa4ac64f91978.zip
opensim-SC_OLD-e2ff441e31328e60c8bb1d4bb32fa4ac64f91978.tar.gz
opensim-SC_OLD-e2ff441e31328e60c8bb1d4bb32fa4ac64f91978.tar.bz2
opensim-SC_OLD-e2ff441e31328e60c8bb1d4bb32fa4ac64f91978.tar.xz
1 files changed, 128 insertions, 0 deletions
diff --git a/OpenSim/Framework/Data/UserData.cs b/OpenSim/Framework/Data/UserData.cs
new file mode 100644
index 0000000..c65f9fd
--- /dev/null
+++ b/OpenSim/Framework/Data/UserData.cs
@@ -0,0 +1,128 @@
+/*
+* 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 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	Adam Frisby	2007-07-11 08:10:25 +0000
committer	Adam Frisby	2007-07-11 08:10:25 +0000
commit	e2ff441e31328e60c8bb1d4bb32fa4ac64f91978 (patch)
tree	8405b6cef57b66a58f31a24c859846085d0b81f7 /OpenSim/Framework/Data/UserData.cs
parent	* Wiping trunk in prep for Sugilite (diff)
parent	* Applying dalien's patches from bug#177 and #179 (diff)
download	opensim-SC_OLD-e2ff441e31328e60c8bb1d4bb32fa4ac64f91978.zip opensim-SC_OLD-e2ff441e31328e60c8bb1d4bb32fa4ac64f91978.tar.gz opensim-SC_OLD-e2ff441e31328e60c8bb1d4bb32fa4ac64f91978.tar.bz2 opensim-SC_OLD-e2ff441e31328e60c8bb1d4bb32fa4ac64f91978.tar.xz

diff --git a/OpenSim/Framework/Data/UserData.cs b/OpenSim/Framework/Data/UserData.cs new file mode 100644 index 0000000..c65f9fd --- /dev/null +++ b/OpenSim/Framework/Data/UserData.cs
@@ -0,0 +1,128 @@
	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 libsecondlife;
	29
	30	namespace OpenSim.Framework.Data
	31	{
	32	/// <summary>
	33	/// An interface for connecting to user storage servers.
	34	/// </summary>
	35	public interface IUserData
	36	{
	37	/// <summary>
	38	/// Returns a user profile from a database via their UUID
	39	/// </summary>
	40	/// <param name="user">The accounts UUID</param>
	41	/// <returns>The user data profile</returns>
	42	UserProfileData getUserByUUID(LLUUID user);
	43
	44	/// <summary>
	45	/// Returns a users profile by searching their username
	46	/// </summary>
	47	/// <param name="name">The users username</param>
	48	/// <returns>The user data profile</returns>
	49	UserProfileData getUserByName(string name);
	50
	51	/// <summary>
	52	/// Returns a users profile by searching their username parts
	53	/// </summary>
	54	/// <param name="fname">Account firstname</param>
	55	/// <param name="lname">Account lastname</param>
	56	/// <returns>The user data profile</returns>
	57	UserProfileData getUserByName(string fname, string lname);
	58
	59	/// <summary>
	60	/// Returns the current agent for a user searching by it's UUID
	61	/// </summary>
	62	/// <param name="user">The users UUID</param>
	63	/// <returns>The current agent session</returns>
	64	UserAgentData getAgentByUUID(LLUUID user);
	65
	66	/// <summary>
	67	/// Returns the current session agent for a user searching by username
	68	/// </summary>
	69	/// <param name="name">The users account name</param>
	70	/// <returns>The current agent session</returns>
	71	UserAgentData getAgentByName(string name);
	72
	73	/// <summary>
	74	/// Returns the current session agent for a user searching by username parts
	75	/// </summary>
	76	/// <param name="fname">The users first account name</param>
	77	/// <param name="lname">The users account surname</param>
	78	/// <returns>The current agent session</returns>
	79	UserAgentData getAgentByName(string fname, string lname);
	80
	81	/// <summary>
	82	/// Adds a new User profile to the database
	83	/// </summary>
	84	/// <param name="user">UserProfile to add</param>
	85	void addNewUserProfile(UserProfileData user);
	86
	87	/// <summary>
	88	/// Adds a new agent to the database
	89	/// </summary>
	90	/// <param name="agent">The agent to add</param>
	91	void addNewUserAgent(UserAgentData agent);
	92
	93	/// <summary>
	94	/// Attempts to move currency units between accounts (NOT RELIABLE / TRUSTWORTHY. DONT TRY RUN YOUR OWN CURRENCY EXCHANGE WITH REAL VALUES)
	95	/// </summary>
	96	/// <param name="from">The account to transfer from</param>
	97	/// <param name="to">The account to transfer to</param>
	98	/// <param name="amount">The amount to transfer</param>
	99	/// <returns>Successful?</returns>
	100	bool moneyTransferRequest(LLUUID from, LLUUID to, uint amount);
	101
	102	/// <summary>
	103	/// Attempts to move inventory between accounts, if inventory is copyable it will be copied into the target account.
	104	/// </summary>
	105	/// <param name="from">User to transfer from</param>
	106	/// <param name="to">User to transfer to</param>
	107	/// <param name="inventory">Specified inventory item</param>
	108	/// <returns>Successful?</returns>
	109	bool inventoryTransferRequest(LLUUID from, LLUUID to, LLUUID inventory);
	110
	111	/// <summary>
	112	/// Returns the plugin version
	113	/// </summary>
	114	/// <returns>Plugin version in MAJOR.MINOR.REVISION.BUILD format</returns>
	115	string getVersion();
	116
	117	/// <summary>
	118	/// Returns the plugin name
	119	/// </summary>
	120	/// <returns>Plugin name, eg MySQL User Provider</returns>
	121	string getName();
	122
	123	/// <summary>
	124	/// Initialises the plugin (artificial constructor)
	125	/// </summary>
	126	void Initialise();
	127	}
	128	}