This documentation is archived and is not being maintained.

TeamFoundationHttpHandler Class

Visual Studio 2013

The TeamFoundationHttpHandler is designed to be a base class for service developers to build custom handlers and provides an integration point between the services code and the Team Foundation framework.

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

'Declaration
Public MustInherit Class TeamFoundationHttpHandler _
	Implements IHttpHandler

The TeamFoundationHttpHandler type exposes the following members.

  NameDescription
Protected methodTeamFoundationHttpHandlerThe TeamFoundationHttpHandler 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.
Protected methodTeamFoundationHttpHandler(HttpContextBase)Explicit parameter constructor to allow for testability.
Top

  NameDescription
Protected propertyHandlerHttpContextThe HttpContextBase associated with this web service request.
Public propertyIsReusableTeamFoundationHttpHandler's are not re-usable. (We want the the constructor above to get called on every request so that members like m_requestContext will be setup for the current request, not the first request we handled.)
Protected propertyRequestContextThe RequestContext associated with this web service request.
Top

  NameDescription
Protected methodEnterMethodEnterMethod is used to note the beginning of the Handler to define information about the handler being executed.
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 Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
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 choose to over-ride this method, perform some actions based on the exception, changing the exception, eating it or just letting it pass.
Protected methodLeaveMethodLeaveMethod should be called as the last piece of code within the execution of the WebMethod's scope.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodProcessRequestThe derived class must implement the ProcessRequest method.
Protected methodSetMethodNameSets 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.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
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.
Show: