TeamFoundationLocationService Class

Article
11/19/2013

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 ITeamFoundationService

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

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

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

public final class TeamFoundationLocationService implements ITeamFoundationService

The TeamFoundationLocationService type exposes the following members.

Methods

	Name	Description
	ConfigureAccessMapping	Adds a new access mapping to this location service as long as an access zone with the specified moniker does not currently exist. If a moniker already exists, an error will be thrown. This function optionally generates location mappings for all registered services that are relative to a given tier.
	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, Guid)	Returns the service definition for the service that has the provided service type and identifier. Null will be returned if there is no entry in the cache for this service.
	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.
	FindServiceDefinitions	Finds the service definitions for all of the available services for the specified service type. If no services of this type exist, an empty enumeration will be returned.
	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	Finds the location of the service that has the provided service type and tool ID for the provided access mapping. In order for this call to succeed, only one service that has the provided service type and tool ID can exist.
	GetAccessMapping	Returns the access mapping for the provided moniker. If the access mapping is not found, null is returned.
	GetAccessMappings	Gets all of the access mappings in the current context.
	GetDefaultAccessMapping	Returns the default access mapping for the location service.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetHostLocation	GetHostLocation will return a URL to the root of the host for the given access mapping.
	GetLastChangeId	Returns the ID for the last change that was performed on the location data.
	GetPublicAccessMapping	The access mapping of the location service for of client (public) access when a specific access mapping is not known. This differs slightly from DefaultAccessMapping. The default access mapping can be used when you are not sure where the access will be made.
	GetRootDomainUri
	GetSelfReferenceUri	Gets the Uri for this location service for this host. It will attempt to retrieve the location given the access mapping provided. If the location service could not be resolved using the access mapping it will then return the first access mapping. If there are no access mappings available for the location service it will throw AccessMappingNotRegisteredException.
	GetServerAccessMapping	The access mapping that should be used when the server needs a URL to access itself. This means the code that uses these URLs will be running on the server not from a client/public location.
	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)
	RemoveAccessMapping	Removes an access mapping and all of the locations that are mapped to it within service definitions.
	RemoveServiceDefinitions	Removes information about the specified services from the location service.
	SaveServiceDefinitions	Registers services by using 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	Sets the default access mapping to the mapping passed in.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	ValidateServiceDefinition