Inheritance diagram for OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule:

Collaboration diagram for OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule:

Public Member Functions
void	Initialise (IConfigSource config)
	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	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 s)
	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...

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	HandleAvatarPickerRequest (IClientAPI client, UUID avatarID, UUID RequestID, string query)

List< UserData >	GetUserData (string query, int page_size, int page_number)

UUID	GetUserIdByName (string name)
	Get user ID by the given name. More...

UUID	GetUserIdByName (string firstName, string lastName)
	Get user ID by the given name. More...

string	GetUserName (UUID uuid)

string	GetUserHomeURL (UUID userID)

string	GetUserServerURL (UUID userID, string serverType)

string	GetUserUUI (UUID userID)

bool	GetUserUUI (UUID userID, out string uui)

bool	GetUser (UUID uuid, out UserData userdata)

void	AddUser (UUID uuid, string first, string last)
	Add a user. More...

void	AddUser (UUID uuid, string first, string last, string homeURL)
	Add a user. More...

void	AddUser (UUID id, string creatorData)
	Add a user. More...

bool	IsLocalGridUser (UUID uuid)

Protected Member Functions
virtual void	AddAdditionalUsers (string query, List< UserData > users)

void	Init ()

void	RegisterConsoleCmds ()

Protected Attributes
bool	m_Enabled

List< Scene >	m_Scenes = new List<Scene>()

IServiceThrottleModule	m_ServiceThrottle

Dictionary< UUID, UserData >	m_UserCache = new Dictionary<UUID, UserData>()

bool	m_DisplayChangingHomeURI = false

Properties
bool	IsSharedModule `[get]`

virtual string	Name `[get]`

Type	ReplaceableInterface `[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 54 of file UserManagementModule.cs.

Member Function Documentation

virtual void OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.AddAdditionalUsers	(	string	query,
		List< UserData >	users
	)

inlineprotectedvirtual

Reimplemented in OpenSim.Region.CoreModules.Framework.UserManagement.HGUserManagementModule.

Definition at line 283 of file UserManagementModule.cs.

void OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.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

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 106 of file UserManagementModule.cs.

void OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.AddUser	(	UUID	uuid,
		string	firstName,
		string	lastName
	)

inline

Add a user.

The UUID is related to the name without any other checks being performed, such as user account presence.

Parameters

uuid
firstName
lastName

Implements OpenSim.Services.Interfaces.IUserManagement.

Definition at line 660 of file UserManagementModule.cs.

void OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.AddUser	(	UUID	uuid,
		string	firstName,
		string	lastName,
		string	homeURL
	)

inline

Add a user.

The arguments apart from uuid are formed into a creatorData string and processing proceeds as for the AddUser(UUID uuid, string creatorData) method.

Parameters

uuid
firstName
profileURL

Implements OpenSim.Services.Interfaces.IUserManagement.

Definition at line 677 of file UserManagementModule.cs.

void OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.AddUser	(	UUID	uuid,
		string	creatorData
	)

inline

Add a user.

If an account is found for the UUID, then the names in this will be used rather than any information extracted from creatorData.

Parameters

uuid
creatorData	The creator data for this user.

Implements OpenSim.Services.Interfaces.IUserManagement.

Definition at line 727 of file UserManagementModule.cs.

void OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.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 144 of file UserManagementModule.cs.

bool OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.GetUser	(	UUID	uuid,
		out UserData	userdata
	)

inline

Definition at line 567 of file UserManagementModule.cs.

List<UserData> OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.GetUserData	(	string	query,
		int	page_size,
		int	page_number
	)

inline

Implements OpenSim.Framework.IPeople.

Definition at line 291 of file UserManagementModule.cs.

string OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.GetUserHomeURL ( UUID userID )

inline

Implements OpenSim.Services.Interfaces.IUserManagement.

Definition at line 484 of file UserManagementModule.cs.

UUID OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.GetUserIdByName ( string name )

inline

Get user ID by the given name.

Parameters

name

Returns: UUID.Zero if no user with that name is found or if the name is "Unknown User"

Implements OpenSim.Services.Interfaces.IUserManagement.

Definition at line 445 of file UserManagementModule.cs.

UUID OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.GetUserIdByName	(	string	firstName,
		string	lastName
	)

inline

Get user ID by the given name.

Parameters

firstName
lastName

Returns: UUID.Zero if no user with that name is found or if the name is "Unknown User"

Implements OpenSim.Services.Interfaces.IUserManagement.

Definition at line 454 of file UserManagementModule.cs.

string OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.GetUserName ( UUID uuid )

inline

Implements OpenSim.Services.Interfaces.IUserManagement.

Definition at line 477 of file UserManagementModule.cs.

string OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.GetUserServerURL	(	UUID	userID,
		string	serverType
	)

inline

Implements OpenSim.Services.Interfaces.IUserManagement.

Definition at line 494 of file UserManagementModule.cs.

string OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.GetUserUUI ( UUID userID )

inline

Implements OpenSim.Services.Interfaces.IUserManagement.

Definition at line 534 of file UserManagementModule.cs.

bool OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.GetUserUUI	(	UUID	userID,
		out string	uui
	)

inline

Implements OpenSim.Services.Interfaces.IUserManagement.

Definition at line 541 of file UserManagementModule.cs.

void OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.HandleAvatarPickerRequest	(	IClientAPI	client,
		UUID	avatarID,
		UUID	RequestID,
		string	query
	)

inline

Definition at line 231 of file UserManagementModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.Init ( )

inlineprotected

Definition at line 821 of file UserManagementModule.cs.

void OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.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

source A IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 69 of file UserManagementModule.cs.

bool OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.IsLocalGridUser ( UUID uuid )

inline

Implements OpenSim.Services.Interfaces.IUserManagement.

Definition at line 810 of file UserManagementModule.cs.

void OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.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 140 of file UserManagementModule.cs.

void OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.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

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 134 of file UserManagementModule.cs.

void OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.RegisterConsoleCmds ( )

inlineprotected

Definition at line 827 of file UserManagementModule.cs.

void OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.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

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 122 of file UserManagementModule.cs.

Member Data Documentation

bool OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.m_DisplayChangingHomeURI = false

protected

Definition at line 65 of file UserManagementModule.cs.

bool OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.m_Enabled

protected

Definition at line 58 of file UserManagementModule.cs.

List<Scene> OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.m_Scenes = new List<Scene>()

protected

Definition at line 59 of file UserManagementModule.cs.

IServiceThrottleModule OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.m_ServiceThrottle

protected

Definition at line 61 of file UserManagementModule.cs.

Dictionary<UUID, UserData> OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.m_UserCache = new Dictionary<UUID, UserData>()

protected

Definition at line 63 of file UserManagementModule.cs.

Property Documentation

bool OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.IsSharedModule

get

Definition at line 92 of file UserManagementModule.cs.

virtual string OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.Name

get

Definition at line 97 of file UserManagementModule.cs.

Type OpenSim.Region.CoreModules.Framework.UserManagement.UserManagementModule.ReplaceableInterface

get

Definition at line 102 of file UserManagementModule.cs.

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

Region/CoreModules/Framework/UserManagement/UserManagementModule.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation