Dec 29, 2011

ISubscriber: Getting the TFS Url for Client Operations

Responding to TFS events can be done in (at least) 2 ways: create a SOAP webservice and register with bissubscribe (this works in a “client” fashion) or implement the ISubscriber interface (in the Microsoft.TeamFoundation.Framework.Server namespace).

The advantage to the ISubscriber interface implementation is that the plugin can be installed on the TFS server and can also be used to allow or disallow a change (such as a check-in policy). One disadvantage of ISubscribers is that you only get access to a TeamFoundationRequestContext object, not a TfsTeamProjectCollection object. This can limit what operations you can perform.

I was working with an ISubscriber and wanted to update a Global List, so I needed a reference to the WorkItemStore object. Unfortunately, there was no obvious way to do this from the TeamFoundationRequestContext. I could have hard-coded a TFS url into a config file, but this felt like a cop out to me. So I dug around a little bit more and came up with a solution: the TeamFoundationLocationService (see this article about TFS services).

The TeamFoundationLocationService

You can easily get the TeamFoundationLocationService from the TeamFoundationRequestContext. You can then query the location service to get the url of the TFS server and collection. Once you have that, you can then instantiate a TfsTeamProjectCollection object and use that to get the WorkItemStore. Here’s the code:

private Uri GetTFSUri(TeamFoundationRequestContext requestContext)
{
var locationService = requestContext.GetService<TeamFoundationLocationService>();
return new Uri(locationService.ServerAccessMapping.AccessPoint + "/" + requestContext.ServiceHost.Name);
}

private WorkItemStore GetWorkItemStore(TeamFoundationRequestContext requestContext)
{
var uri = GetTFSUri(requestContext);
var tpc = TfsTeamProjectCollectionFactory.GetTeamProjectCollection(uri);
return tpc.GetService<WorkItemStore>();
}

Happy subscribing!

5 comments:

  1. I was looking for this and did not find it elsewhere. Thanks

    ReplyDelete
  2. I believe this works as well:

    var hyperlinkService = requestContext.GetService<TswaServerHyperlinkService>();
    hyperlinkService.GetHomeUrl();

    ReplyDelete
  3. Thanks a lot... this is what I was looking for from past 2 days..... :)

    ReplyDelete