TeamFoundationWebService Class

  • Article

The TeamFoundationWebService is a base class provided by the framework to help service developers integrate with the framework infrastructure.

Inheritance Hierarchy

System.Object
  System.ComponentModel.MarshalByValueComponent
    System.Web.Services.WebService
      Microsoft.TeamFoundation.Framework.Server.WebServices.TeamFoundationWebService
        More...

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

Syntax

'Declaration
Public MustInherit Class TeamFoundationWebService _
    Inherits WebService

public abstract class TeamFoundationWebService : WebService

public ref class TeamFoundationWebService abstract : public WebService

[<AbstractClass>]
type TeamFoundationWebService =  
    class 
        inherit WebService 
    end

public abstract class TeamFoundationWebService extends WebService

The TeamFoundationWebService type exposes the following members.

Constructors

  Name Description
Protected method TeamFoundationWebService The TeamFoundationWebService base class constructor is protected forcing only derived class creation. This constructor validates that we are running in a TeamFoundationApplication and gathers some context information for the service execution.

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.
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
Public methodStatic member CreateCustomKeyForAspNetWebServiceMetadataCache Create a custom cache key for this service type. Called by ServerProtocol.
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 start of the WebMethod execution.
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 a hash function for a particular type. (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 decide to over-ride this method, perform some actions based on the exception, changing the exception, eating it or just letting it pass.
Protected method LeaveMethod LeaveMethod should be called as the last block of code in the execution of the WebMethod's scope.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
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.Framework.Server.WebServices Namespace

Inheritance Hierarchy

System.Object
  System.ComponentModel.MarshalByValueComponent
    System.Web.Services.WebService
      Microsoft.TeamFoundation.Framework.Server.WebServices.TeamFoundationWebService
        Microsoft.TeamFoundation.Build.Hosted.Server.HostedBuildPoolWebService
        Microsoft.TeamFoundation.Build.Server.BuildWebServiceBase
        Microsoft.TeamFoundation.Build.Server.DeployWebServiceBase
        Microsoft.TeamFoundation.Discussion.Server.DiscussionWebService
        Microsoft.TeamFoundation.Framework.Server.WebServices.FrameworkWebService
        Microsoft.TeamFoundation.Framework.Server.WebServices.StrongBoxWebService
        Microsoft.TeamFoundation.Integration.Server.IntegrationWebService
        Microsoft.TeamFoundation.VersionControl.Server.VersionControlWebService