SecurityWebService Class

The web service that is used for providing security information.

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

[WebServiceAttribute(Namespace = "http://microsoft.com/webservices/")]
[ClientServiceAttribute(ComponentName = "Framework", RegistrationName = "Framework", 
	ServerConfiguration = ServerConfiguration.TfsConnection, ServiceName = "SecurityService", 
	CollectionServiceIdentifier = "af3178da-1ec3-4bd0-b245-9f5decdc572e", 
	ConfigurationServiceIdentifier = "AFF1A844-BA7D-4340-8A95-2952524EC778")]
public class SecurityWebService : FrameworkWebService

The SecurityWebService type exposes the following members.

  NameDescription
Public methodSecurityWebServiceBuilds the web service and our base class.
Top

  NameDescription
Public propertyApplicationGets the application object for the current HTTP request. (Inherited from WebService.)
Public propertyContainerGets the container for the component. (Inherited from MarshalByValueComponent.)
Public propertyContextGets the ASP.NET HttpContext for the current request, which encapsulates all HTTP-specific context used by the HTTP server to process Web requests. (Inherited from WebService.)
Public propertyDesignModeGets a value indicating whether the component is currently in design mode. (Inherited from MarshalByValueComponent.)
Protected propertyEventsGets the list of event handlers that are attached to this component. (Inherited from MarshalByValueComponent.)
Protected propertyRequestContextThe RequestContext associated with this Web service request. (Inherited from TeamFoundationWebService.)
Public propertyServerGets the HttpServerUtility for the current request. (Inherited from WebService.)
Public propertySessionGets the HttpSessionState instance for the current request. (Inherited from WebService.)
Public propertySiteGets or sets the site of the component. (Inherited from MarshalByValueComponent.)
Public propertySoapVersionGets the version of the SOAP protocol used to make the SOAP request to the XML Web service. (Inherited from WebService.)
Public propertyUserGets the ASP.NET server User object. Can be used to authenticate whether a user is authorized to execute the request. (Inherited from WebService.)
Top

  NameDescription
Protected methodAddWebServiceResourceAdds IDisposable resources used by Web Service methods which should be disposed at the end of the request (Inherited from TeamFoundationWebService.)
Public methodCreateSecurityNamespaceThis function creates a security namespace based on the description provided. Note that as soon as a security namespace is created, it will persist until it is explicitly deleted.
Public methodDeleteSecurityNamespaceThis function deletes a security namespace and all of its permissions.
Public methodDispose()Releases all resources used by the MarshalByValueComponent. (Inherited from MarshalByValueComponent.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the MarshalByValueComponent and optionally releases the managed resources. (Inherited from MarshalByValueComponent.)
Protected methodEnterMethodEnterMethod is used to note the start of the WebMethod execution. (Inherited from TeamFoundationWebService.)
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from MarshalByValueComponent.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetServiceGets the implementer of the IServiceProvider. (Inherited from MarshalByValueComponent.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodHandleExceptionThis basic WebService ExceptionHandler captures the exception and records it in the request Context for future logging. Services may decide to over-ride this method, perform some actions based on the exception, changing the exception, eating it or just letting it pass. (Inherited from TeamFoundationWebService.)
Public methodHasPermissionByDescriptorListReturn the list of has permission evaluations for the supplied arguments.
Public methodHasPermissionByPermissionsListReturn the list of has permission evaluations for the supplied arguments.
Public methodHasPermissionByTokenListReturn the list of has permission evaluations for the supplied arguments.
Public methodHasWritePermissionReturn the list of has permission evaluations for the supplied arguments.
Protected methodLeaveMethodLeaveMethod should be called as the last block of code in the execution of the WebMethod's scope. (Inherited from TeamFoundationWebService.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodQueryPermissionsIn all cases: this method will query the permissions for the token specified (and those underneath it if recursion is specified and this is a hierarchical namespace). It will return permission information about the identities that are supplied or all identities if null is supplied for the identities parameter. IAccessControlLists objects will be returned only for tokens that we have information about. Note that the order the access control entries are returned in, in an access control list, is non-deterministic. If includeExtendedInfo is false: All of the ExtendedInfo properties for the returned AccessControlEntry objects will be null. If includeExtendedInfo is true: All of the ExtendedInfo properties for the returned AccessControlEntry objects will contain references to valid ExtendedPermissionInformation objects. If the identities parameter is null, this function will return permission information for all identities that have explicit OR INHERITED permissions on them.
Public methodQuerySecurityNamespacesReturns information about the security namespace that corresponds to the namespaceId being queried. Note that if namespaceId is equal to Guid.Empty, descriptions for all of the security namespaces will be returned.
Public methodRemoveAccessControlEntriesRemoves the access control entries from the system for the specified token as long as they exist.
Public methodRemoveAccessControlListRemoves an access control list from the system if it is present. If the access control list data contains entries, only those entries will be removed; otherwise, the whole access control list will be removed (this includes all its related access control entries). If recurse is true, all children access control lists will also be deleted. In addition, if recurse is true, it will be assumed that we are deleting complete access control lists, not just entries in the list.
Public methodRemovePermissionsRemoves the specified permission bits from the existing allows and denies for this identity. If the identity is not found, nothing is performed and null is returned.
Public methodSetAccessControlListPlaces the access control lists specified into the security namespace. Setting an access control list will always overwrite an existing access control list and its permissions if there is one. If inheritanceChange is true, only the inheritance values will be set for the access control lists.
Public methodSetInheritFlagSets the inheritance flag on the access control list for the token.
Public methodSetPermissionsSets a permission for the identity in the system. If merge is specified and a preexisting entry is found the two permissions will be merged. When merging permissions, the new permissions will take precedence over the old permissions if there are conflicts in bits. Removing in this context refers to the removal of bits on permissions not the permissions themselves. When removing any bits set in allow or deny will be removed.
Public methodToStringReturns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from MarshalByValueComponent.)
Top

  NameDescription
Public eventDisposedAdds an event handler to listen to the Disposed event on the component. (Inherited from MarshalByValueComponent.)
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft