1
0

IRegionProfileService.cs 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  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 System.Text;
  30. using OpenMetaverse;
  31. namespace OpenSim.Data
  32. {
  33. public interface IRegionProfileService
  34. {
  35. /// <summary>
  36. /// Returns a region by argument
  37. /// </summary>
  38. /// <param name="uuid">A UUID key of the region to return</param>
  39. /// <returns>A SimProfileData for the region</returns>
  40. RegionProfileData GetRegion(UUID uuid);
  41. /// <summary>
  42. /// Returns a region by argument
  43. /// </summary>
  44. /// <param name="uuid">A regionHandle of the region to return</param>
  45. /// <returns>A SimProfileData for the region</returns>
  46. RegionProfileData GetRegion(ulong handle);
  47. /// <summary>
  48. /// Returns a region by argument
  49. /// </summary>
  50. /// <param name="regionName">A partial regionName of the region to return</param>
  51. /// <returns>A SimProfileData for the region</returns>
  52. RegionProfileData GetRegion(string regionName);
  53. List<RegionProfileData> GetRegions(uint xmin, uint ymin, uint xmax, uint ymax);
  54. List<RegionProfileData> GetRegions(string name, int maxNum);
  55. DataResponse AddUpdateRegion(RegionProfileData sim, RegionProfileData existingSim);
  56. DataResponse DeleteRegion(string uuid);
  57. }
  58. public interface IRegionProfileRouter
  59. {
  60. /// <summary>
  61. /// Request sim profile information from a grid server, by Region UUID
  62. /// </summary>
  63. /// <param name="regionId">The region UUID to look for</param>
  64. /// <param name="gridserverUrl"></param>
  65. /// <param name="gridserverSendkey"></param>
  66. /// <param name="gridserverRecvkey"></param>
  67. /// <returns>The sim profile. Null if there was a request failure</returns>
  68. /// <remarks>This method should be statics</remarks>
  69. RegionProfileData RequestSimProfileData(UUID regionId, Uri gridserverUrl,
  70. string gridserverSendkey, string gridserverRecvkey);
  71. /// <summary>
  72. /// Request sim profile information from a grid server, by Region Handle
  73. /// </summary>
  74. /// <param name="regionHandle">the region handle to look for</param>
  75. /// <param name="gridserverUrl"></param>
  76. /// <param name="gridserverSendkey"></param>
  77. /// <param name="gridserverRecvkey"></param>
  78. /// <returns>The sim profile. Null if there was a request failure</returns>
  79. RegionProfileData RequestSimProfileData(ulong regionHandle, Uri gridserverUrl,
  80. string gridserverSendkey, string gridserverRecvkey);
  81. /// <summary>
  82. /// Request sim profile information from a grid server, by Region Name
  83. /// </summary>
  84. /// <param name="regionName">the region name to look for</param>
  85. /// <param name="gridserverUrl"></param>
  86. /// <param name="gridserverSendkey"></param>
  87. /// <param name="gridserverRecvkey"></param>
  88. /// <returns>The sim profile. Null if there was a request failure</returns>
  89. RegionProfileData RequestSimProfileData(string regionName, Uri gridserverUrl,
  90. string gridserverSendkey, string gridserverRecvkey);
  91. }
  92. }