IUserManagement.cs 4.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  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. using System;
  28. using System.Collections.Generic;
  29. using OpenMetaverse;
  30. namespace OpenSim.Services.Interfaces
  31. {
  32. /// <summary>
  33. /// This maintains the relationship between a UUID and a user name.
  34. /// </summary>
  35. public interface IUserManagement
  36. {
  37. string GetUserName(UUID uuid);
  38. string GetUserHomeURL(UUID uuid);
  39. string GetUserUUI(UUID uuid);
  40. bool GetUserUUI(UUID userID, out string uui);
  41. string GetUserServerURL(UUID uuid, string serverType);
  42. Dictionary<UUID,string> GetUsersNames(string[] ids);
  43. /// <summary>
  44. /// Get user ID by the given name.
  45. /// </summary>
  46. /// <param name="name"></param>
  47. /// <returns>UUID.Zero if no user with that name is found or if the name is "Unknown User"</returns>
  48. UUID GetUserIdByName(string name);
  49. /// <summary>
  50. /// Get user ID by the given name.
  51. /// </summary>
  52. /// <param name="firstName"></param>
  53. /// <param name="lastName"></param>
  54. /// <returns>UUID.Zero if no user with that name is found or if the name is "Unknown User"</returns>
  55. UUID GetUserIdByName(string firstName, string lastName);
  56. /// <summary>
  57. /// Add a user.
  58. /// </summary>
  59. /// <remarks>
  60. /// If an account is found for the UUID, then the names in this will be used rather than any information
  61. /// extracted from creatorData.
  62. /// </remarks>
  63. /// <param name="uuid"></param>
  64. /// <param name="creatorData">The creator data for this user.</param>
  65. void AddUser(UUID uuid, string creatorData);
  66. /// <summary>
  67. /// Add a user.
  68. /// </summary>
  69. /// <remarks>
  70. /// The UUID is related to the name without any other checks being performed, such as user account presence.
  71. /// </remarks>
  72. /// <param name="uuid"></param>
  73. /// <param name="firstName"></param>
  74. /// <param name="lastName"></param>
  75. void AddUser(UUID uuid, string first, string last, bool isNPC = false);
  76. /// <summary>
  77. /// Add a user.
  78. /// </summary>
  79. /// <remarks>
  80. /// The arguments apart from uuid are formed into a creatorData string and processing proceeds as for the
  81. /// AddUser(UUID uuid, string creatorData) method.
  82. /// </remarks>
  83. /// <param name="uuid"></param>
  84. /// <param name="firstName"></param>
  85. /// <param name="profileURL"></param>
  86. void AddUser(UUID uuid, string firstName, string lastName, string homeURL);
  87. bool RemoveUser(UUID uuid);
  88. bool IsLocalGridUser(UUID uuid);
  89. }
  90. }