opensim – Blame information for rev 1

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