ISimulationDataStore.cs 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  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.Collections.Generic;
  28. using OpenMetaverse;
  29. using OpenSim.Framework;
  30. using OpenSim.Region.Framework.Scenes;
  31. namespace OpenSim.Region.Framework.Interfaces
  32. {
  33. public interface ISimulationDataStore
  34. {
  35. /// <summary>
  36. /// Initialises the data storage engine
  37. /// </summary>
  38. /// <param name="filename">The file to save the database to (may not be applicable). Alternatively,
  39. /// a connection string for the database</param>
  40. void Initialise(string filename);
  41. /// <summary>
  42. /// Dispose the database
  43. /// </summary>
  44. void Dispose();
  45. /// <summary>
  46. /// Stores all object's details apart from inventory
  47. /// </summary>
  48. /// <param name="obj"></param>
  49. /// <param name="regionUUID"></param>
  50. void StoreObject(SceneObjectGroup obj, UUID regionUUID);
  51. /// <summary>
  52. /// Entirely removes the object, including inventory
  53. /// </summary>
  54. /// <param name="uuid"></param>
  55. /// <param name="regionUUID"></param>
  56. /// <returns></returns>
  57. void RemoveObject(UUID uuid, UUID regionUUID);
  58. /// <summary>
  59. /// Store a prim's inventory
  60. /// </summary>
  61. /// <returns></returns>
  62. void StorePrimInventory(UUID primID, ICollection<TaskInventoryItem> items);
  63. /// <summary>
  64. /// Load persisted objects from region storage.
  65. /// </summary>
  66. /// <param name="regionUUID">the Region UUID</param>
  67. /// <returns>List of loaded groups</returns>
  68. List<SceneObjectGroup> LoadObjects(UUID regionUUID);
  69. /// <summary>
  70. /// Store a terrain in region storage
  71. /// </summary>
  72. /// <param name="ter">HeightField data</param>
  73. /// <param name="regionID">region UUID</param>
  74. void StoreTerrain(TerrainData terrain, UUID regionID);
  75. /// <summary>
  76. /// Store baked terrain in region storage
  77. /// </summary>
  78. /// <param name="ter">HeightField data</param>
  79. /// <param name="regionID">region UUID</param>
  80. void StoreBakedTerrain(TerrainData terrain, UUID regionID);
  81. // Legacy version kept for downward compabibility
  82. void StoreTerrain(double[,] terrain, UUID regionID);
  83. /// <summary>
  84. /// Load terrain from region storage
  85. /// </summary>
  86. /// <param name="regionID">the region UUID</param>
  87. /// <param name="pSizeX">the X dimension of the terrain being filled</param>
  88. /// <param name="pSizeY">the Y dimension of the terrain being filled</param>
  89. /// <param name="pSizeZ">the Z dimension of the terrain being filled</param>
  90. /// <returns>Heightfield data</returns>
  91. TerrainData LoadTerrain(UUID regionID, int pSizeX, int pSizeY, int pSizeZ);
  92. TerrainData LoadBakedTerrain(UUID regionID, int pSizeX, int pSizeY, int pSizeZ);
  93. // Legacy version kept for downward compabibility
  94. double[,] LoadTerrain(UUID regionID);
  95. void StoreLandObject(ILandObject Parcel);
  96. /// <summary>
  97. /// <list type="bullet">
  98. /// <item>delete from land where UUID=globalID</item>
  99. /// <item>delete from landaccesslist where LandUUID=globalID</item>
  100. /// </list>
  101. /// </summary>
  102. /// <param name="globalID"></param>
  103. void RemoveLandObject(UUID globalID);
  104. List<LandData> LoadLandObjects(UUID regionUUID);
  105. void StoreRegionSettings(RegionSettings rs);
  106. RegionSettings LoadRegionSettings(UUID regionUUID);
  107. UUID[] GetObjectIDs(UUID regionID);
  108. /// <summary>
  109. /// Load Environment settings from region storage
  110. /// </summary>
  111. /// <param name="regionUUID">the region UUID</param>
  112. /// <returns>LLSD string for viewer</returns>
  113. string LoadRegionEnvironmentSettings(UUID regionUUID);
  114. /// <summary>
  115. /// Store Environment settings into region storage
  116. /// </summary>
  117. /// <param name="regionUUID">the region UUID</param>
  118. /// <param name="settings">LLSD string from viewer</param>
  119. void StoreRegionEnvironmentSettings(UUID regionUUID, string settings);
  120. /// <summary>
  121. /// Delete Environment settings from region storage
  122. /// </summary>
  123. /// <param name="regionUUID">the region UUID</param>
  124. void RemoveRegionEnvironmentSettings(UUID regionUUID);
  125. void SaveExtra(UUID regionID, string name, string val);
  126. void RemoveExtra(UUID regionID, string name);
  127. Dictionary<string, string> GetExtra(UUID regionID);
  128. void Shutdown();
  129. }
  130. }