SecurityWebService Class

  • Article

The web service used for providing security information.

Inheritance Hierarchy

System.Object
  System.ComponentModel.MarshalByValueComponent
    System.Web.Services.WebService
      Microsoft.TeamFoundation.Server.Core.WebServices.TeamFoundationWebService
        Microsoft.TeamFoundation.Server.Core.WebServices.FrameworkWebService
          Microsoft.TeamFoundation.Server.Core.WebServices.SecurityWebService

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

Syntax

'Declaration
<WebServiceAttribute(Namespace := "https://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 _
    Inherits FrameworkWebService

[WebServiceAttribute(Namespace = "https://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

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

[<WebServiceAttribute(Namespace = "https://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")>]
type SecurityWebService =  
    class 
        inherit FrameworkWebService 
    end

public class SecurityWebService extends FrameworkWebService

The SecurityWebService type exposes the following members.

Constructors

  Name Description
Public method SecurityWebService Builds the web service and our base class.

Top

Properties

  Name Description
Public property Application Gets the application object for the current HTTP request. (Inherited from WebService.)
Public property Container Gets the container for the component. (Inherited from MarshalByValueComponent.)
Public property Context Gets 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 property DesignMode Gets a value indicating whether the component is currently in design mode. (Inherited from MarshalByValueComponent.)
Protected property Events Gets the list of event handlers that are attached to this component. (Inherited from MarshalByValueComponent.)
Protected property RequestContext The RequestContext associated with this web service request. (Inherited from TeamFoundationWebService.)
Public property Server Gets the HttpServerUtility for the current request. (Inherited from WebService.)
Public property Session Gets the HttpSessionState instance for the current request. (Inherited from WebService.)
Public property Site Gets or sets the site of the component. (Inherited from MarshalByValueComponent.)
Public property SoapVersion Gets the version of the SOAP protocol used to make the SOAP request to the XML Web service. (Inherited from WebService.)
Public property User Gets the ASP.NET server User object. Can be used to authenticate whether a user is authorized to execute the request. (Inherited from WebService.)

Top

Methods

  Name Description
Protected method AddWebServiceResource Adds IDisposable resources used by Web Service methods which should be disposed at the end of the request. (Inherited from TeamFoundationWebService.)
Public method CreateSecurityNamespace This function creates a security namespace based on the description provided. Note that once a security namespace is created, it will persist until it is explicitly deleted.
Public method DeleteSecurityNamespace This function deletes a security namespace and all of its permissions.
Public method Dispose() Releases all resources used by the MarshalByValueComponent. (Inherited from MarshalByValueComponent.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the MarshalByValueComponent and optionally releases the managed resources. (Inherited from MarshalByValueComponent.)
Protected method EnterMethod EnterMethod is used to note the beginning of the WebMethod execution. (Inherited from TeamFoundationWebService.)
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 MarshalByValueComponent.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetService Gets the implementer of the IServiceProvider. (Inherited from MarshalByValueComponent.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method HandleException This basic WebService ExceptionHandler captures the exception and records it in the request Context for future logging. Services may choose 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 method HasPermissionByDescriptorList Return the list of has permission evaluations for the supplied arguments.
Public method HasPermissionByPermissionsList Return the list of has permission evaluations for the supplied arguments.
Public method HasPermissionByTokenList Return the list of has permission evaluations for the supplied arguments.
Public method HasWritePermission Return the list of has permission evaluations for the supplied arguments.
Protected method LeaveMethod LeaveMethod should be called as the last piece of code within the execution of the WebMethod's scope. (Inherited from TeamFoundationWebService.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method QueryPermissions In all cases: This method will query the permissions for the token specified (and those beneath it if recursion is specified and this is a hierarchical namespace). It will return permission information on the identities that are supplied or all identities if null is supplied for the identities parameter. IAccessControlLists objects will only be returned for tokens that we have information on. Note that the order the access control entries are returned in within 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 method QuerySecurityNamespaces Returns 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 method RemoveAccessControlEntries Removes the access control entries from the system for the specified token as long as they exist.
Public method RemoveAccessControlList Removes 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, if it doesn't, the whole access control list will be removed (this includes all of its related access control entries). If recurse is true, all children access control lists will be deleted as well. Also, if recurse is true, it will be assumed that we are deleting entire access control lists, not just entries within the list.
Public method RemovePermissions Removes the specified permission bits from the existing allows and denys for this identity. If the identity is not found, nothing is done and null is returned.
Public method SetAccessControlList Places 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 method SetInheritFlag Sets the inheritance flag on the access control list for the token.
Protected method SetMethodName Sets the method name (does NOT call EnterMethod) This is meant to be called with the same instance of methodInformation, but without the parameters so that the method is correctly logged in the activity log rather than just its URL. (Inherited from TeamFoundationWebService.)
Public method SetPermissions Sets 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 themself. When removing any bits set in allow or deny will be removed.
Public method ToString Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from MarshalByValueComponent.)

Top

Events

  Name Description
Public event Disposed Adds an event handler to listen to the Disposed event on the component. (Inherited from MarshalByValueComponent.)

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.Server.Core.WebServices Namespace