clockwerk-opensim – Blame information for rev 1
?pathlinks?
Rev | Author | Line No. | Line |
---|---|---|---|
1 | vero | 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; |
||
29 | using System.Collections.Generic; |
||
30 | using System.IO; |
||
31 | using OpenSim.Services.Interfaces; |
||
32 | using OpenMetaverse; |
||
33 | |||
34 | namespace OpenSim.Region.Framework.Interfaces |
||
35 | { |
||
36 | /// <summary> |
||
37 | /// Used for the OnInventoryArchiveSaved event. |
||
38 | /// </summary> |
||
39 | /// <param name="id">Request id</param> |
||
40 | /// <param name="succeeded">true if the save succeeded, false otherwise</param> |
||
41 | /// <param name="userInfo">The user for whom the save was conducted</param> |
||
42 | /// <param name="invPath">The inventory path saved</param> |
||
43 | /// <param name="savePath">The stream to which the archive was saved</param> |
||
44 | /// <param name="reportedException">Contains the exception generated if the save did not succeed</param> |
||
45 | /// <param name="saveCount">Number of inventory items saved to archive</param> |
||
46 | /// <param name="filterCount">Number of inventory items skipped due to perm filter option</param> |
||
47 | public delegate void InventoryArchiveSaved( |
||
48 | UUID id, bool succeeded, UserAccount userInfo, string invPath, Stream saveStream, Exception reportedException, int saveCount, int filterCount); |
||
49 | |||
50 | /// <summary> |
||
51 | /// Used for the OnInventoryArchiveLoaded event. |
||
52 | /// </summary> |
||
53 | /// <param name="id">Request id</param> |
||
54 | /// <param name="succeeded">true if the load succeeded, false otherwise</param> |
||
55 | /// <param name="userInfo">The user for whom the load was conducted</param> |
||
56 | /// <param name="invPath">The inventory path loaded</param> |
||
57 | /// <param name="savePath">The stream from which the archive was loaded</param> |
||
58 | /// <param name="reportedException">Contains the exception generated if the load did not succeed</param> |
||
59 | /// <param name="loadCount">Number of inventory items loaded from archive</param> |
||
60 | public delegate void InventoryArchiveLoaded( |
||
61 | UUID id, bool succeeded, UserAccount userInfo, string invPath, Stream loadStream, Exception reportedException, int loadCount); |
||
62 | |||
63 | |||
64 | public interface IInventoryArchiverModule |
||
65 | { |
||
66 | /// <summary> |
||
67 | /// Fired when an archive inventory save has been completed. |
||
68 | /// </summary> |
||
69 | event InventoryArchiveSaved OnInventoryArchiveSaved; |
||
70 | |||
71 | /// <summary> |
||
72 | /// Fired when an archive inventory load has been completed. |
||
73 | /// </summary> |
||
74 | event InventoryArchiveLoaded OnInventoryArchiveLoaded; |
||
75 | |||
76 | /// <summary> |
||
77 | /// Dearchive a user's inventory folder from the given stream |
||
78 | /// </summary> |
||
79 | /// <param name="firstName"></param> |
||
80 | /// <param name="lastName"></param> |
||
81 | /// <param name="invPath">The inventory path in which to place the loaded folders and items</param> |
||
82 | /// <param name="loadStream">The stream from which the inventory archive will be loaded</param> |
||
83 | /// <returns>true if the first stage of the operation succeeded, false otherwise</returns> |
||
84 | bool DearchiveInventory(UUID id, string firstName, string lastName, string invPath, Stream loadStream); |
||
85 | |||
86 | /// <summary> |
||
87 | /// Dearchive a user's inventory folder from the given stream |
||
88 | /// </summary> |
||
89 | /// <param name="firstName"></param> |
||
90 | /// <param name="lastName"></param> |
||
91 | /// <param name="invPath">The inventory path in which to place the loaded folders and items</param> |
||
92 | /// <param name="loadStream">The stream from which the inventory archive will be loaded</param> |
||
93 | /// <param name="options">Dearchiving options. At the moment, the only option is ("merge", true). This merges |
||
94 | /// the loaded IAR with existing folders where possible.</param> |
||
95 | /// <returns>true if the first stage of the operation succeeded, false otherwise</returns> |
||
96 | bool DearchiveInventory( |
||
97 | UUID id, string firstName, string lastName, string invPath, Stream loadStream, |
||
98 | Dictionary<string, object> options); |
||
99 | |||
100 | /// <summary> |
||
101 | /// Archive a user's inventory folder to the given stream |
||
102 | /// </summary> |
||
103 | /// <param name="id">ID representing this request. This will later be returned in the save event</param> |
||
104 | /// <param name="firstName"></param> |
||
105 | /// <param name="lastName"></param> |
||
106 | /// <param name="invPath">The inventory path from which the inventory should be saved.</param> |
||
107 | /// <param name="saveStream">The stream to which the inventory archive will be saved</param> |
||
108 | /// <returns>true if the first stage of the operation succeeded, false otherwise</returns> |
||
109 | bool ArchiveInventory(UUID id, string firstName, string lastName, string invPath, Stream saveStream); |
||
110 | |||
111 | /// <summary> |
||
112 | /// Archive a user's inventory folder to the given stream |
||
113 | /// </summary> |
||
114 | /// <param name="id">ID representing this request. This will later be returned in the save event</param> |
||
115 | /// <param name="firstName"></param> |
||
116 | /// <param name="lastName"></param> |
||
117 | /// <param name="invPath">The inventory path from which the inventory should be saved.</param> |
||
118 | /// <param name="saveStream">The stream to which the inventory archive will be saved</param> |
||
119 | /// <param name="options">Archiving options. Currently, there are none.</param> |
||
120 | /// <returns>true if the first stage of the operation succeeded, false otherwise</returns> |
||
121 | bool ArchiveInventory( |
||
122 | UUID id, string firstName, string lastName, string invPath, Stream saveStream, |
||
123 | Dictionary<string, object> options); |
||
124 | } |
||
125 | } |