C# Class OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveReadRequest

Public Properties

Property	Type	Description
MAX_MAJOR_VERSION	int

Property	Type	Description
archive	OpenSim.Framework.Serialization.TarArchiveReader
m_merge	bool
m_scene	OpenSim.Region.Framework.Scenes.Scene

Method	Description
Close ( ) : void
Execute ( ) : HashSet	Execute the request
InventoryArchiveReadRequest ( Scene scene, UserAccount userInfo, string invPath, Stream loadStream, bool merge ) : System
InventoryArchiveReadRequest ( Scene scene, UserAccount userInfo, string invPath, string loadPath, bool merge ) : System
ReplicateArchivePathToUserInventory ( string iarPath, OpenSim.Framework.InventoryFolderBase rootDestFolder, InventoryFolderBase>.Dictionary resolvedFolders, HashSet loadedNodes ) : OpenSim.Framework.InventoryFolderBase	Replicate the inventory paths in the archive to the user's inventory as necessary.

Method	Description
CreateFoldersForPath ( OpenSim.Framework.InventoryFolderBase destFolder, string iarPathExisting, string iarPathToReplicate, InventoryFolderBase>.Dictionary resolvedFolders, HashSet loadedNodes ) : void	Create a set of folders for the given path.
LoadControlFile ( string path, byte data ) : void	Load control file
LoadItem ( byte data, OpenSim.Framework.InventoryFolderBase loadFolder ) : OpenSim.Framework.InventoryItemBase	Load an item from the archive
ResolveDestinationFolder ( OpenSim.Framework.InventoryFolderBase rootDestFolder, string &archivePath, InventoryFolderBase>.Dictionary resolvedFolders ) : OpenSim.Framework.InventoryFolderBase	Resolve a destination folder

Method	Description
LoadAsset ( string assetPath, byte data ) : bool	Load an asset

public Close ( ) : void
return	void

Create a set of folders for the given path.

protected CreateFoldersForPath ( OpenSim.Framework.InventoryFolderBase destFolder, string iarPathExisting, string iarPathToReplicate, InventoryFolderBase>.Dictionary resolvedFolders, HashSet loadedNodes ) : void
destFolder	OpenSim.Framework.InventoryFolderBase	/// The root folder from which the creation will take place. ///
iarPathExisting	string	/// the part of the iar path that already exists ///
iarPathToReplicate	string	/// The path to replicate in the user's inventory from iar ///
resolvedFolders	InventoryFolderBase>.Dictionary	/// The folders that we have resolved so far for a given archive path. ///
loadedNodes	HashSet	/// Track the inventory nodes created. ///
return	void

Execute the request

public Execute ( ) : HashSet
return	HashSet

public InventoryArchiveReadRequest ( Scene scene, UserAccount userInfo, string invPath, Stream loadStream, bool merge ) : System
scene	OpenSim.Region.Framework.Scenes.Scene
userInfo	OpenSim.Services.Interfaces.UserAccount
invPath	string
loadStream	Stream
merge	bool
return	System

public InventoryArchiveReadRequest ( Scene scene, UserAccount userInfo, string invPath, string loadPath, bool merge ) : System
scene	OpenSim.Region.Framework.Scenes.Scene
userInfo	OpenSim.Services.Interfaces.UserAccount
invPath	string
loadPath	string
merge	bool
return	System

Load control file

protected LoadControlFile ( string path, byte data ) : void
path	string
data	byte
return	void

Load an item from the archive

protected LoadItem ( byte data, OpenSim.Framework.InventoryFolderBase loadFolder ) : OpenSim.Framework.InventoryItemBase
data	byte	The raw item data
loadFolder	OpenSim.Framework.InventoryFolderBase
return	OpenSim.Framework.InventoryItemBase

Replicate the inventory paths in the archive to the user's inventory as necessary.

public ReplicateArchivePathToUserInventory ( string iarPath, OpenSim.Framework.InventoryFolderBase rootDestFolder, InventoryFolderBase>.Dictionary resolvedFolders, HashSet loadedNodes ) : OpenSim.Framework.InventoryFolderBase
iarPath	string	The item archive path to replicate
rootDestFolder	OpenSim.Framework.InventoryFolderBase
resolvedFolders	InventoryFolderBase>.Dictionary	/// The folders that we have resolved so far for a given archive path. /// This method will add more folders if necessary ///
loadedNodes	HashSet	/// Track the inventory nodes created. ///
return	OpenSim.Framework.InventoryFolderBase

Resolve a destination folder

protected ResolveDestinationFolder ( OpenSim.Framework.InventoryFolderBase rootDestFolder, string &archivePath, InventoryFolderBase>.Dictionary resolvedFolders ) : OpenSim.Framework.InventoryFolderBase
rootDestFolder	OpenSim.Framework.InventoryFolderBase
archivePath	string	/// The item archive path to resolve. The portion of the path passed back is that /// which corresponds to the resolved desintation folder. /// /// The root folder for the inventory load ///
resolvedFolders	InventoryFolderBase>.Dictionary	/// The folders that we have resolved so far for a given archive path. ///
return	OpenSim.Framework.InventoryFolderBase

The maximum major version of archive that we can read. Minor versions shouldn't need a max number since version bumps here should be compatible.

public static int MAX_MAJOR_VERSION
return	int

protected TarArchiveReader,OpenSim.Framework.Serialization archive
return	OpenSim.Framework.Serialization.TarArchiveReader

Do we want to merge this load with existing inventory?

protected bool m_merge
return	bool

protected Scene,OpenSim.Region.Framework.Scenes m_scene
return	OpenSim.Region.Framework.Scenes.Scene