ITeamFoundationRequestFilter Interface
An ITeamFoundationRequestFilter is used to receive notification of requests before they are processed and after they are completed.
Namespace: Microsoft.TeamFoundation.Framework.Server
Assembly: Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)
Syntax
'Declaration
<InheritedExportAttribute> _
Public Interface ITeamFoundationRequestFilter
[InheritedExportAttribute]
public interface ITeamFoundationRequestFilter
[InheritedExportAttribute]
public interface class ITeamFoundationRequestFilter
[<InheritedExportAttribute>]
type ITeamFoundationRequestFilter = interface end
public interface ITeamFoundationRequestFilter
The ITeamFoundationRequestFilter type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
BeginRequest | BeginRequest is called after TFS has determined which site/host the request is targeting and verified that it is processing requests. A call to BeginRequest is not guaranteed for all requests. An ITeamFoundationRequestFilter can throw a RequestFilterException in BeginRequest to cause the request to be completed early and an error message to be returned to the caller. |
|
EndRequest | EndRequest is called after the request is completed. All requests with a BeginRequest will have a matching EndRequest call. Exceptions are ignored because the request is now completed. |
|
EnterMethod | EnterMethod is called after the method being executed on this request is declared. At the time EnterMethod is called the basic method information will be available. This includes, method name, type, and the list of input paramaters. This information will be available in requestContext.Method. An ITeamFoundationRequestFilter can throw a RequestFilterException in EnterMethod to cause the request to be completed early and an error message to be returned to the caller. |
|
LeaveMethod | LeaveMethod is called when the method is completed. Once EnterMethod is called LeaveMethod should always be called also. Exceptions are ignored because the request is now completed. |
|
RequestReady | RequestReady is called after the request has completed authentication and is about to begin execution. At this point the requestContext.UserContext property will contain the authenticated user information. An ITeamFoundationRequestFilter can throw a RequestFilterException in RequestReady to cause the request to be completed early and an error message to be returned to the caller. |
Top