OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Protected Member Functions | Properties | List of all members
OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector Class Reference
Inheritance diagram for OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector:
Collaboration graph
[legend]

Public Member Functions

 RemoteXInventoryServicesConnector ()
 
 RemoteXInventoryServicesConnector (string url)
 
 RemoteXInventoryServicesConnector (IConfigSource source)
 
void Initialise (IConfigSource source)
 This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created. More...
 
void PostInitialise ()
 This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...
 
void Close ()
 This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...
 
void AddRegion (Scene scene)
 This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called. More...
 
void RemoveRegion (Scene scene)
 This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed. More...
 
void RegionLoaded (Scene scene)
 This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module. More...
 
bool CreateUserInventory (UUID user)
 Create the entire inventory for a given user More...
 
List< InventoryFolderBaseGetInventorySkeleton (UUID userId)
 Gets the skeleton of the inventory – folders only More...
 
InventoryFolderBase GetRootFolder (UUID userID)
 Retrieve the root inventory folder for the given user. More...
 
InventoryFolderBase GetFolderForType (UUID userID, FolderType type)
 Gets the user folder for the given folder-type More...
 
InventoryCollection GetFolderContent (UUID userID, UUID folderID)
 Gets everything (folders and items) inside a folder More...
 
virtual InventoryCollection[] GetMultipleFoldersContent (UUID principalID, UUID[] folderIDs)
 Gets everything (folders and items) inside a folder More...
 
List< InventoryItemBaseGetFolderItems (UUID userID, UUID folderID)
 Gets the items inside a folder More...
 
bool AddFolder (InventoryFolderBase folder)
 Add a new folder to the user's inventory More...
 
bool UpdateFolder (InventoryFolderBase folder)
 Update a folder in the user's inventory More...
 
bool MoveFolder (InventoryFolderBase folder)
 Move an inventory folder to a new location More...
 
bool DeleteFolders (UUID ownerID, List< UUID > folderIDs)
 Delete an item from the user's inventory More...
 
bool PurgeFolder (InventoryFolderBase folder)
 Purge an inventory folder of all its items and subfolders. More...
 
bool AddItem (InventoryItemBase item)
 Add a new item to the user's inventory More...
 
bool UpdateItem (InventoryItemBase item)
 Update an item in the user's inventory More...
 
bool MoveItems (UUID ownerID, List< InventoryItemBase > items)
 
bool DeleteItems (UUID ownerID, List< UUID > itemIDs)
 Delete an item from the user's inventory More...
 
InventoryItemBase GetItem (InventoryItemBase item)
 Get an item, given by its UUID More...
 
InventoryItemBase[] GetMultipleItems (UUID userID, UUID[] itemIDs)
 Get multiple items, given by their UUIDs More...
 
InventoryFolderBase GetFolder (InventoryFolderBase folder)
 Get a folder, given by its UUID More...
 
bool HasInventoryForUser (UUID userID)
 Does the given user have an inventory structure? More...
 
List< InventoryItemBaseGetActiveGestures (UUID userId)
 Get the active gestures of the agent. More...
 
int GetAssetPermissions (UUID userID, UUID assetID)
 Get the union of permissions of all inventory items that hold the given assetID. More...
 

Protected Member Functions

void Init (IConfigSource source)
 

Properties

Scene Scene [get, set]
 Scene used by this module. This currently needs to be publicly settable for HGInventoryBroker. More...
 
IUserManagement UserManager [get]
 
Type ReplaceableInterface [get]
 
string Name [get]
 
- Properties inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase
string Name [get]
 
Type ReplaceableInterface [get]
 If this returns non-null, it is the type of an interface that this module intends to register. This will cause the loader to defer loading of this module until all other modules have been loaded. If no other module has registered the interface by then, this module will be activated, else it will remain inactive, letting the other module take over. This should return non-null ONLY in modules that are intended to be easily replaceable, e.g. stub implementations that the developer expects to be replaced by third party provided modules. More...
 

Detailed Description

Definition at line 45 of file RemoteXInventoryServiceConnector.cs.

Constructor & Destructor Documentation

OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.RemoteXInventoryServicesConnector ( )
inline

Definition at line 87 of file RemoteXInventoryServiceConnector.cs.

OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.RemoteXInventoryServicesConnector ( string  url)
inline

Definition at line 91 of file RemoteXInventoryServiceConnector.cs.

OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.RemoteXInventoryServicesConnector ( IConfigSource  source)
inline

Definition at line 96 of file RemoteXInventoryServiceConnector.cs.

Member Function Documentation

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.AddFolder ( InventoryFolderBase  folder)
inline

Add a new folder to the user's inventory

Parameters
folder
Returns
true if the folder was successfully added

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 217 of file RemoteXInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.AddItem ( InventoryItemBase  item)
inline

Add a new item to the user's inventory

Parameters
itemThe item to be added. If item.FolderID == UUID.Zero then the item is added to the most suitable system folder. If there is no suitable folder then the item is added to the user's root inventory folder.
Returns
true if the item was successfully added, false if it was not

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 260 of file RemoteXInventoryServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.AddRegion ( Scene  scene)
inline

This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called.

Parameters
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 132 of file RemoteXInventoryServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.Close ( )
inline

This is the inverse to Initialise. After a Close(), this instance won't be usable anymore.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 128 of file RemoteXInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.CreateUserInventory ( UUID  user)
inline

Create the entire inventory for a given user

Parameters
user
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 165 of file RemoteXInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.DeleteFolders ( UUID  userID,
List< UUID >  folderIDs 
)
inline

Delete an item from the user's inventory

Parameters
item
Returns
true if the item was successfully deleted

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 241 of file RemoteXInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.DeleteItems ( UUID  userID,
List< UUID >  itemIDs 
)
inline

Delete an item from the user's inventory

Parameters
item
Returns
true if the item was successfully deleted

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 285 of file RemoteXInventoryServiceConnector.cs.

List<InventoryItemBase> OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.GetActiveGestures ( UUID  userId)
inline

Get the active gestures of the agent.

Parameters
userId
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 328 of file RemoteXInventoryServiceConnector.cs.

int OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.GetAssetPermissions ( UUID  userID,
UUID  assetID 
)
inline

Get the union of permissions of all inventory items that hold the given assetID.

Parameters
userID
assetID
Returns
The permissions or 0 if no such asset is found in the user's inventory

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 333 of file RemoteXInventoryServiceConnector.cs.

InventoryFolderBase OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.GetFolder ( InventoryFolderBase  folder)
inline

Get a folder, given by its UUID

Parameters
folder
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 314 of file RemoteXInventoryServiceConnector.cs.

InventoryCollection OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.GetFolderContent ( UUID  userID,
UUID  folderID 
)
inline

Gets everything (folders and items) inside a folder

Parameters
userId
folderID
Returns
Inventory content. null if the request failed.

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 185 of file RemoteXInventoryServiceConnector.cs.

InventoryFolderBase OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.GetFolderForType ( UUID  userID,
FolderType  type 
)
inline

Gets the user folder for the given folder-type

Parameters
userID
type
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 180 of file RemoteXInventoryServiceConnector.cs.

List<InventoryItemBase> OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.GetFolderItems ( UUID  userID,
UUID  folderID 
)
inline

Gets the items inside a folder

Parameters
userID
folderID
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 212 of file RemoteXInventoryServiceConnector.cs.

List<InventoryFolderBase> OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.GetInventorySkeleton ( UUID  userId)
inline

Gets the skeleton of the inventory – folders only

Parameters
userId
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 170 of file RemoteXInventoryServiceConnector.cs.

InventoryItemBase OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.GetItem ( InventoryItemBase  item)
inline

Get an item, given by its UUID

Parameters
item
Returns
null if no item was found, otherwise the found item

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 295 of file RemoteXInventoryServiceConnector.cs.

virtual InventoryCollection [] OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.GetMultipleFoldersContent ( UUID  userID,
UUID[]  folderIDs 
)
inlinevirtual

Gets everything (folders and items) inside a folder

Parameters
userId
folderIDs
Returns
Inventory content.

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 207 of file RemoteXInventoryServiceConnector.cs.

InventoryItemBase [] OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.GetMultipleItems ( UUID  userID,
UUID[]  ids 
)
inline

Get multiple items, given by their UUIDs

Parameters
item
Returns
null if no item was found, otherwise the found item

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 306 of file RemoteXInventoryServiceConnector.cs.

InventoryFolderBase OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.GetRootFolder ( UUID  userID)
inline

Retrieve the root inventory folder for the given user.

Parameters
userID
Returns
null if no root folder was found

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 175 of file RemoteXInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.HasInventoryForUser ( UUID  userID)
inline

Does the given user have an inventory structure?

Parameters
userID
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 323 of file RemoteXInventoryServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.Init ( IConfigSource  source)
inlineprotected

Definition at line 101 of file RemoteXInventoryServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.Initialise ( IConfigSource  source)
inline

This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created.

Parameters
sourceA IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 108 of file RemoteXInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.MoveFolder ( InventoryFolderBase  folder)
inline

Move an inventory folder to a new location

Parameters
folderA folder containing the details of the new location
Returns
true if the folder was successfully moved

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 233 of file RemoteXInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.MoveItems ( UUID  ownerID,
List< InventoryItemBase items 
)
inline
void OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.PostInitialise ( )
inline

This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised.

Implements OpenSim.Region.Framework.Interfaces.ISharedRegionModule.

Definition at line 124 of file RemoteXInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.PurgeFolder ( InventoryFolderBase  folder)
inline

Purge an inventory folder of all its items and subfolders.

Parameters
folder
Returns
true if the folder was successfully purged

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 252 of file RemoteXInventoryServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.RegionLoaded ( Scene  scene)
inline

This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module.

Parameters
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 152 of file RemoteXInventoryServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.RemoveRegion ( Scene  scene)
inline

This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed.

Parameters
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 146 of file RemoteXInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.UpdateFolder ( InventoryFolderBase  folder)
inline

Update a folder in the user's inventory

Parameters
folder
Returns
true if the folder was successfully updated

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 225 of file RemoteXInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.UpdateItem ( InventoryItemBase  item)
inline

Update an item in the user's inventory

Parameters
item
Returns
true if the item was successfully updated

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 268 of file RemoteXInventoryServiceConnector.cs.

Property Documentation

string OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.Name
get

Definition at line 83 of file RemoteXInventoryServiceConnector.cs.

Type OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.ReplaceableInterface
get

Definition at line 78 of file RemoteXInventoryServiceConnector.cs.

Scene OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.Scene
getset

Scene used by this module. This currently needs to be publicly settable for HGInventoryBroker.

Definition at line 53 of file RemoteXInventoryServiceConnector.cs.

IUserManagement OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector.UserManager
get

Definition at line 60 of file RemoteXInventoryServiceConnector.cs.


The documentation for this class was generated from the following file: