Simias::Storage::AccessControl Class Reference

Object that provides access control functionality for the Collection Store. More...

Collaboration diagram for Simias::Storage::AccessControl:

[legend]

List of all members.

Public Member Functions
	AccessControl (Collection collection)
	Constructor for the object.
Node[]	ChangeOwner (Member newOwner, Access.Rights oldOwnerRight)
	Makes the specified user owner of the collection that this object protects.
Member	GetCurrentMember (Store store, string domainID, bool createMember)
	Gets the Member object that represents the currently executing security context.
Member	GetMember (string userID)
	Gets the specified Member object.
void	Impersonate (Member member)
	Impersonates the specified Member object.
bool	IsAccessAllowed (Member member, Access.Rights desiredRights)
	Determines if the current user has the desired access rights.
void	Revert ()
	Reverts back to the previous impersonating identity.
Properties
Member	ImpersonationMember [get]
	Gets the Member object of the currently impersonating user.
bool	IsImpersonating [get]
	Gets whether there is a user being impersonated.

---

Detailed Description

Object that provides access control functionality for the Collection Store.

---

Constructor & Destructor Documentation

Simias::Storage::AccessControl::AccessControl

(

Collection

collection

)

[inline]

Constructor for the object.

Parameters:

collection

Collection that this object controls access for.

---

Member Function Documentation

Node [] Simias::Storage::AccessControl::ChangeOwner	(	Member	newOwner,
		Access.Rights	oldOwnerRight
	)			[inline]

Makes the specified user owner of the collection that this object protects.

Parameters:

	newOwner	Member object that is to become the new owner.
	oldOwnerRight	The rights that the old owner should be assigned.

Returns:

An array of Nodes which need to be committed to make this operation permanent.

Member Simias::Storage::AccessControl::GetCurrentMember	(	Store	store,
		string	domainID,
		bool	createMember
	)			[inline]

Gets the Member object that represents the currently executing security context.

Parameters:

	store	Store object.
	domainID	The domain used to map the current user to.
	createMember	If true, creates Member object if it does not exist.

Returns:

A Member object that represents the currently executing security context.

Member Simias::Storage::AccessControl::GetMember

(

string

userID

)

[inline]

Gets the specified Member object.

Parameters:

userID

User ID of the member to find.

Returns:

The Member object represented by the specified user guid.

void Simias::Storage::AccessControl::Impersonate

(

Member

member

)

[inline]

Impersonates the specified Member object.

Parameters:

member

Member object to impersonate.

bool Simias::Storage::AccessControl::IsAccessAllowed	(	Member	member,
		Access.Rights	desiredRights
	)			[inline]

Determines if the current user has the desired access rights.

Parameters:

	member	Member object to check access for.
	desiredRights	Desired rights.

Returns:

True if the user has the desired access rights, otherwise false.

void Simias::Storage::AccessControl::Revert

(

)

[inline]

Reverts back to the previous impersonating identity.

---

Property Documentation

Member Simias::Storage::AccessControl::ImpersonationMember [get]

Gets the Member object of the currently impersonating user.

bool Simias::Storage::AccessControl::IsImpersonating [get]

Gets whether there is a user being impersonated.

---

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

• src/core/CollectionStore/AccessControl.cs