AccessControlList Class

The [AccessControlList] class is meant to associate a set of [AccessControlEntries] with a security token and its inheritance settings. It is important to note that the [AccessControlList] class does not talk to a database when its methods are called.

It provides a staging area for changes to the [AccessControlEntries] for a secured token. Once changes are made to an [AccessControlList] it can be saved to the web service by passing it into a [TeamFoundationSecurityNamespace].

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.Framework.Server.AccessControlList
Microsoft.TeamFoundation.Framework.Server.AccessControlListDetails

Namespace: Microsoft.TeamFoundation.Framework.Server
Assembly: Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)

Syntax

'Declaration
Public Class AccessControlList
public class AccessControlList
public ref class AccessControlList
type AccessControlList =  class end
public class AccessControlList

The AccessControlList type exposes the following members.

Constructors

Name Description
Public method AccessControlList(String, Boolean) Creates a new [AccessControlList].
Public method AccessControlList(String, Boolean, IEnumerable<AccessControlEntry>) Builds an instance of an [AccessControlList].

Top

Properties

Name Description
Public property AccessControlEntries Returns a copy of the list of permissions for users of this token.
Public property InheritPermissions True if the given token inherits permissions from parents.
Public property Token The token that this [AccessControlList] is for.

Top

Methods

Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method QueryAccessControlEntries Returns the [AccessControlEntries] for the descriptors that are provided.
Public method QueryAccessControlEntry Returns the [AccessControlEntry] for the descriptor that's provided. If no [AccessControlEntry] exists for the provided descriptor in this [AccessControlList], an empty [AccessControlEntry] will be returned.
Public method RemoveAccessControlEntry Removes the [AccessControlEntry] from this [AccessControlList] that applies to the given descriptor.
Public method RemovePermissions Removes the specified permission bits from the existing [allows] and [denys] for this descriptor. If the descriptor is not found, nothing is performed and an empty [AccessControlEntry] is returned.
Public method SetAccessControlEntries Sets the provided [AccessControlEntry] in this [AccessControlList].
Public method SetAccessControlEntry Sets the provided [AccessControlEntry] in this [AccessControlList].
Public method SetPermissions Sets a permission for the descriptor on this [AccessControlList].
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

Name Description
Protected field m_accessControlEntries Storage of permissions keyed on the identity the permission is for.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.TeamFoundation.Framework.Server Namespace