C# Class Universe.Modules.Archivers.InventoryArchiveWriteRequest

Mostra file Open project: Virtual-Universe/Virtual-Universe Class Usage Examples

Protected Properties

Property Type Description
m_archiveWriter Universe.Framework.Serialization.TarArchiveWriter
m_assetGatherer Universe.Framework.SceneInfo.UuidGatherer
m_assetUuids AssetType>.Dictionary
m_assetsToAdd List
m_defaultFolderToSave Universe.Framework.Services.ClassHelpers.Inventory.InventoryFolderBase
m_id System.Guid
m_registry IRegistryCore
m_userUuids int>.Dictionary

Public Methods

Method Description
CreateArchiveFolderName ( InventoryFolderBase folder ) : string

Create the archive name for a particular folder.
CreateArchiveFolderName ( string name, UUID id ) : string

Create an archive folder name given its constituent components
CreateArchiveItemName ( InventoryItemBase item ) : string

Create the archive name for a particular item.
CreateArchiveItemName ( string name, UUID id ) : string

Create an archive item name given its constituent components
CreateControlFile ( bool saveAssets ) : string

Create the control file for a 0.1 version archive
Execute ( ) : void

Execute the inventory write request
InventoryArchiveWriteRequest ( System.Guid id, InventoryArchiverModule module, IRegistryCore registry, UserAccount userInfo, string invPath, Stream saveStream, bool UseAssets, InventoryFolderBase folderBase, List assetsToAdd, string checkPermissions ) : System

Constructor
InventoryArchiveWriteRequest ( System.Guid id, InventoryArchiverModule module, IRegistryCore registry, UserAccount userInfo, string invPath, string savePath, bool UseAssets, string checkPermissions ) : System

Constructor

Protected Methods

Method Description
ReceivedAllAssets ( ICollection assetsFoundUuids, ICollection assetsNotFoundUuids ) : void
SaveInvFolder ( InventoryFolderBase inventoryFolder, string path, bool saveThisFolderItself ) : void

Save an inventory folder
SaveInvItem ( InventoryItemBase inventoryItem, string path ) : void
SaveUsers ( ) : void

Save information for the users that we've collected.

Private Methods

Method Description
CanUserArchiveObject ( UUID UserID, InventoryItemBase InvItem ) : bool

Checks whether the user has permission to export an inventory item to an IAR.

Method Details

CreateArchiveFolderName() public static method

Create the archive name for a particular folder.
public static CreateArchiveFolderName ( InventoryFolderBase folder ) : string
folder Universe.Framework.Services.ClassHelpers.Inventory.InventoryFolderBase
return string

CreateArchiveFolderName() public static method

Create an archive folder name given its constituent components
public static CreateArchiveFolderName ( string name, UUID id ) : string
name string
id UUID
return string

CreateArchiveItemName() public static method

Create the archive name for a particular item.
public static CreateArchiveItemName ( InventoryItemBase item ) : string
item Universe.Framework.Services.ClassHelpers.Inventory.InventoryItemBase
return string

CreateArchiveItemName() public static method

Create an archive item name given its constituent components
public static CreateArchiveItemName ( string name, UUID id ) : string
name string
id UUID
return string

CreateControlFile() public static method

Create the control file for a 0.1 version archive
public static CreateControlFile ( bool saveAssets ) : string
saveAssets bool
return string

Execute() public method

Execute the inventory write request
public Execute ( ) : void
return void

InventoryArchiveWriteRequest() public method

Constructor
public InventoryArchiveWriteRequest ( System.Guid id, InventoryArchiverModule module, IRegistryCore registry, UserAccount userInfo, string invPath, Stream saveStream, bool UseAssets, InventoryFolderBase folderBase, List assetsToAdd, string checkPermissions ) : System
id System.Guid
module InventoryArchiverModule
registry IRegistryCore
userInfo Universe.Framework.Services.UserAccount
invPath string
saveStream Stream
UseAssets bool
folderBase Universe.Framework.Services.ClassHelpers.Inventory.InventoryFolderBase
assetsToAdd List
checkPermissions string
return System

InventoryArchiveWriteRequest() public method

Constructor
public InventoryArchiveWriteRequest ( System.Guid id, InventoryArchiverModule module, IRegistryCore registry, UserAccount userInfo, string invPath, string savePath, bool UseAssets, string checkPermissions ) : System
id System.Guid
module InventoryArchiverModule
registry IRegistryCore
userInfo Universe.Framework.Services.UserAccount
invPath string
savePath string
UseAssets bool
checkPermissions string
return System

ReceivedAllAssets() protected method

protected ReceivedAllAssets ( ICollection assetsFoundUuids, ICollection assetsNotFoundUuids ) : void
assetsFoundUuids ICollection
assetsNotFoundUuids ICollection
return void

SaveInvFolder() protected method

Save an inventory folder
protected SaveInvFolder ( InventoryFolderBase inventoryFolder, string path, bool saveThisFolderItself ) : void
inventoryFolder Universe.Framework.Services.ClassHelpers.Inventory.InventoryFolderBase The inventory folder to save
path string The path to which the folder should be saved
saveThisFolderItself bool If true, save this folder itself. If false, only saves contents
return void

SaveInvItem() protected method

protected SaveInvItem ( InventoryItemBase inventoryItem, string path ) : void
inventoryItem Universe.Framework.Services.ClassHelpers.Inventory.InventoryItemBase
path string
return void

SaveUsers() protected method

Save information for the users that we've collected.
protected SaveUsers ( ) : void
return void

Property Details

m_archiveWriter protected_oe property

protected TarArchiveWriter,Universe.Framework.Serialization m_archiveWriter
return Universe.Framework.Serialization.TarArchiveWriter

m_assetGatherer protected_oe property

protected UuidGatherer,Universe.Framework.SceneInfo m_assetGatherer
return Universe.Framework.SceneInfo.UuidGatherer

m_assetUuids protected_oe property

protected Dictionary m_assetUuids
return AssetType>.Dictionary

m_assetsToAdd protected_oe property

protected List m_assetsToAdd
return List

m_defaultFolderToSave protected_oe property

protected InventoryFolderBase,Universe.Framework.Services.ClassHelpers.Inventory m_defaultFolderToSave
return Universe.Framework.Services.ClassHelpers.Inventory.InventoryFolderBase

m_id protected_oe property

protected Guid,System m_id
return System.Guid

m_registry protected_oe property

protected IRegistryCore m_registry
return IRegistryCore

m_userUuids protected_oe property

protected Dictionary m_userUuids
return int>.Dictionary