1
0

IAssetService.cs 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  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 OpenSim.Framework;
  29. namespace OpenSim.Services.Interfaces
  30. {
  31. public delegate void AssetRetrieved(string id, Object sender, AssetBase asset);
  32. public interface IAssetService
  33. {
  34. /// <summary>
  35. /// Get an asset synchronously.
  36. /// </summary>
  37. /// <param name="id"></param>
  38. /// <returns></returns>
  39. AssetBase Get(string id);
  40. /// <summary>
  41. /// Get an asset's metadata
  42. /// </summary>
  43. /// <param name="id"></param>
  44. /// <returns></returns>
  45. AssetMetadata GetMetadata(string id);
  46. /// <summary>
  47. /// Get an asset's data, ignoring the metadata.
  48. /// </summary>
  49. /// <param name="id"></param>
  50. /// <returns>null if there is no such asset</returns>
  51. byte[] GetData(string id);
  52. /// <summary>
  53. /// Synchronously fetches an asset from the local cache only.
  54. /// </summary>
  55. /// <param name="id">Asset ID</param>
  56. /// <returns>The fetched asset, or null if it did not exist in the local cache</returns>
  57. AssetBase GetCached(string id);
  58. /// <summary>
  59. /// Get an asset synchronously or asynchronously (depending on whether
  60. /// it is locally cached) and fire a callback with the fetched asset
  61. /// </summary>
  62. /// <param name="id">The asset id</param>
  63. /// <param name="sender">Represents the requester. Passed back via the handler</param>
  64. /// <param name="handler">
  65. /// The handler to call back once the asset has been retrieved. This will be called back with a null AssetBase
  66. /// if the asset could not be found for some reason (e.g. if it does not exist, if a remote asset service
  67. /// was not contactable, if it is not in the database, etc.).
  68. /// </param>
  69. /// <returns>True if the id was parseable, false otherwise</returns>
  70. bool Get(string id, Object sender, AssetRetrieved handler);
  71. /// <summary>
  72. /// Check if assets exist in the database.
  73. /// </summary>
  74. /// <param name="ids">The assets' IDs</param>
  75. /// <returns>For each asset: true if it exists, false otherwise</returns>
  76. bool[] AssetsExist(string[] ids);
  77. /// <summary>
  78. /// Creates a new asset
  79. /// </summary>
  80. /// <remarks>
  81. /// Returns a random ID if none is passed via the asset argument.
  82. /// </remarks>
  83. /// <param name="asset"></param>
  84. /// <returns>The Asset ID, or string.Empty if an error occurred</returns>
  85. string Store(AssetBase asset);
  86. /// <summary>
  87. /// Update an asset's content
  88. /// </summary>
  89. /// <remarks>
  90. /// Attachments and bare scripts need this!!
  91. /// </remarks>
  92. /// <param name="id"> </param>
  93. /// <param name="data"></param>
  94. /// <returns></returns>
  95. bool UpdateContent(string id, byte[] data);
  96. /// <summary>
  97. /// Delete an asset
  98. /// </summary>
  99. /// <param name="id"></param>
  100. /// <returns></returns>
  101. bool Delete(string id);
  102. }
  103. }