TeamFoundationWebService Class

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

Namespace:  Microsoft.TeamFoundation.Server.Core.WebServices
Assembly:  Microsoft.TeamFoundation.Server.Core (in Microsoft.TeamFoundation.Server.Core.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
	TeamFoundationWebService	The TeamFoundationWebService base class constructor is protected forcing only derived class creation. This constructor validates that we are running within a TeamFoundationApplication and gathers some context information for the service execution.

Top

Properties

	Name	Description
	Application	Gets the application object for the current HTTP request. (Inherited from WebService.)
	Container	Gets the container for the component. (Inherited from MarshalByValueComponent.)
	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.)
	DesignMode	Gets a value indicating whether the component is currently in design mode. (Inherited from MarshalByValueComponent.)
	Events	Gets the list of event handlers that are attached to this component. (Inherited from MarshalByValueComponent.)
	RequestContext	The RequestContext associated with this web service request.
	Server	Gets the HttpServerUtility for the current request. (Inherited from WebService.)
	Session	Gets the HttpSessionState instance for the current request. (Inherited from WebService.)
	Site	Gets or sets the site of the component. (Inherited from MarshalByValueComponent.)
	SoapVersion	Gets the version of the SOAP protocol used to make the SOAP request to the XML Web service. (Inherited from WebService.)
	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
	AddWebServiceResource	Adds IDisposable resources used by Web Service methods which should be disposed at the end of the request.
	CreateCustomKeyForAspNetWebServiceMetadataCache	Creates a custom cache key for this service type. Called by ServerProtocol.
	Dispose()	Releases all resources used by the MarshalByValueComponent. (Inherited from MarshalByValueComponent.)
	Dispose(Boolean)	Releases the unmanaged resources used by the MarshalByValueComponent and optionally releases the managed resources. (Inherited from MarshalByValueComponent.)
	EnterMethod	EnterMethod is used to note the beginning of the WebMethod execution.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from MarshalByValueComponent.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetService	Gets the implementer of the IServiceProvider. (Inherited from MarshalByValueComponent.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	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.
	LeaveMethod	LeaveMethod should be called as the last piece of code within the execution of the WebMethod's scope.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	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.
	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
	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

Inheritance Hierarchy

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