TeamFoundationLocationService Class

Article
07/02/2014

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.Framework.Server.TeamFoundationLocationService

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

Syntax

'Declaration
<TeamFoundationServiceDependency(GetType(TeamFoundationSqlNotificationService))> _
<TeamFoundationServiceDependency(GetType(TeamFoundationRegistryService))> _
Public NotInheritable Class TeamFoundationLocationService _
    Implements ITeamFoundationLocationService, ITeamFoundationService

[TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))]
public sealed class TeamFoundationLocationService : ITeamFoundationLocationService, 
    ITeamFoundationService

[TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))]
public ref class TeamFoundationLocationService sealed : ITeamFoundationLocationService, 
    ITeamFoundationService

[<Sealed>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))>]
type TeamFoundationLocationService =  
    class 
        interface ITeamFoundationLocationService 
        interface ITeamFoundationService 
    end

public final class TeamFoundationLocationService implements ITeamFoundationLocationService, ITeamFoundationService

The TeamFoundationLocationService type exposes the following members.

Properties

	Name	Description
	CurrentServiceOwner	The unique identifier of the current service

Top

Methods

	Name	Description
	ConfigureAccessMapping
	DetermineAccessMapping(TeamFoundationRequestContext)	Determines what access mapping this request came from. This is accomplished by comparing the scheme host and port of the incoming request with the location service entries.
	DetermineAccessMapping(TeamFoundationRequestContext, String)	Determines what access mapping this location comes from. This is accomplished by comparing the scheme host and port of the incoming request with the location service entries.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	FindServiceDefinition(TeamFoundationRequestContext, String, String)	Finds the service definition with the provided service type and tool id. In order for this call to succeed, only one service that has the provided service type and tool id can exist.
	FindServiceDefinition(TeamFoundationRequestContext, String, Guid, Guid)
	FindServiceDefinitions
	FindServiceDefinitionsByToolId	Finds the service definitions for all of the available services for the specified tool ID. If no services exist for this tool ID, an empty enumeration will be returned.
	FindServiceLocation
	GetAccessMapping
	GetAccessMappings
	GetDefaultAccessMapping
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetHostLocation
	GetLastChangeId	Returns the ID for the last change that was performed on the location data.
	GetPublicAccessMapping	This method may not actually return the access mapping with Moniker=PublicAccessMapping. If no suc mapping exists we wll return the DefaultAccessMapping instead. If you need to find the actual access mapping with Moniker=PublicAccessMapping (which may or may not exist) you should call GetAccessMapping overload which takes in moniker parameter and be prepared for the possibility that it may return null.
	GetRegisteredServiceDomains
	GetRootDomainUri(TeamFoundationRequestContext)
	GetRootDomainUri(TeamFoundationRequestContext, AccessMapping)
	GetSelfReferenceUri
	GetServerAccessMapping	This method may not actually return the access mapping with Moniker=ServerAccessMapping. If no such mapping exists we will return the PublicAccessMapping instead (which may also not exist in which case we'll return the DefaultAccessMapping). If you need to find the actual access mapping with Moniker=ServerAccessMapping (which may or may not exist) you should call GetAccessMapping overload which takes in moniker parameter and be prepared for the possibility that it may return null.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	LocationForAccessMapping(TeamFoundationRequestContext, ServiceDefinition, AccessMapping)
	LocationForAccessMapping(TeamFoundationRequestContext, String, RelativeToSetting, AccessMapping)
	LocationForAccessMapping(TeamFoundationRequestContext, String, Guid, AccessMapping, Guid)
	MapToRootDomain	Given a uri, this method will see if the host matches an alternate domain. If so a new uri will be created that uses the root domain as the host.
	RegisterLocationServiceWithSps
	RemoveAccessMapping
	RemoveServiceDefinitions
	SaveServiceDefinitions	Registers services with the location service. Any access mappings referenced in a ServiceDefinition or one of its LocationMappings must already be registered with the LocationService. Location Mappings for the provided service definitions that are not fully qualified will be generated and updated on the service definitions passed in. Any service that is relative that passes no location mappings passed in will have location mappings generated for all of the existing access mappings. If only certain access mappings are desired, they must be passed in.
	SetDefaultAccessMapping
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	ValidateServiceDefinition	Checks to make sure all parameters of the service definitions are valid and checks to see if there is an invalid modification with the isUpdate parameter.