aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Services/Interfaces
diff options
context:
space:
mode:
Diffstat (limited to 'OpenSim/Services/Interfaces')
-rw-r--r--OpenSim/Services/Interfaces/IUserManagement.cs96
1 files changed, 96 insertions, 0 deletions
diff --git a/OpenSim/Services/Interfaces/IUserManagement.cs b/OpenSim/Services/Interfaces/IUserManagement.cs
new file mode 100644
index 0000000..b69a63b
--- /dev/null
+++ b/OpenSim/Services/Interfaces/IUserManagement.cs
@@ -0,0 +1,96 @@
1/*
2 * Copyright (c) Contributors, http://opensimulator.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 OpenSimulator 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
28using System;
29using System.Collections.Generic;
30
31using OpenMetaverse;
32
33namespace OpenSim.Services.Interfaces
34{
35 /// <summary>
36 /// This maintains the relationship between a UUID and a user name.
37 /// </summary>
38 public interface IUserManagement
39 {
40 string GetUserName(UUID uuid);
41 string GetUserHomeURL(UUID uuid);
42 string GetUserUUI(UUID uuid);
43 string GetUserServerURL(UUID uuid, string serverType);
44
45 /// <summary>
46 /// Get user ID by the given name.
47 /// </summary>
48 /// <param name="name"></param>
49 /// <returns>UUID.Zero if no user with that name is found or if the name is "Unknown User"</returns>
50 UUID GetUserIdByName(string name);
51
52 /// <summary>
53 /// Get user ID by the given name.
54 /// </summary>
55 /// <param name="firstName"></param>
56 /// <param name="lastName"></param>
57 /// <returns>UUID.Zero if no user with that name is found or if the name is "Unknown User"</returns>
58 UUID GetUserIdByName(string firstName, string lastName);
59
60 /// <summary>
61 /// Add a user.
62 /// </summary>
63 /// <remarks>
64 /// If an account is found for the UUID, then the names in this will be used rather than any information
65 /// extracted from creatorData.
66 /// </remarks>
67 /// <param name="uuid"></param>
68 /// <param name="creatorData">The creator data for this user.</param>
69 void AddUser(UUID uuid, string creatorData);
70
71 /// <summary>
72 /// Add a user.
73 /// </summary>
74 /// <remarks>
75 /// The UUID is related to the name without any other checks being performed, such as user account presence.
76 /// </remarks>
77 /// <param name="uuid"></param>
78 /// <param name="firstName"></param>
79 /// <param name="lastName"></param>
80 void AddUser(UUID uuid, string firstName, string lastName);
81
82 /// <summary>
83 /// Add a user.
84 /// </summary>
85 /// <remarks>
86 /// The arguments apart from uuid are formed into a creatorData string and processing proceeds as for the
87 /// AddUser(UUID uuid, string creatorData) method.
88 /// </remarks>
89 /// <param name="uuid"></param>
90 /// <param name="firstName"></param>
91 /// <param name="profileURL"></param>
92 void AddUser(UUID uuid, string firstName, string lastName, string homeURL);
93
94 bool IsLocalGridUser(UUID uuid);
95 }
96}